protocol

Documentation

Index

• Constants
• type Message
• type MessageBase
  • func (m *MessageBase) Cbor() []byte
  • func (m *MessageBase) SetCbor(data []byte)
  • func (m *MessageBase) Type() uint8
• type MessageFromCborFunc
• type MessageHandlerFunc
• type Protocol
  • func New(config ProtocolConfig) *Protocol
  • func (p *Protocol) Mode() ProtocolMode
  • func (p *Protocol) Role() ProtocolRole
  • func (p *Protocol) SendError(err error)
  • func (p *Protocol) SendMessage(msg Message) error
  • func (p *Protocol) Start()
• type ProtocolConfig
• type ProtocolMode
• type ProtocolOptions
• type ProtocolRole
• type State
  • func NewState(id uint, name string) State
  • func (s State) String() string
• type StateMap
• type StateMapEntry
• type StateTransition
• type StateTransitionMatchFunc

Constants

const (
	AGENCY_NONE   uint = 0
	AGENCY_CLIENT uint = 1
	AGENCY_SERVER uint = 2
)

const (
	// This is completely arbitrary, but the line had to be drawn somewhere
	MAX_MESSAGES_PER_SEGMENT = 20
)

Types

type Message

type Message interface {
	SetCbor([]byte)
	Cbor() []byte
	Type() uint8
}

Provide a common interface for message utility functions

type MessageBase

type MessageBase struct {
	MessageType uint8
	// contains filtered or unexported fields
}

func (*MessageBase) Cbor

func (m *MessageBase) Cbor() []byte

func (*MessageBase) SetCbor

func (m *MessageBase) SetCbor(data []byte)

func (*MessageBase) Type

func (m *MessageBase) Type() uint8

type MessageFromCborFunc

type MessageFromCborFunc func(uint, []byte) (Message, error)

type MessageHandlerFunc

type MessageHandlerFunc func(Message, bool) error

type Protocol

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

func New

func New(config ProtocolConfig) *Protocol

func (*Protocol) Mode

func (p *Protocol) Mode() ProtocolMode

func (*Protocol) Role

func (p *Protocol) Role() ProtocolRole

func (*Protocol) SendError

func (p *Protocol) SendError(err error)

func (*Protocol) SendMessage

func (p *Protocol) SendMessage(msg Message) error

func (*Protocol) Start

func (p *Protocol) Start()

type ProtocolConfig

type ProtocolConfig struct {
	Name                string
	ProtocolId          uint16
	ErrorChan           chan error
	Muxer               *muxer.Muxer
	Mode                ProtocolMode
	Role                ProtocolRole
	MessageHandlerFunc  MessageHandlerFunc
	MessageFromCborFunc MessageFromCborFunc
	StateMap            StateMap
	InitialState        State
}

type ProtocolMode

type ProtocolMode uint

const (
	ProtocolModeNone         ProtocolMode = 0
	ProtocolModeNodeToClient ProtocolMode = 1
	ProtocolModeNodeToNode   ProtocolMode = 2
)

type ProtocolOptions

type ProtocolOptions struct {
	Muxer     *muxer.Muxer
	ErrorChan chan error
	Mode      ProtocolMode
	Role      ProtocolRole
	Version   uint16
}

Common arguments for individual mini-protocols

type ProtocolRole

type ProtocolRole uint

const (
	ProtocolRoleNone   ProtocolRole = 0
	ProtocolRoleClient ProtocolRole = 1
	ProtocolRoleServer ProtocolRole = 2
)

type State

type State struct {
	Id   uint
	Name string
}

func NewState

func NewState(id uint, name string) State

func (State) String

func (s State) String() string

type StateMap

type StateMap map[State]StateMapEntry

type StateMapEntry

type StateMapEntry struct {
	Agency      uint
	Transitions []StateTransition
}

type StateTransition

type StateTransition struct {
	MsgType   uint8
	NewState  State
	MatchFunc StateTransitionMatchFunc
}

type StateTransitionMatchFunc

type StateTransitionMatchFunc func(Message) bool