The WebSocket DAT receives and parses WebSocket messages. WebSockets are fast an efficient two way communication protocol used by web servers and clients. Each message is parsed and appended as a row in the DAT's table. The table is FIFO "first-in first-out" and limited to parameter-set number of lines. An optional script may be run for each packet received. Secure (tls) websocket servers are also supported. Connections to different WebSocket sites are supported without requiring manual header setup.
For SocketIO support see the SocketIO DAT.
See also: TCP/IP DAT
Example project: chat with WebSockets
Parameters - Connect Page
active - While on, the DAT receives information sent to the network port. While Off, no updating occurs. Data sent to the port is lost.
netaddress - The network address of the server computer. This address is a standard WWW address, such as
foo.bar.com. You can put an IP address (e.g.
100.123.45.78). If you put
localhost, it means the other end of the connection is on the same computer.
port - The port in which the DAT will accept messages.
Parameters - Received Messages Page
callbacks - The Callbacks DAT will execute once for each message coming in.
executeloc - ⊞ - Determines the location the script is run from.
- Current Node
current- The script is executed from the current node location.
- Callbacks DAT
callbacks- The script is executed from the location of the DAT specified in the Callbacks DAT parameter.
- Specified Operator
op- The script is executed from the operator specified in the From Operator parameter below.
fromop - The operator whose state change will trigger the DAT to execute its script when Execute from is set to Specified Operator. This operator is also the path that the script will be executed from if the Execute from parameter is set to Specified Operator.
clamp - The DAT is limited to 100 messages by default but with Clamp Output, this can be set to anything including unlimited.
maxlines - Limits the number of messages, older messages are removed from the list first.
clear - Deletes all lines except the heading. To clear with a python script
bytes - Outputs the raw bytes of the message in a separate column.
Parameters - Common Page
language - ⊞ - Select how the DAT decides which script language to operate on.
input- The DAT uses the inputs script language.
node- The DAT uses it's own script language.
extension - ⊞ - Select the file extension this DAT should expose to external editors.
dat- various common file extensions.
- From Language
language- pick extension from DATs script language.
- Custom Extension
custom- Specify a custom extension.
customext - Specifiy the custom extension.
wordwrap - ⊞ - Enable Word Wrap for Node Display.
input- The DAT uses the inputs setting.
on- Turn on Word Wrap.
off- Turn off Word Wrap.
- Input 0: -
Info CHOP Channels
Extra Information for the WebSocket DAT can be accessed via an Info CHOP.
Common DAT Info Channels
- num_rows - Number of rows in this DAT.
- num_cols - Number of columns in this DAT.
Common Operator Info Channels
- total_cooks - Number of times the operator has cooked since the process started.
- cook_time - Duration of the last cook in milliseconds.
- cook_frame - Frame number when this operator was last cooked relative to the component timeline.
- cook_abs_frame - Frame number when this operator was last cooked relative to the absolute time.
- cook_start_time - Time in milliseconds at which the operator started cooking in the frame it was cooked.
- cook_end_time - Time in milliseconds at which the operator finished cooking in the frame it was cooked.
- cooked_this_frame - 1 if operator was cooked this frame.
- warnings - Number of warnings in this operator if any.
- errors - Number of errors in this operator if any.