Deprecation notice:

Unmaintained and planned for removal in version 2.0

Please consider using one the following alternatives: No alternative components suggested.


Connects over TCP to the provided endpoint(s). Received data will be written as content to the FlowFile


get, fetch, poll, tcp, ingest, source, input


In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Endpoint Listendpoint-listA comma delimited list of the endpoints to connect to. The format should be <server_address>:<port>. Only one server will be connected to at a time, the others will be used as fail overs.
Connection Attempt Countconnection-attempt-timeout3The number of times to try and establish a connection, before using a backup host if available. This same attempt count would be used for a backup host as well.
Reconnect intervalreconnect-interval5 secThe number of seconds to wait before attempting to reconnect to the endpoint.
Receive Buffer Sizereceive-buffer-size16MBThe size of the buffer to receive data in. Default 16384 (16MB).
End of message delimiter byteend-of-message-byte13Byte value which denotes end of message. Must be specified as integer within the valid byte range (-128 thru 127). For example, '13' = Carriage return and '10' = New line. Default '13'.

Dynamic Properties:

Supports Sensitive Dynamic Properties: No

Dynamic Properties allow the user to specify both the name and value of a property.

A FlowFile attribute to setThe value to set it toSets a FlowFile attribute specified by the Dynamic Property's key with the value specified by the Dynamic Property's value
Supports Expression Language: false


PartialThe relationship that all incomplete messages from the endpoint will be sent to. Incomplete message is the message that doesn't end with 'End of message delimiter byte'. This can happen when 'Receive Buffer Size' is smaller then the incoming message. If that happens that the subsequent message that completes the previous incomplete message will also end up in this relationship, after which subsequent 'complete' messages will go to 'success'.
SuccessThe relationship that all sucessful messages from the endpoint will be sent to.

Reads Attributes:

None specified.

Writes Attributes:

source.endpointThe address of the source endpoint the message came from

State management:

This component does not store state.


This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.