Table Of Contents

TCP Read (TCP Read Text) (G Dataflow)

Last Modified: March 15, 2017

Reads a number of bytes from a TCP network connection and returns the results as string data.

Programming Patterns
connector_pane_image
datatype_icon

mode

The behavior of the read operation.

Name Description
Standard

Waits until all bytes you specify in bytes to read arrive or until timeout ms runs out. This node returns the number of bytes read so far. If fewer bytes than the number you requested arrive, this node returns the partial number of bytes and reports a timeout error.

Buffered

Waits until all bytes you specify in bytes to read arrive or until timeout ms runs out. If fewer bytes than the number you requested arrive, this node returns no bytes and reports a timeout error.

CRLF

Waits until all bytes you specify in bytes to read arrive or until the node receives a CR (carriage return) followed by a LF (linefeed) within the number of bytes you specify in bytes to read or until timeout ms runs out. This node returns the bytes up to and including the CR and LF if it finds them in the string.

Immediate

Waits until this node receives any bytes from those you specify in bytes to read. This node waits the full timeout only if the node receives no bytes. This node returns the number of bytes so far and reports a timeout error only if the function receives no bytes.

Default: Standard

datatype_icon

connection ID in

A network connection refnum that uniquely identifies the TCP connection.

datatype_icon

bytes to read

The number of bytes to read.If you wire a value of zero to this input, the node does not read anything and does not produce an error. Make sure to wire a value greater than 0 to this input if you want to read data.

datatype_icon

timeout ms

Time, in milliseconds, that the node waits to complete before reporting a timeout error. A value of -1 indicates 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.

datatype_icon

data out

The data read from the TCP connection.

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


Recently Viewed Topics