protocol

Documentation

Index

• 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(name string, protocolId uint16, m *muxer.Muxer, errorChan chan error, ...) *Protocol
  • func (p *Protocol) GetState() State
  • func (p *Protocol) LockState(allowedStates []State) error
  • func (p *Protocol) SendMessage(msg interface{}, isResponse bool) error
  • func (p *Protocol) SetState(state State)
  • func (p *Protocol) UnlockState(newState State)
• type State
  • func NewState(id uint, name string) State
  • func (s State) String() string

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) error

type Protocol

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

func New

func New(name string, protocolId uint16, m *muxer.Muxer, errorChan chan error, handlerFunc MessageHandlerFunc, msgFromCborFunc MessageFromCborFunc) *Protocol

func (*Protocol) GetState

func (p *Protocol) GetState() State

func (*Protocol) LockState

func (p *Protocol) LockState(allowedStates []State) error

func (*Protocol) SendMessage

func (p *Protocol) SendMessage(msg interface{}, isResponse bool) error

func (*Protocol) SetState

func (p *Protocol) SetState(state State)

func (*Protocol) UnlockState

func (p *Protocol) UnlockState(newState State)

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