SocketCluster Op
There is a newer version of this op!
This version will not receive any updates. It is recommended to use a newer version.
Current version: Ops.Extension.SocketCluster.SocketCluster_v2
connect to a socketcluster server and manage the connection
Summary (oneliner)
SocketCluster connects to the websocket at the given hostname. Then you define a channel that all the messages will be sent to. SocketCluster outputs a socket that has to be used in senders and receivers.
There can be multiple sockets in one patch.
Every message has a "topic" and a datatype, only the relevant datatypes will be received by the right receiving ops listening to that "topic".
In default mode only one "client" is allowed to send, this is controlled by the "allowSend" input. On changing this, all the other clients will be notified and change to "listening" state.
By enabling "allow multiple senders" all the clients are allowed to send (depending on their setting of "allowSend"). This can lead to endless loops in for example a setup where a TriggerChangeValue triggers a send, then the message is received and changes the value...be careful!
Clients do not handle their own messages, every statechange has to be done directly in the patch as well. This is to avoid more possibilities for endless loops.
For more information visit: https://socketcluster.io/
Edit Documentation
- Ops.Extension.SocketCluster.SocketCluster
- Extension Op - Visible to all users
- MIT
- socketcluster client (socketcluster client)
Documentation (markdown)
Issues
Example patch id
Youtube ids (comma seperated)
Op Licence
Caniuse query
INPUT PORTS
socketcluster server
socketcluster path (defaults to "/socketcluster")
socketcluster port (usually 443 for ssl)
allow sending of messages
send when other clients are allowed to send
name of channel
delay sending of all messages by number of ms
add data outside the payload for the socketcluster server to read, can be used for auth-token or sessiondata
OUTPUT PORTS
connection is ready
socket object for send/receive ops
whether this client is allowed to send
error