protocol

Documentation

Index

• Constants
• Variables
• func Encode(msg *Message, nsp *string) (string, error)
• func MustEncode(msg *Message) string
• type Message
  • func Decode(data string) (*Message, error)

Constants

const (
	/**
	Message with connection options
	*/
	MessageTypeOpen = iota
	/**
	Close connection and destroy all handle routines
	*/
	MessageTypeClose = iota
	/**
	Ping request message
	*/
	MessageTypePing = iota
	/**
	Pong response message
	*/
	MessageTypePong = iota
	/**
	Empty message
	*/
	MessageTypeEmpty = iota
	/**
	Emit request, no response
	*/
	MessageTypeEmit = iota
	/**
	Emit request, wait for response (ack)
	*/
	MessageTypeAckRequest = iota
	/**
	ack response
	*/
	MessageTypeAckResponse = iota
)

const (
	CloseMessage = "1"
	PingMessage  = "2"
	PongMessage  = "3"
)

Variables

var (
	ErrorWrongMessageType = errors.New("Wrong message type")
	ErrorWrongPacket      = errors.New("Wrong packet")
)

Functions

func Encode

func Encode(msg *Message, nsp *string) (string, error)

func MustEncode

func MustEncode(msg *Message) string

Types

type Message

type Message struct {
	Type   int
	AckId  int
	Method string
	Args   string
	Source string
}

func Decode

func Decode(data string) (*Message, error)