TCP/IP Client: Setup

Overview

TCP/IP Client: Setup configures host, port, and message framing for a reusable TCP client connection.

Input

Host

string required

Hostname or IP address of the server the client connects to.

Port

integer required

Port number of the target TCP server.

Range: 1 to 65535
Default: 502

Payload Type

string advanced

Encoding used for message payloads.

Values:

• UTF_8 (default) — UTF-8 text
• ASCII — ASCII text
• HEX — hexadecimal

Message Length Method

string required

How complete messages are framed when reading from the server.

Values:

• HEADER_4_BYTES — message length is carried in a 4-byte header
• EXACT_LENGTH — each message has a fixed character count
• DELIMITER — messages end with a delimiter
• MESSAGE_XML — length is determined by XML structure (for example <root><message>...</message></root>)
• MESSAGE_JSON — length is determined by JSON structure (for example {"message": "..."})
• NONE (default) — the first time bytes appear in the receive buffer, the entire buffer is treated as one message (not recommended for production)

Message Length Value

integer required

Fixed character count for each message. Shown when Message Length Method is EXACT_LENGTH.

Range: 1 to 1024
Default: 1

Message Delimiter

string required

Delimiter that marks the end of a message. Shown when Message Length Method is DELIMITER.

Default: \n

Keep Alive

boolean advanced

Keep the TCP connection open after this node finishes. Must be true when using TCP/IP Client Trigger nodes.

Default: true

Reconnect Interval (ms)

integer advanced

Minimum interval in milliseconds before reconnecting to the server.

Range: 100 to 10000
Default: 1000

Output

This node does not provide custom output fields.