UDP (Client)
The UDP (Client) output sends event records as UDP datagrams to a receiving application through a UDP socket. The output can format data as JSON, GeoJSON, Esri JSON, or delimited text. Datagrams are sent using unicast.
Example
The following is an example use case for the output:
A real-time analytic sends temperature and humidity observations from weather stations to a monitoring application using UDP in JSON format.
Usage notes
Keep the following in mind when working with the output:
ArcGIS Velocity supports multiple output data formats when using the UDP (Client) output. The output formats include JSON, GeoJSON, Esri JSON, and delimited text.
Each event is sent in a separate UDP datagram. JSON, GeoJSON, and Esri JSON payloads do not include an added newline separator. Delimited-text payloads use the configured message delimiter, which defaults to
\n. Datagram boundaries, rather than newline characters, identify separate UDP messages.Use separate output connectors and destination ports if the receiving application distinguishes output streams by port. A separate destination port is not required for each feed.
For delimited-text output, configure a field delimiter that matches the receiving application, such as a comma, semicolon, or pipe character.
For delimited-text output, select Write header row to include field names.
Parameters
The following are the parameters for the output:
|
Parameter |
Description |
Data type |
|---|---|---|
|
Host (Required) |
The hostname or IP address to which UDP datagrams are sent. The default is localhost, which refers to the machine running the Velocity analytic, not the computer running the browser. For a receiver on another machine, specify its reachable hostname or IP address. |
String |
|
Port (Required) |
The destination port on which the receiving application listens for UDP datagrams. Specify an integer from 1 through 65535. |
Integer |
|
Output data format (Required) |
The format of the output data. The available formats are Esri JSON, GeoJSON, Delimited text, and JSON. |
Output data format type |
Consideration and limitation
Consider the following when using the output:
Each formatted event must fit within a single UDP datagram. For IPv4, the maximum UDP payload is 65,507 bytes. Network constraints can prevent delivery of large datagrams even when they are below this maximum.
UDP is a connectionless protocol. It does not guarantee delivery, ordering, or protection against duplicates. Test Connection checks the destination settings and local socket configuration. Successful validation or Test Connection does not confirm that a receiving application is available or has received data. An unavailable receiver may not produce an immediate error.