Package codec

import "github.com/gonitro/nitro/app/codec"

Overview ▾

Package codec is an interface for encoding messages


var (
    ErrInvalidMessage = errors.New("invalid message")

type Codec

Codec encodes/decodes various types of messages used within go-micro. ReadHeader and ReadBody are called in pairs to read requests/responses from the connection. Close is called when finished with the connection. ReadBody may be called with a nil argument to force the body to be read and discarded.

type Codec interface {
    Close() error
    String() string

type Marshaler

Marshaler is a simple encoding interface used for the event/network where headers are not supported by the underlying implementation.

type Marshaler interface {
    Marshal(interface{}) ([]byte, error)
    Unmarshal([]byte, interface{}) error
    String() string

type Message

Message represents detailed information about the communication, likely followed by the body. In the case of an error, body may be nil.

type Message struct {
    Id       string
    Type     MessageType
    Target   string
    Method   string
    Endpoint string
    Error    string

    // The values read from the socket
    Header map[string]string
    Body   []byte

type MessageType

type MessageType int
const (
    Error MessageType = iota

type NewCodec

Takes in a connection/buffer and returns a new Codec

type NewCodec func(io.ReadWriteCloser) Codec

type Reader

type Reader interface {
    ReadHeader(*Message, MessageType) error
    ReadBody(interface{}) error

type Writer

type Writer interface {
    Write(*Message, interface{}) error


Name Synopsis
bytes Package bytes provides a bytes codec which does not encode or decode anything
json Package json provides a json codec
jsonrpc Package jsonrpc provides a json-rpc 1.0 codec