ListenUDP

ListenUDP 2.0.0

Bundle: org.apache.nifi | nifi-standard-nar
Description: Listens for Datagram Packets on a given port. The default behavior produces a FlowFile per datagram, however for higher throughput the Max Batch Size property may be increased to specify the number of datagrams to batch together in a single FlowFile. This processor can be restricted to listening for datagrams from a specific remote host and port by specifying the Sending Host and Sending Host Port properties, otherwise it will listen for datagrams from all hosts and ports.
Tags: ingest, listen, source, udp
Input Requirement: FORBIDDEN
Supports Sensitive Dynamic Properties: false

Properties

Character Set
Specifies the character set of the received data.

Display Name

Character Set

Description

Specifies the character set of the received data.

API Name

Character Set

Default Value

UTF-8

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Local Network Interface
The name of a local network interface to be used to restrict listening to a specific LAN.

Display Name

Local Network Interface

Description

The name of a local network interface to be used to restrict listening to a specific LAN.

API Name

Local Network Interface

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Max Batch Size
The maximum number of messages to add to a single FlowFile. If multiple messages are available, they will be concatenated along with the <Message Delimiter> up to this configured maximum number of messages

Display Name

Max Batch Size

Description

The maximum number of messages to add to a single FlowFile. If multiple messages are available, they will be concatenated along with the <Message Delimiter> up to this configured maximum number of messages

API Name

Max Batch Size

Default Value

1

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Max Size of Message Queue
The maximum size of the internal queue used to buffer messages being transferred from the underlying channel to the processor. Setting this value higher allows more messages to be buffered in memory during surges of incoming messages, but increases the total memory used by the processor.

Display Name

Max Size of Message Queue

Description

The maximum size of the internal queue used to buffer messages being transferred from the underlying channel to the processor. Setting this value higher allows more messages to be buffered in memory during surges of incoming messages, but increases the total memory used by the processor.

API Name

Max Size of Message Queue

Default Value

10000

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Max Size of Socket Buffer
The maximum size of the socket 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.

Display Name

Max Size of Socket Buffer

Description

The maximum size of the socket 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.

API Name

Max Size of Socket Buffer

Default Value

1 MB

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Batching Message Delimiter
Specifies the delimiter to place between messages when multiple messages are bundled together (see <Max Batch Size> property).

Display Name

Batching Message Delimiter

Description

Specifies the delimiter to place between messages when multiple messages are bundled together (see <Max Batch Size> property).

API Name

Message Delimiter

Default Value

\n

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Port
The port to listen on for communication.

Display Name

Port

Description

The port to listen on for communication.

API Name

Port

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Receive Buffer Size
The size of each buffer used to receive messages. Adjust this value appropriately based on the expected size of the incoming messages.

Display Name

Receive Buffer Size

Description

The size of each buffer used to receive messages. Adjust this value appropriately based on the expected size of the incoming messages.

API Name

Receive Buffer Size

Default Value

65507 B

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Sending Host
IP, or name, of a remote host. Only Datagrams from the specified Sending Host Port and this host will be accepted. Improves Performance. May be a system property or an environment variable.

Display Name

Sending Host

Description

IP, or name, of a remote host. Only Datagrams from the specified Sending Host Port and this host will be accepted. Improves Performance. May be a system property or an environment variable.

API Name

Sending Host

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Sending Host Port
Port being used by remote host to send Datagrams. Only Datagrams from the specified Sending Host and this port will be accepted. Improves Performance. May be a system property or an environment variable.

Display Name

Sending Host Port

Description

Port being used by remote host to send Datagrams. Only Datagrams from the specified Sending Host and this port will be accepted. Improves Performance. May be a system property or an environment variable.

API Name

Sending Host Port

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false

Relationships

Name	Description
success	Messages received successfully will be sent out this relationship.

Writes Attributes

Name	Description
udp.sender	The sending host of the messages.
udp.port	The sending port the messages were received.