websocket

Documentation

Index

• Constants
• func Endpoint(endpoint string, ...)
• type Broadcast
  • func NewBroadcast() *Broadcast
  • func (broadcast Broadcast) Broadcast(message []byte)
  • func (broadcast Broadcast) BroadcastJson(content interface{})
  • func (broadcast *Broadcast) Shutdown()
  • func (broadcast Broadcast) Subscribe(messages chan []byte) uint64
  • func (broadcast Broadcast) Unsubscribe(cookie uint64)

Constants

const Context = `WEBSERVER/WEBSOCKET`

Context to use when logging

const ContextBroadcast = "WEBSOCKET/BROADCAST"

ContextBroadcast used to identify the broadcast server in logging

const DeadlinePong = 3 * time.Minute

DeadlinePong to send after a ping request in the control message

Functions

func Endpoint

func Endpoint(endpoint string, handler func(string, url.Values, <-chan []byte, chan<- []byte, chan<- error, <-chan bool))

Endpoint handles a HTTP request and upgrades it, giving the user a channel to receive messages down and a reply channel to send messages to the websocket.

Types

type Broadcast

type Broadcast struct {
	// contains filtered or unexported fields
}

Broadcast for sending messages to channels subscribing to events here

func NewBroadcast

func NewBroadcast() *Broadcast

NewBroadcast, creating a new map and new counter for messages and set up the server that handles new subscriptions.

func (Broadcast) Broadcast

func (broadcast Broadcast) Broadcast(message []byte)

func (Broadcast) BroadcastJson

func (broadcast Broadcast) BroadcastJson(content interface{})

func (*Broadcast) Shutdown

func (broadcast *Broadcast) Shutdown()

Shutdown the broadcast, closing the inner worker and setting the struct to nil

func (Broadcast) Subscribe

func (broadcast Broadcast) Subscribe(messages chan []byte) uint64

Subscribe to the broadcast, with a new channel receiving messages being sent

func (Broadcast) Unsubscribe

func (broadcast Broadcast) Unsubscribe(cookie uint64)