websockets

package
v1.29.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 22, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package websockets is used to broadcast messages to connected clients

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BroadCastClientError added in v1.20.2 

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 any)

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 any
}

WebsocketNotification struct for responses

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.