beta
cables is under heavy development.
There might be one or another bug, please let us know about it!
SocketCluster
Ops.Net.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/

doc

issues

youtube id

collections

related ops

Inputs

Active (boolean /Number)

toggle connected/disconnected state


Server hostname (String)

hostname


Server path (String)

path of url


Server port (Number)

server port


Use SSL (boolean /Number)

enable encryption (needs to be supported by server)


Allow send (boolean /Number)

allow sending from this client


Allow multiple senders (boolean /Number)

allow multiple senders


Channel (String)

name of the socketcluster channel


Delay send (ms) (integer /Number)

delay sending messages by x ms


Additional serverdata (Object)

additional data send with every message (can be used for auth-token)


Outputs

Ready (boolean Number)

connection is ready


Socket (Object)

socket object to connect to other socketcluster ops


Own client id (String)

my own client id


Can send (boolean Number)

wether or not this client is able/allowed to send messages


Error (Object)

error object


Caught a mistake or want to contribute to the documentation?

Edit Documentationcancel save
SocketCluster example:


Credits


Changelog


created op
2020-03-18 - stephan

added lib: socketcluster-client.js
2020-03-18 - stephan

cloned op from Ops.Net.SocketCluster.SocketCluster
2021-05-11 - stephan

Ops.User.stephan.SocketCluster_v2 renamed to Ops.Net.SocketCluster.SocketCluster_v2
2021-05-11 - stephan

Examples using SocketCluster_v2

Public Patches using SocketCluster_v2