codec

Documentation

Index

• Variables
• func NewLengthFieldBasedFromDecoder(conn net.Conn, offset int) net.Conn
• func NewWebsocketClientDecoder(conn net.Conn) *websocketDecoder
• func NewWebsocketDecoder(conn net.Conn) net.Conn
• type Codec
• type JsonCodec
  • func NewJsonCodec() *JsonCodec
  • func (codec *JsonCodec) Marshal(data any) ([]byte, error)
  • func (codec *JsonCodec) Unmarshal(p []byte, data any) error
• type LengthFieldBasedFrameDecoder
  • func (decoder *LengthFieldBasedFrameDecoder) Read(bytes []byte) (n int, err error)
  • func (c *LengthFieldBasedFrameDecoder) SyscallConn() (syscall.RawConn, error)
  • func (decoder *LengthFieldBasedFrameDecoder) Write(buf []byte) (n int, err error)
• type Options
  • func DefaultOptions() *Options
• type Packet
  • func NewPacket(codec Codec) *Packet
  • func (p *Packet) Encode(data any) (msg []byte, err error)
  • func (p *Packet) EncodeWith(action, seq int16, data any) ([]byte, error)
  • func (p *Packet) Marshal(data any) (err error)
  • func (p *Packet) Pack() ([]byte, error)
  • func (p *Packet) Unmarshal(data any) (err error)
  • func (p *Packet) Unpack(msg []byte) error
• type ProtoCodec
  • func NewProtoCodec() *ProtoCodec
  • func (codec *ProtoCodec) Marshal(data any) ([]byte, error)
  • func (codec *ProtoCodec) Unmarshal(p []byte, data any) error

Variables

var (
	ErrInvalidProtoMessage = errors.New("invalid proto message")
)

Functions

func NewLengthFieldBasedFromDecoder

func NewLengthFieldBasedFromDecoder(conn net.Conn, offset int) net.Conn

func NewWebsocketClientDecoder

func NewWebsocketClientDecoder(conn net.Conn) *websocketDecoder

func NewWebsocketDecoder

func NewWebsocketDecoder(conn net.Conn) net.Conn

Types

type Codec

type Codec interface {
	Marshal(data any) ([]byte, error)
	Unmarshal(p []byte, data any) error
}

type JsonCodec

type JsonCodec struct {
}

func NewJsonCodec

func NewJsonCodec() *JsonCodec

func (*JsonCodec) Marshal

func (codec *JsonCodec) Marshal(data any) ([]byte, error)

func (*JsonCodec) Unmarshal

func (codec *JsonCodec) Unmarshal(p []byte, data any) error

type LengthFieldBasedFrameDecoder

type LengthFieldBasedFrameDecoder struct {
	net.Conn
	// contains filtered or unexported fields
}

func (*LengthFieldBasedFrameDecoder) Read

func (decoder *LengthFieldBasedFrameDecoder) Read(bytes []byte) (n int, err error)

func (*LengthFieldBasedFrameDecoder) SyscallConn

func (c *LengthFieldBasedFrameDecoder) SyscallConn() (syscall.RawConn, error)

SyscallConn prepare for epoll

func (*LengthFieldBasedFrameDecoder) Write

func (decoder *LengthFieldBasedFrameDecoder) Write(buf []byte) (n int, err error)

type Options

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

Options represents options options

func DefaultOptions

func DefaultOptions() *Options

Default returns the default options implementation,the packet is composed by : |-------------- header --------------|-------- body --------| |packetLength| action | seq |-------- body --------| | 4 | 2 | 2 | n |

type Packet

type Packet struct {
	Action int16
	Seq    int16
	Body   []byte
	// contains filtered or unexported fields
}

func NewPacket

func NewPacket(codec Codec) *Packet

func (*Packet) Encode

func (p *Packet) Encode(data any) (msg []byte, err error)

func (*Packet) EncodeWith

func (p *Packet) EncodeWith(action, seq int16, data any) ([]byte, error)

func (*Packet) Marshal

func (p *Packet) Marshal(data any) (err error)

func (*Packet) Pack

func (p *Packet) Pack() ([]byte, error)

func (*Packet) Unmarshal

func (p *Packet) Unmarshal(data any) (err error)

func (*Packet) Unpack

func (p *Packet) Unpack(msg []byte) error

type ProtoCodec

type ProtoCodec struct {
}

func NewProtoCodec

func NewProtoCodec() *ProtoCodec

func (*ProtoCodec) Marshal

func (codec *ProtoCodec) Marshal(data any) ([]byte, error)

func (*ProtoCodec) Unmarshal

func (codec *ProtoCodec) Unmarshal(p []byte, data any) error