codec

Documentation

Index

• Constants
• Variables
• type Codec
  • func NewGobCodec(conn io.ReadWriteCloser) Codec
  • func NewJsonCodec(conn io.ReadWriteCloser) Codec
• type GobCodec
  • func (g *GobCodec) Close() error
  • func (g *GobCodec) ReadBody(body any) error
  • func (g *GobCodec) ReadHeader(header *Header) error
  • func (g *GobCodec) Write(header *Header, body any) (err error)
• type Header
• type JsonCodec
  • func (j *JsonCodec) Close() error
  • func (j *JsonCodec) ReadBody(body any) error
  • func (j *JsonCodec) ReadHeader(header *Header) error
  • func (j *JsonCodec) Write(header *Header, body any) (err error)
• type NewCodecFunc
• type Option
• type Type

Constants

const MagicNumber = 0x3bef5c

Variables

var NewCodecFuncMap map[Type]NewCodecFunc

Types

type Codec

type Codec interface {
	io.Closer
	ReadHeader(*Header) error
	ReadBody(any) error
	Write(*Header, any) error
}

func NewGobCodec

func NewGobCodec(conn io.ReadWriteCloser) Codec

func NewJsonCodec

func NewJsonCodec(conn io.ReadWriteCloser) Codec

type GobCodec

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

func (*GobCodec) Close

func (g *GobCodec) Close() error

func (*GobCodec) ReadBody

func (g *GobCodec) ReadBody(body any) error

func (*GobCodec) ReadHeader

func (g *GobCodec) ReadHeader(header *Header) error

func (*GobCodec) Write

func (g *GobCodec) Write(header *Header, body any) (err error)

type Header

type Header struct {
	ServiceMethod string //format "Service.Method"
	Seq           uint64 //req id
	Error         string
}

type JsonCodec

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

func (*JsonCodec) Close

func (j *JsonCodec) Close() error

func (*JsonCodec) ReadBody

func (j *JsonCodec) ReadBody(body any) error

func (*JsonCodec) ReadHeader

func (j *JsonCodec) ReadHeader(header *Header) error

func (*JsonCodec) Write

func (j *JsonCodec) Write(header *Header, body any) (err error)

type NewCodecFunc

type NewCodecFunc func(closer io.ReadWriteCloser) Codec

type Option

type Option struct {
	MagicNumber int  // MagicNumber marks this's a geerpc request
	CodecType   Type // client may choose different Codec to encode body
}

type Type

type Type string

const (
	GobType  Type = "application/gob"
	JsonType Type = "application/json"
)