PutTCP
Description
Sends serialized FlowFiles or Records over TCP to a configurable destination with optional support for TLS
Tags
egress, put, remote, tcp
Properties
In the list below required Properties are shown with an asterisk (*). Other properties 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, using Environment variables. | |
| Port * | Port | Destination port number Supports Expression Language, using Environment variables. | ||
| 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, using Environment variables. | |
| Timeout | Timeout | 10 seconds | The timeout for connecting to and communicating with the destination. Does not apply to UDP Supports Expression Language, using Environment variables. | |
| Connection Per FlowFile * | Connection Per FlowFile | false |
| Specifies whether to send each FlowFile's content on an individual connection. |
| SSL Context Service | SSL Context Service | Controller Service: SSLContextService Implementations: StandardRestrictedSSLContextService StandardSSLContextService | Specifies the SSL Context Service to enable TLS socket communication | |
| Transmission Strategy * | Transmission Strategy | FlowFile-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, using FlowFile attributes and Environment variables. This property is only considered if:
| ||
| Character Set * | Character Set | UTF-8 | Specifies the character set of the data being sent. Supports Expression Language, using Environment variables. This property is only considered if:
| |
| Record Reader * | Record Reader | Controller Service: RecordReaderFactory Implementations: AvroReader CEFReader CSVReader ExcelReader GrokReader JsonPathReader JsonTreeReader ReaderLookup ScriptedReader Syslog5424Reader SyslogReader WindowsEventLogReader XMLReader YamlTreeReader | Specifies the Controller Service to use for reading Records from input FlowFiles This property is only considered if:
| |
| Record Writer * | Record Writer | Controller Service: RecordSetWriterFactory Implementations: AvroRecordSetWriter CSVRecordSetWriter FreeFormTextRecordSetWriter JsonRecordSetWriter RecordSetWriterLookup ScriptedRecordSetWriter XMLRecordSetWriter | Specifies the Controller Service to use for writing Records to the configured socket address This property is only considered if:
|
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| failure | FlowFiles that failed to send to the destination are sent out this relationship. |
| success | FlowFiles that are sent successfully to the destination are sent out this relationship. |
Reads Attributes
This processor does not read attributes.
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
This component does not specify system resource considerations.