wsmessage

Documentation

Index

• Constants
• type ByteSerializer
  • func (s ByteSerializer) Deserialize(data []byte) (msg Message, err error)
  • func (s ByteSerializer) Serialize(m Message) ([]byte, error)
• type Deserializer
• type Message
  • func NewMessage(typ string, room string, payload interface{}) Message
  • func NewMessageRoomJoin(room string, clientID string, metadata string) Message
  • func NewMessageRoomLeave(room string, clientID string) Message
• type Serializer

Constants

const (
	MessageTypeRoomJoin  string = "ws_room_join"
	MessageTypeRoomLeave string = "ws_room_leave"
)

Types

type ByteSerializer

type ByteSerializer struct{}

func (ByteSerializer) Deserialize

func (s ByteSerializer) Deserialize(data []byte) (msg Message, err error)

func (ByteSerializer) Serialize

func (s ByteSerializer) Serialize(m Message) ([]byte, error)

type Deserializer

type Deserializer interface {
	Deserialize([]byte) (Message, error)
}

type Message

type Message struct {
	// Types 0-10 are reserved for base functionality, others can be used for
	// custom implementations.
	Type string `json:"type"`
	// Room this message is related to
	Room string `json:"room"`
	// Payload content
	Payload interface{} `json:"payload"`
}

Simple message is a container for web-socket messages.

func NewMessage

func NewMessage(typ string, room string, payload interface{}) Message

func NewMessageRoomJoin

func NewMessageRoomJoin(room string, clientID string, metadata string) Message

func NewMessageRoomLeave

func NewMessageRoomLeave(room string, clientID string) Message

type Serializer

type Serializer interface {
	Serialize(message Message) ([]byte, error)
}