websocket

Documentation

Index

• func Start(router *mux.Router)
• type NotificationType
• type SocketMessage
  • func (message SocketMessage) Send()

Functions

func Start

func Start(router *mux.Router)

Start starts the socket

Types

type NotificationType

type NotificationType string

NotificationType use to switch over different types of notifications.

const (
	// EncoderState represents an event for an encoder changing state.
	EncoderState NotificationType = "encoderState"
	// CaptionerState represents an event for an captioner changing state.
	CaptionerState NotificationType = "captionerState"
	// NetworkState represents an event for a network changing state
	NetworkState NotificationType = "networkState"
)

type SocketMessage

type SocketMessage struct {
	Reference *int
	Payload   interface{}
}

SocketMessage A message to be emitted over all open websockets

func (SocketMessage) Send

func (message SocketMessage) Send()

Send emits the receiver as a message across all websocket connections.