framing

Documentation

Index

• Constants
• func CreateErrorClient(endpointId uint16, clientId uint32, message string) []byte
• func CreateErrorSession(endpointId uint16, sessionId uint32, message string) []byte
• type AuthenticationAckFrame
  • func NewAuthenticationAck(token string) AuthenticationAckFrame
  • func (frame *AuthenticationAckFrame) Encode() *[]byte
• type MessageFrame
  • func (frame *MessageFrame) Close() []byte
  • func (frame MessageFrame) Encode() []byte
• type SessionFrame
  • func (frame *SessionFrame) Ack(sessionId uint32) *[]byte
  • func (frame *SessionFrame) Encode() []byte

Constants

const (
	Data                         = 0
	ClientSessionRequest         = 1
	ClientSessionRequestWithAuth = 0b10000001
	ServerSessionAck             = 2
	Close                        = 3
	ErrorClientID                = 4
	ErrorSessionID               = 5
	Authentication               = 6
	AuthenticationAck            = 7
)

const AuthenticationEndpoint = 0xFFFF

AuthenticationEndpoint is a phantom endpoint that's used to signify an authentication message

Functions

func CreateErrorClient

func CreateErrorClient(endpointId uint16, clientId uint32, message string) []byte

func CreateErrorSession

func CreateErrorSession(endpointId uint16, sessionId uint32, message string) []byte

Types

type AuthenticationAckFrame

type AuthenticationAckFrame struct {
	TokenHash [32]byte
}

func NewAuthenticationAck

func NewAuthenticationAck(token string) AuthenticationAckFrame

func (*AuthenticationAckFrame) Encode

func (frame *AuthenticationAckFrame) Encode() *[]byte

type MessageFrame

type MessageFrame struct {
	EndpointId uint16
	Flag       uint8
	SessionId  uint32
	Data       []byte
}

func (*MessageFrame) Close

func (frame *MessageFrame) Close() []byte

func (MessageFrame) Encode

func (frame MessageFrame) Encode() []byte

type SessionFrame

type SessionFrame struct {
	EndpointId uint16
	Flag       uint8
	ClientId   uint32
	Token      string
	SessionId  *uint32
}

func (*SessionFrame) Ack

func (frame *SessionFrame) Ack(sessionId uint32) *[]byte

func (*SessionFrame) Encode

func (frame *SessionFrame) Encode() []byte