Broadcast — Reference
Send an event to other clients from the current socket context.
Send an event to other clients from the current socket context.
Before you begin
Section titled “Before you begin”- A Node.js project with Socket.IO configured and connected test clients. Socket-specific operations must run in a socket action.
Broadcast
Section titled “Broadcast”Send an event to other clients from the current socket context.
Settings
Section titled “Settings”| Setting | Meaning |
|---|---|
| Name | The step identifier used for results in the server action. Sending/joining steps do not return a delivery receipt merely because they have a name. |
| Room | The application room to target, join or leave. Use a server-approved room name. A room is a routing group, not an authentication permission. |
| Type | The event/action type selected from the socket definitions. This becomes the emitted eventName, not a primitive data type such as text or number. |
| Input Parameters | Fields generated from the chosen event/action’s $_PARAM definition. Their names and values become the sent parameters. Changing the selected definition clears the earlier parameter mapping; recheck it before testing. |
Verification example
Section titled “Verification example”From a test socket action, broadcast a test event while two clients are connected. Confirm that the other client receives it and the originating socket does not. Repeat with a room filter.
Context and delivery limits
Section titled “Context and delivery limits”Broadcast requires a current socket; an ordinary HTTP action has no sender socket for this operation and the installed module does nothing without it. Use Emit when you intend a server-originated event that does not depend on a current sender.
Connect to page behavior
Section titled “Connect to page behavior”Use client event handlers or the appropriate Server Connect subscription to update the page. Keep authorization, persistence and event delivery as explicit parts of the workflow.
Check your result
Section titled “Check your result”You can choose the intended recipients/context and verify the event or room behavior with test clients.