PutTCP

Description:

Sends serialized FlowFiles or Records over TCP to a configurable destination with optional support for TLS

Tags:

remote, egress, put, tcp

Properties:

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, and whether a property supports the NiFi Expression Language.

Display Name	API Name	Default Value	Allowable Values	Description
Hostname	Hostname	localhost		Destination hostname or IP address Supports Expression Language: true (will be evaluated using Environment variables only)
Port	Port			Destination port number Supports Expression Language: true (will be evaluated using Environment variables only)
Max Size of Socket Send Buffer	Max Size of Socket Send Buffer	1 MB		The maximum size of the socket send buffer that should be used. This is a suggestion to the Operating System to indicate how big the socket buffer should be. If this value is set too low, the buffer may fill up before the data can be read, and incoming data will be dropped.
Idle Connection Expiration	Idle Connection Expiration	15 seconds		The amount of time a connection should be held open without being used before closing the connection. A value of 0 seconds will disable this feature. Supports Expression Language: true (will be evaluated using Environment variables only)
Timeout	Timeout	10 seconds		The timeout for connecting to and communicating with the destination. Does not apply to UDP Supports Expression Language: true (will be evaluated using Environment variables only)
Connection Per FlowFile	Connection Per FlowFile	false	true false	Specifies whether to send each FlowFile's content on an individual connection.
SSL Context Service	SSL Context Service		Controller Service API: SSLContextService Implementations: StandardRestrictedSSLContextService StandardSSLContextService	Specifies the SSL Context Service to enable TLS socket communication
Transmission Strategy	Transmission Strategy	FlowFile-oriented	FlowFile-oriented Record-oriented	Specifies the strategy used for reading input FlowFiles and transmitting messages to the destination socket address
Outgoing Message Delimiter	Outgoing Message Delimiter			Specifies the delimiter to use when sending messages out over the same TCP stream. The delimiter is appended to each FlowFile message that is transmitted over the stream so that the receiver can determine when one message ends and the next message begins. Users should ensure that the FlowFile content does not contain the delimiter character to avoid errors. In order to use a new line character you can enter '\n'. For a tab character use '\t'. Finally for a carriage return use '\r'. Supports Expression Language: true (will be evaluated using flow file attributes and Environment variables) This Property is only considered if the [Transmission Strategy] Property has a value of "FlowFile-oriented".
Character Set	Character Set	UTF-8		Specifies the character set of the data being sent. Supports Expression Language: true (will be evaluated using Environment variables only) This Property is only considered if the [Transmission Strategy] Property has a value of "FlowFile-oriented".
Record Reader	Record Reader		Controller Service API: RecordReaderFactory Implementations: WindowsEventLogReader JASN1Reader EBCDICRecordReader YamlTreeReader CiscoEmblemSyslogMessageReader ReaderLookup AvroReader SyslogReader CSVReader GrokReader IPFIXReader ParquetReader JsonTreeReader ExcelReader ScriptedReader JsonPathReader XMLReader Syslog5424Reader CEFReader	Specifies the Controller Service to use for reading Records from input FlowFiles This Property is only considered if the [Transmission Strategy] Property has a value of "Record-oriented".
Record Writer	Record Writer		Controller Service API: RecordSetWriterFactory Implementations: AvroRecordSetWriter XMLRecordSetWriter ParquetRecordSetWriter JsonRecordSetWriter RecordSetWriterLookup CSVRecordSetWriter ScriptedRecordSetWriter FreeFormTextRecordSetWriter	Specifies the Controller Service to use for writing Records to the configured socket address This Property is only considered if the [Transmission Strategy] Property has a value of "Record-oriented".

Relationships:

Name	Description
success	FlowFiles that are sent successfully to the destination are sent out this relationship.
failure	FlowFiles that failed to send to the destination are sent out this relationship.

Reads Attributes:

None specified.

Writes Attributes:

Name	Description
record.count.transmitted	Count of records transmitted to configured destination address

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations: