protocol

Documentation

Index

• type Events
• type Protocol
  • func New(r *message.Registry) *Protocol
  • func (p *Protocol) Read(data []byte) (int, error)
• type VoidEvent

Types

type Events

type Events struct {
	// Holds event instances to attach to for received messages.
	// Use a message's ID to get the corresponding event.
	Received []*event.Event[[]byte]
	// Fired for generic protocol errors.
	Error *event.Event[error]
}

Events holds protocol related events.

type Protocol

type Protocol struct {
	// Holds events for sent/received messages and generic errors.
	Events *Events
	// contains filtered or unexported fields
}

Protocol encapsulates the logic of parsing and sending protocol messages.

func New

func New(r *message.Registry) *Protocol

New generates a new protocol instance which is ready to read a first message header.

func (*Protocol) Read

func (p *Protocol) Read(data []byte) (int, error)

Read acts as an event handler for received data.

type VoidEvent

type VoidEvent struct{}