protocol

package

v0.0.0-...-3928268 Latest Latest Go to latest Published: Jul 19, 2023 License: MIT Imports: 7 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.

This section is empty.

This section is empty.

type Action uint8

const (
	ActResponse Action = iota
	ActHandshake
	ActLabel
	ActMulticast
)

type Frame struct {
	Act     Action
	Label   string
	Payload []byte
}

func NewFrame() *Frame

func (f *Frame) Recycle()

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

func NewFrameDecoder(r io.Reader) *FrameDecoder

func (d *FrameDecoder) Decode(frame *Frame) (raw []byte, err error)

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

func NewFrameEncoder(w io.Writer) *FrameEncoder

func (e *FrameEncoder) Close() (err error)

func (e *FrameEncoder) Encode(frame *Frame) (err error)

type FrameProcessor struct {
	*FrameEncoder
	*FrameDecoder
}

func NewFrameProcessor(rw io.ReadWriter) *FrameProcessor

func (p *FrameProcessor) SetDecodeTimeout(t time.Duration) error

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

func NewPacker(readFrame func() *Frame) *Packer

func (p *Packer) Assemble() (label string, data [][]byte)

func (p *Packer) Pack(label string, data any) <-chan *Frame