TeleFlow Step 0389
From TeleFlow
TCP Receive Step
Receive data from a TCP/IP host (or peer) across a TCP connection
Contents |
Properties
Socket Handle: Socket handle(generated by the TCP Connect step) that specifies the connection to use to receive data.
Variable to receive Message: TeleFlow variable to load with data received across TCP connection. A FATAL error will be generated if this field is blank.
TIMEOUT (ms): Delay before following the TIMEOUT path when no exit condition occurs, such as minimum/maximum length of characters received, or termination string received.
If left blank, the value of @TIMEOUT (default 3000) is used.
Minimum length message to receive: TCP/IP Receive checks after each TCP/IP data packet to see if at least the minimum number of characters has been received, and proceeds to the next step if they have.
If left blank, TCP/IP Receive will continue receiving data until the maximum length of characters is received, the termination string is received, or a timeout occurs.
Length is specified in bytes.
Maximum length message to receive: TCP/IP Receive will proceed to the next step if the maximum number of characters has been received.
If left blank, TCP/IP Receive will continue receiving data until the minimum length of characters is received, the termination string is received, or a timeout occurs.
Length is specified in bytes.
Termination string (define end of record): TCP/IP Receive will stop receiving data and proceed to the next step if the termination string is detected. If left blank, TCP/IP Receive will continue receiving data until the minimum or the maximum length of characters is received, or a timeout occurs
Include termination string in Message: Checking this checkbox indicates that the data loaded into the 'Variable to receive Message' should include the termination string when it occurs.
Hexadecimal representation: Checking this checkbox indicates that the data loaded into the 'Variable to receive Message' should be represented as a sequence of hexadecimal nibbles. Use this setting to receive binary data across your TCP connection.
Note that 2 nibbles represent 1 byte of data.
Uppercase: Checking this checkbox indicates that the hexadecimal nibbles should use UPPER case('A'..'Z').
Notes
If a NULL character is received and hexadecimal representation is not being used, TCP/IP Receive will print a warning in the log and proceed to the next step but no error will be generated; no data other than the null character will be lost.
Action Steps
Time Out: No message received in time specified.
Fail: Unable to receive message, for a cause other than timeout, usually due to an invalid socket or a socket error.
Related Steps
TCP Connect
TCP Disconnect
TCP Send
