stream

Documentation

Index

• type Packet
• type Receiver
  • func (receiver *Receiver) Recv() (*Packet, error)
• type Sender
  • func (sender *Sender) Send(p *Packet) error
• type Type

Types

type Packet

type Packet struct {
	Type    Type
	Padding uint16
	Payload []byte // L3 or JSON
}

Packet requires uint32be length to be prepended. The upper 8 bits of the length must be Magic

type Receiver

type Receiver struct {
	io.Reader
	sync.Mutex
}

Receiver

func (*Receiver) Recv

func (receiver *Receiver) Recv() (*Packet, error)

type Sender

type Sender struct {
	io.Writer
	sync.Mutex
}

Sender

func (*Sender) Send

func (sender *Sender) Send(p *Packet) error

type Type

type Type = uint16

const (
	Magic            = uint8(0x42)
	TypeInvalid Type = 0x0
	TypeL3      Type = 0x1
	TypeJSON    Type = 0x2
)