Table Of Contents

Open WebSocket (G Dataflow)

Last Modified: February 26, 2020

Creates a WebSocket connection using the specified URL.

Use this node with other WebSocket nodes to stream messages to and from a WebSocket server. You must close the WebSocket session using Close WebSocket.

connector_pane_image
datatype_icon

url

URL of the websocket server you want to use for this websocket session. This URL must use the form ws://<server-address> or wss://<server-address>.

datatype_icon

subprotocols

Specifies the sub-protocols you want to use for the websocket session.

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

datatype_icon

protocol

The subprotocol that the specified websocket server selects.

datatype_icon

websocket session out

Unique value that identifies the websocket session. Use this value to refer to this websocket session in subsequent node calls.

datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Supported in VIs that run in a web application


Recently Viewed Topics