codec

Documentation

Overview

Package codec is an interface for encoding messages

Index

• Variables
• type Codec
• type Marshaler
• type Reader
• type Writer

Variables

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

Types

type Codec

type Codec interface {
	Reader
	Writer
	Close() error
	String() string
}

Codec encodes/decodes various types of messages used within axon 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 Marshaler

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

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

type Reader

type Reader interface {
	Read(interface{}) error
}

type Writer

type Writer interface {
	Write(interface{}) error
}