Table Of Contents

TCP Write (TCP Write Text) (G Dataflow)

Last Modified: December 18, 2017

Writes string data to a TCP network connection.

Programming Patterns
connector_pane_image
datatype_icon

connection ID in

A network connection refnum that uniquely identifies the TCP connection.

Use TCP Open Connection to generate a refnum to wire to this input.

datatype_icon

data in

The data to write to the connection.

datatype_icon

timeout ms

Time, in milliseconds, that the node waits to complete before reporting a timeout error.

Wire a -1 to this input to wait indefinitely.

Default: 25,000 ms

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

connection ID out

Same value as connection ID in.

datatype_icon

bytes written

The number of bytes the node writes to the connection.

If the number of bytes written is fewer than the number of bytes in data in, an error has occurred. For example, this node may have timed out before all the data was transmitted. Use this output to determine what data has been successfully written and possibly retry writing any remaining data.

datatype_icon

error out

This node can return the following error codes.

56 The network operation exceeded the user-specified or system time limit.
62 The system caused the network connection to be aborted.
64 The network connection is not yet established.
66 The network operation was closed by the peer.
spd-note-note
Note  

This is not a comprehensive list of errors this node can return.

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: This product does not support FPGA devices

Web Server: Not supported in VIs that run in a web application


Recently Viewed Topics