internal

Documentation

Index

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

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

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

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

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

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.