message

Documentation

Index

• Constants
• func Marshal(msg Message) ([]byte, error)
• func RegisterType(newMessageOfType func() Message)
• func Type(msg Message) string
• type Message
  • func Unmarshal(data []byte) (Message, error)
• type Meta
  • func (m *Meta) GetID() string
  • func (m *Meta) SetID(id string)

Constants

const (
	// MaxSize is the maximum supported WebSocket message size.
	MaxSize = 65536
)

Functions

func Marshal

func Marshal(msg Message) ([]byte, error)

Marshal marshals a message, returning the data.

func RegisterType

func RegisterType(newMessageOfType func() Message)

RegisterType registers a known message type.

func Type

func Type(msg Message) string

Type returns the string formatted type of the message.

Types

type Message

type Message interface {
	GetAPIVersion() string
	GetKind() string
	GetID() string
	SetID(id string)
}

Message is a message that can be sent/received.

func Unmarshal

func Unmarshal(data []byte) (Message, error)

Unmarshal unmarshals a message from the given data.

type Meta

type Meta struct {
	// APIVersion is the version of the API.
	APIVersion string `json:"apiVersion" mapstructure:"apiVersion"`
	// Kind is the kind of the message.
	Kind string `json:"kind" mapstructure:"kind"`
	// ID is the globally unique message ID, or in the case of an Ack, the ID of
	// the message being acknowledged.
	ID string `json:"id" mapstructure:"id"`
}

func (*Meta) GetID

func (m *Meta) GetID() string

func (*Meta) SetID

func (m *Meta) SetID(id string)