Skip to main content

UDP (Server)

The UDP (Server) output in ArcGIS Velocity sends UDP datagrams through a UDP socket. The output can format data as JSON, GeoJSON, Esri JSON, or delimited text.

Example

The following is an example use case for the output:

A monitoring app listens for UDP datagrams (messages) at the Velocity deployment's public hostname on the port specified for this output. The output sends vehicle location updates to the app in JSON format for real-time display on a dispatch dashboard.

Usage notes

Note the following when working with the output:

  • Velocity supports multiple output data formats for this output. These include JSON, GeoJSON, Esri JSON, and delimited text.

  • Each UDP datagram contains one formatted event. JSON, GeoJSON, and Esri JSON do not add newline separators. Delimited text uses its configured message delimiter, which defaults to \n.

  • Use separate destination ports when the receiving app needs to keep output streams separate.

Parameters

The following table describes the parameters for the output:

Parameter

Description

Data type

Port

(Required)

The destination port on which the receiving app listens for UDP datagrams. Specify a port from 1 through 65535.

Integer

Connection Timeout

(Optional)

The length of time, in seconds, the output attempts to reach the remote UDP server. The default is 60 seconds.

Integer

Considerations and limitations

Consider the following when using the output:

  • Specify a destination port from 1 through 65535. The receiving app listens on that port at the Velocity deployment's public hostname. The output sends to the destination port. It does not bind that port locally.

  • UDP is a connectionless protocol. It does not guarantee delivery, ordering, or protection against duplicates. Successful validation or a test connection does not confirm that a receiving app is available or received the data. Invalid configuration can cause an error, but an unavailable receiver does not necessarily produce an immediate error.