codec

package

v0.0.0-...-cb81ebf Latest Latest Go to latest Published: Jul 25, 2023 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var DefaultCodec = NewCodec()

View Source

var DefaultMarshal = NewMarshal()

View Source

var NewCodec = func() Codec {
	return &defaultCodec{}
}

View Source

var NewMarshal = func() Marshaller {
	return &defaultMarshal{}
}

func RegisterCodec(name string, codec Codec)

func RegisterMarshaller(name string, marshaller Marshaller)

type Codec interface {
	Encode([]byte, MsgType) ([]byte, error)
	Decode([]byte) (*Frame, error)
}

func GetCodec(name string) Codec

type Frame struct {
	Header *FrameHeader // header of Frame
	Data   []byte       // serialized data
}

type FrameHeader struct {
	MsgTypeStart uint8  // start of frame
	Length       uint32 // total packet length
	MsgTypeEnd   uint8  // end of frame
}

type Marshaller interface {
	Marshal(m protoreflect.ProtoMessage) ([]byte, error)
	Unmarshal(b []byte, m protoreflect.ProtoMessage) error
}

func GetMarshaller(name string) Marshaller

type MsgType int32

const (
	RPC          MsgType = 1
	Broadcast    MsgType = 2
	FrameHeadLen         = 6
)