ws

Documentation

Index

• type Client
• type WebSocketHub
  • func NewWebSocketHub() *WebSocketHub
• type WsMessenger
  • func (m *WsMessenger) JavascriptFiles() map[string]html5tag.Attributes
  • func (m *WsMessenger) JavascriptInit() string
  • func (m *WsMessenger) Send(channel string, message string)
  • func (m *WsMessenger) Start() *WebSocketHub
  • func (m *WsMessenger) WebSocketHandler() http.Handler

Types

type Client

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

Client is a middleman between the websocket connection and the hub.

type WebSocketHub

type WebSocketHub struct {

	// Time to wait for a write to complete
	WriteWait time.Duration

	// Time allowed to read the next pong message from the peer.
	PongWait time.Duration

	// Send pings to peer with this period. Must be less than pongWait.
	PingPeriod time.Duration

	// Maximum message size allowed from peer.
	MaxMessageSize int64
	// contains filtered or unexported fields
}

func NewWebSocketHub

func NewWebSocketHub() *WebSocketHub

type WsMessenger

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

func (*WsMessenger) JavascriptFiles

func (m *WsMessenger) JavascriptFiles() map[string]html5tag.Attributes

func (*WsMessenger) JavascriptInit

func (m *WsMessenger) JavascriptInit() string

func (*WsMessenger) Send

func (m *WsMessenger) Send(channel string, message string)

func (*WsMessenger) Start

func (m *WsMessenger) Start() *WebSocketHub

func (*WsMessenger) WebSocketHandler

func (m *WsMessenger) WebSocketHandler() http.Handler

WebSocketHandler handles web socket requests to send messages to clients. It gets the client id from the context in the request. You should intercept the request, authorize the client, then insert the client ID into the context of the Request