internal

package

v0.5.4 Latest Latest Go to latest Published: Apr 22, 2026 License: MIT Imports: 10 Imported by: 0

Documentation ¶

Index ¶

Variables
func GetHub() *hub
func NewWebSocketPlugin() sdk.PluginProvider
func SetBroadcastHook(f func(room string, msg []byte) int)
func SetSendHook(f func(connID string, msg []byte) bool)
type WSServerInstance
- func NewWSServerModule(name string, config map[string]any) (WSServerInstance, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var Version = "dev"

Version is set at build time via -ldflags "-X github.com/GoCodeAlone/workflow-plugin-websocket/internal.Version=X.Y.Z"

Functions ¶

func GetHub ¶

func GetHub() *hub

GetHub returns the global WebSocket hub for step types to use.

func NewWebSocketPlugin ¶

func NewWebSocketPlugin() sdk.PluginProvider

func SetBroadcastHook ¶ added in v0.5.0

func SetBroadcastHook(f func(room string, msg []byte) int)

SetBroadcastHook installs a hook that overrides room broadcasts in step.ws_broadcast. Pass nil to remove the hook.

func SetSendHook ¶ added in v0.5.0

func SetSendHook(f func(connID string, msg []byte) bool)

SetSendHook installs a hook that overrides direct sends in step.ws_send. Pass nil to remove the hook.

Types ¶

type WSServerInstance ¶ added in v0.3.3

type WSServerInstance interface {
	sdk.ModuleInstance
	ServeHTTP(w http.ResponseWriter, r *http.Request)
	HTTPPath() string
}

WSServerInstance is the public interface for the ws.server module, exposing the HTTP handler methods needed for in-process registration.

func NewWSServerModule ¶ added in v0.3.3

func NewWSServerModule(name string, config map[string]any) (WSServerInstance, error)

NewWSServerModule creates a new ws.server module instance and returns it via the WSServerInstance interface so the host binary can register the WebSocket upgrade handler directly on the engine's HTTP router.

Source Files ¶

View all Source files

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