protocol

Documentation

Index

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

Constants

const (
	MessageTypeOpen        = iota // message with connection options
	MessageTypeClose              // close connection and destroy all handle routines
	MessageTypePing               // ping request message
	MessageTypePong               // pong response message
	MessageTypeEmpty              // empty message
	MessageTypeEmit               // emit request, no response
	MessageTypeAckRequest         // emit request, wait for response (ack)
	MessageTypeAckResponse        // ack response
	MessageTypeUpgrade            // upgrade message
	MessageTypeBlank              // blank message
)

const (
	MessageOpen      = "0"
	MessageClose     = "1"
	MessagePing      = "2"
	MessagePingProbe = "2probe"
	MessagePongProbe = "3probe"
	MessagePong      = "3"

	MessageEmpty = "40"

	MessageUpgrade = "5"
	MessageBlank   = "6"
	MessageStub    = "stub"
)

Variables

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

Functions

func Encode

func Encode(m *Message) (string, error)

Encode a socket.io message m to the protocol format

func MustEncode

func MustEncode(m *Message) string

MustEncode the message m acts like Encode but panics on error

Types

type Message

type Message struct {
	Type      int
	AckID     int
	EventName string
	Args      string
	Source    string
}

Message represents socket.io message

func Decode

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

Decode the given data string into a Message