Skip to main content

PutUDP

Description

The PutUDP processor receives a FlowFile and packages the FlowFile content into a single UDP datagram packet which is then transmitted to the configured UDP server. The user must ensure that the FlowFile content being fed to this processor is not larger than the maximum size for the underlying UDP transport. The maximum transport size will vary based on the platform setup but is generally just under 64KB. FlowFiles will be marked as failed if their content is larger than the maximum transport size.

Tags

egress, put, remote, udp

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 NameAPI NameDefault ValueAllowable ValuesDescription
Hostname *HostnamelocalhostDestination hostname or IP address

Supports Expression Language, using Environment variables.
Port *PortDestination port number

Supports Expression Language, using Environment variables.
Max Size of Socket Send Buffer *Max Size of Socket Send Buffer1 MBThe 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 Expiration15 secondsThe 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.
TimeoutTimeout10 secondsThe timeout for connecting to and communicating with the destination. Does not apply to UDP

Supports Expression Language, using Environment variables.

Dynamic Properties

This component does not support dynamic properties.

Relationships

NameDescription
failureFlowFiles that failed to send to the destination are sent out this relationship.
successFlowFiles that are sent successfully to the destination are sent out this relationship.

Reads Attributes

This processor does not read attributes.

Writes Attributes

This processor does not write attributes.

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.

See Also

ListenUDP, PutTCP