workflowpluginwebsocket

Documentation

Overview

Package workflowpluginwebsocket provides the WebSocket workflow plugin.

Index

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

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
}

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.