websockets

Documentation

Overview

Package websockets is used to broadcast messages to connected clients

Index

• func BroadCastClientError(severity, errorType, ip, message string)
• func Broadcast(t string, msg interface{})
• func ServeWs(hub *Hub, w http.ResponseWriter, r *http.Request)
• type Client
• type Hub
  • func NewHub() *Hub
  • func (h *Hub) Run()
• type WebsocketNotification

Functions

func BroadCastClientError

func BroadCastClientError(severity, errorType, ip, message string)

BroadCastClientError is a wrapper to broadcast client errors to the web UI

func Broadcast

func Broadcast(t string, msg interface{})

Broadcast will spawn a broadcast message to all connected clients

func ServeWs

func ServeWs(hub *Hub, w http.ResponseWriter, r *http.Request)

ServeWs handles websocket requests from the peer.

Types

type Client

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

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

type Hub

type Hub struct {
	// Registered clients.
	Clients map[*Client]bool

	// Inbound messages from the clients.
	Broadcast chan []byte
	// contains filtered or unexported fields
}

Hub maintains the set of active clients and broadcasts messages to the clients.

var (

	// MessageHub global
	MessageHub *Hub
)

func NewHub

func NewHub() *Hub

NewHub returns a new hub configuration

func (*Hub) Run

func (h *Hub) Run()

Run runs the listener

type WebsocketNotification

type WebsocketNotification struct {
	Type string
	Data interface{}
}

WebsocketNotification struct for responses