workflowpluginwebsocket

package module

v0.3.2 Latest Latest Go to latest Published: Mar 15, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation ¶

Overview ¶

Package workflowpluginwebsocket provides the WebSocket workflow plugin.

Index ¶

func NewWebSocketPlugin() sdk.PluginProvider
type Hub
- func GetHub() Hub

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewWebSocketPlugin ¶

func NewWebSocketPlugin() sdk.PluginProvider

NewWebSocketPlugin returns the WebSocket SDK plugin provider.

Types ¶

type Hub ¶

type Hub interface {
	BroadcastToRoom(room string, msg []byte) int
	// SendTo delivers a message directly to a connection by its ID.
	SendTo(connID string, msg []byte) bool
}

Hub is an exported interface for the WebSocket hub's broadcast capabilities. Satisfied by the internal hub after the ws.server module is initialized.

func GetHub ¶

func GetHub() Hub

GetHub returns the global WebSocket hub once the ws.server module has been initialized. Returns nil if the module has not started yet.

Source Files ¶

View all Source files

plugin.go

Directories ¶

Path	Synopsis
cmd
workflow-plugin-websocket command
internal

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL