protocol

Documentation

Index

• Constants
• Variables
• func Unmarshal[T Parsable](msg T, data *Message)
• type BeginConnection
  • func (b *BeginConnection) Marshal() *Message
  • func (b *BeginConnection) Unmarshal(payload []byte)
• type CloseConnection
  • func (c *CloseConnection) Marshal() *Message
  • func (c *CloseConnection) Unmarshal(payload []byte)
• type ConnectionReady
  • func (c *ConnectionReady) Marshal() *Message
  • func (c *ConnectionReady) Unmarshal(payload []byte)
• type ConnectionRegister
  • func (c *ConnectionRegister) Marshal() *Message
  • func (c *ConnectionRegister) Unmarshal(payload []byte)
• type ConnectionRegisterResp
  • func (c *ConnectionRegisterResp) Marshal() *Message
  • func (c *ConnectionRegisterResp) Unmarshal(payload []byte)
• type EndConnection
  • func (e *EndConnection) Marshal() *Message
  • func (e *EndConnection) Unmarshal(payload []byte)
• type ErrorMessage
  • func NewErrorMessage(message string) *ErrorMessage
  • func (e *ErrorMessage) Marshal() *Message
  • func (e *ErrorMessage) Unmarshal(payload []byte)
• type Heartbeat
  • func (h *Heartbeat) Marshal() *Message
  • func (h *Heartbeat) Unmarshal(payload []byte)
• type Message
  • func ReadMessage(r io.Reader) (int, *Message, error)
  • func (m *Message) Write(w io.Writer) (int, error)
• type MessageType
  • func (t MessageType) String() string
• type Parsable
• type Protocol
  • func ProtocolFromByte(b byte) Protocol
  • func (p Protocol) Byte() byte
  • func (p Protocol) Valid() bool

Constants

const (
	// Header size in bytes (1 byte type + 4 bytes length).
	HeaderSize = 5
)

Variables

var (
	ErrInvalidMessage = errors.New("invalid message")
)

Functions

func Unmarshal

func Unmarshal[T Parsable](msg T, data *Message)

Unmarshal converts a byte slice to the appropriate message type.

Types

type BeginConnection

type BeginConnection struct {
	Subdomain string
}

func (*BeginConnection) Marshal

func (b *BeginConnection) Marshal() *Message

Marshal converts a BeginConnection to a byte slice.

func (*BeginConnection) Unmarshal

func (b *BeginConnection) Unmarshal(payload []byte)

Unmarshal converts a byte slice to a BeginConnection.

type CloseConnection

type CloseConnection struct {
	Reason string
}

func (*CloseConnection) Marshal

func (c *CloseConnection) Marshal() *Message

func (*CloseConnection) Unmarshal

func (c *CloseConnection) Unmarshal(payload []byte)

type ConnectionReady

type ConnectionReady struct {
	Subdomain string
}

func (*ConnectionReady) Marshal

func (c *ConnectionReady) Marshal() *Message

Marshal converts a ConnectionReady to a byte slice.

func (*ConnectionReady) Unmarshal

func (c *ConnectionReady) Unmarshal(payload []byte)

Unmarshal converts a byte slice to a ConnectionReady.

type ConnectionRegister

type ConnectionRegister struct {
	Subdomain string
	Host      string
	Port      uint32
	Protocol  Protocol
	Token     string
}

func (*ConnectionRegister) Marshal

func (c *ConnectionRegister) Marshal() *Message

func (*ConnectionRegister) Unmarshal

func (c *ConnectionRegister) Unmarshal(payload []byte)

type ConnectionRegisterResp

type ConnectionRegisterResp struct {
	Success   bool
	Subdomain string
	Message   string
}

func (*ConnectionRegisterResp) Marshal

func (c *ConnectionRegisterResp) Marshal() *Message

func (*ConnectionRegisterResp) Unmarshal

func (c *ConnectionRegisterResp) Unmarshal(payload []byte)

type EndConnection

type EndConnection struct {
	Subdomain string
}

func (*EndConnection) Marshal

func (e *EndConnection) Marshal() *Message

Marshal converts an EndConnection to a byte slice.

func (*EndConnection) Unmarshal

func (e *EndConnection) Unmarshal(payload []byte)

Unmarshal converts a byte slice to an EndConnection.

type ErrorMessage

type ErrorMessage struct {
	Message string
}

func NewErrorMessage

func NewErrorMessage(message string) *ErrorMessage

func (*ErrorMessage) Marshal

func (e *ErrorMessage) Marshal() *Message

func (*ErrorMessage) Unmarshal

func (e *ErrorMessage) Unmarshal(payload []byte)

type Heartbeat

type Heartbeat struct {
	Message string
}

func (*Heartbeat) Marshal

func (h *Heartbeat) Marshal() *Message

func (*Heartbeat) Unmarshal

func (h *Heartbeat) Unmarshal(payload []byte)

type Message

type Message struct {
	Type    MessageType
	Length  uint32
	Payload []byte
}

Message represents a protocol message.

func ReadMessage

func ReadMessage(r io.Reader) (int, *Message, error)

ReadMessage reads a message from the given reader.

func (*Message) Write

func (m *Message) Write(w io.Writer) (int, error)

Write writes the message to the given writer.

type MessageType

type MessageType int

const (

	// Registration messages
	// These messages are used to register a connection with the server.
	MessageConnectionRegister     MessageType = 1
	MessageConnectionRegisterResp MessageType = 2

	// Maintenance messages
	// These messages are used to maintain the connection with the server.
	MessageDisconnect MessageType = 3
	MessageHeartbeat  MessageType = 4
	MessageError      MessageType = 5

	// Data messages
	// These messages are used to open and close streams of data.
	MessageBeginStream     MessageType = 6
	MessageEndStream       MessageType = 7
	MessageConnectionReady MessageType = 8
)

func (MessageType) String

func (t MessageType) String() string

type Parsable

type Parsable interface {
	Marshal() *Message
	Unmarshal([]byte)
}

type Protocol

type Protocol string

const (
	HTTP Protocol = "http"
	TCP  Protocol = "tcp"
)

func ProtocolFromByte

func ProtocolFromByte(b byte) Protocol

func (Protocol) Byte

func (p Protocol) Byte() byte

func (Protocol) Valid

func (p Protocol) Valid() bool