wire

Documentation

Index

• Constants
• func Encode(f Frame) []byte
• type Disconnect
• type Envelope
• type Frame
  • func Decode(data []byte) (Frame, error)
• type WireError

Constants

const (
	CodeUnsupportedVersion = "UNSUPPORTED_VERSION"
	CodeDecodeError        = "DECODE_ERROR"
	CodeNoHandler          = "NO_HANDLER"
	CodeFrameTooLarge      = "FRAME_TOO_LARGE"
)

Error codes in TypeError frames.

const (
	ReasonShutdown = "SHUTDOWN"
	ReasonPeerLost = "PEER_LOST"
)

Reason codes in TypeDisconnect frames.

const (
	TypeIdent       byte = 0x01 // trusted-mode only: initiator declares its NodeID
	TypeDisconnect  byte = 0x03 // payload is Disconnect
	TypeError       byte = 0x04 // payload is WireError
	TypeApplication byte = 0x10 // payload is Envelope
)

Functions

func Encode

func Encode(f Frame) []byte

Encode returns [1-byte type][payload]. Length-prefix framing is the transport's responsibility.

Types

type Disconnect

type Disconnect struct {
	ReasonCode    string
	ReasonMessage string
}

Disconnect is the TypeDisconnect payload.

type Envelope

type Envelope struct {
	Protocol string
	Type     string
	Payload  []byte
}

Envelope multiplexes application messages over a single connection.

type Frame

type Frame struct {
	Type    byte
	Payload []byte
}

Frame is a decoded wire frame.

func Decode

func Decode(data []byte) (Frame, error)

type WireError

type WireError struct {
	ErrorCode    string
	ErrorMessage string
}

WireError is the TypeError payload.