ws

Documentation

Index

• type WebSocketChannels
• type WebSocketCommandMessage
• type WebSocketCommandMessageOrError
• type WebSocketServer
  • func NewWebSocketServer(bgCtx context.Context) WebSocketServer

Types

type WebSocketChannels

type WebSocketChannels interface {
	GetChannels(topic string) (senderChannel chan<- interface{}, broadcastChannel chan<- interface{}, receiverChannel <-chan *WebSocketCommandMessageOrError)
	SendReply(message interface{})
}

WebSocketChannels is provided to allow us to do a blocking send to a namespace that will complete once a client connects on it We also provide a channel to listen on for closing of the connection, to allow a select to wake on a blocking send

type WebSocketCommandMessage

type WebSocketCommandMessage struct {
	Type        string `json:"type,omitempty"`
	Topic       string `json:"topic,omitempty"`  // synonym for "topic" - from a time when we let you configure the topic separate to the stream name
	Stream      string `json:"stream,omitempty"` // name of the event stream
	Message     string `json:"message,omitempty"`
	BatchNumber int64  `json:"batchNumber,omitempty"`
}

type WebSocketCommandMessageOrError

type WebSocketCommandMessageOrError struct {
	Msg *WebSocketCommandMessage
	Err error
}

type WebSocketServer

type WebSocketServer interface {
	WebSocketChannels
	Handler(w http.ResponseWriter, r *http.Request)
	Close()
}

WebSocketServer is the full server interface with the init call

func NewWebSocketServer

func NewWebSocketServer(bgCtx context.Context) WebSocketServer

NewWebSocketServer create a new server with a simplified interface