codec

Documentation

Index

• type Codec
• type GoGoProtobufCodec
  • func NewGoGoProtobufCodec() *GoGoProtobufCodec
  • func (c *GoGoProtobufCodec) Destroy() error
  • func (c *GoGoProtobufCodec) Initial() error
  • func (c *GoGoProtobufCodec) Marshal(msg interface{}) ([]byte, error)
  • func (c *GoGoProtobufCodec) RegisterMessage(msg interface{}) error
  • func (c *GoGoProtobufCodec) Unmarshal(data []byte) (interface{}, error)

Types

type Codec

type Codec interface {
	// Initiate a codec.
	Initial() error

	// Register a message type.
	RegisterMessage(msg interface{}) error

	// Marshal a message into bytes.
	Marshal(msg interface{}) ([]byte, error)

	// Unmarshal a message from bytes.
	Unmarshal(data []byte) (interface{}, error)

	// Destroy a codec, release the resource.
	Destroy() error
}

Codec defines the interface that a codec should implement. A codec should be able to marshal/unmarshal messages from the given bytes.

type GoGoProtobufCodec

type GoGoProtobufCodec struct {
	// contains filtered or unexported fields
}

GoGoProtobufCodec implements the codec interface for Codec. We use reflect to make it a 'self-explained' codec.

func NewGoGoProtobufCodec

func NewGoGoProtobufCodec() *GoGoProtobufCodec

NewGoGoProtobufCodec creates a new gogpprotobuf codec.

func (*GoGoProtobufCodec) Destroy

func (c *GoGoProtobufCodec) Destroy() error

Destroy the gogoprotobuf codec (no-op for now).

func (*GoGoProtobufCodec) Initial

func (c *GoGoProtobufCodec) Initial() error

Initial the gogoprotobuf codec (no-op for now).

func (*GoGoProtobufCodec) Marshal

func (c *GoGoProtobufCodec) Marshal(msg interface{}) ([]byte, error)

Marshal a message into a byte slice. The msg must be a pointer type.

func (*GoGoProtobufCodec) RegisterMessage

func (c *GoGoProtobufCodec) RegisterMessage(msg interface{}) error

RegisterMessage regists a message type.

func (*GoGoProtobufCodec) Unmarshal

func (c *GoGoProtobufCodec) Unmarshal(data []byte) (interface{}, error)

Unmarshal a message from a byte slice.