UDP Client Adapter
The UDP Client Adapter connects to a UDP Server to receive a data stream. The adapter passes the data stream to a parser. The parser parses the data stream into data tokens, which the mapping function converts into events.
The following table describes the UDP Client Adapter parameters:
UDP Client Adapter configuration parameters
Name of the adapter instance The instance name is the first entry in the adapter configuration and must be enclosed in square brackets.
To run more than one instance of the adapter, specify a unique name and configuration for each adapter instance.
|Maximum time a connection will stay active |
After the period of time specified in
|Type of adapter in use |
Valid value: MA::Adapter::UdpClient
|Maximum time, in seconds, after which new data is expected to have arrived. |
After this time, the connection is considered unsuccessful.
Default: 15 The UDP Client Adapter sends packets at regular intervals specified by the sum of the periods specified by the
Local IP address on a computer with multiple network interfaces to which the UDP Client Adapter binds
Do not specify localhost, 127.0.0.1, or INADDR_ANY as a value for this parameter.
|Local port number to which the UDP Client Adapter binds Default: ANY|
|Name of the MAP file used to generate events from the tokenized data |
Parser instance that must be used to parse and tokenize the client input stream
|Host name or IP address of the remote computer to which the UDP Client Adapter is connecting|
|Port on the remote computer to which the UDP Client Adapter is connecting|
Interval, in seconds, at which:
|String that is sent after a connection is established|
The following figure shows a sample UDP Client Adapter configuration, as it would appear in the mcxa.conf file.
Sample UDP client Adapter configuration
[MyUDPClient] Engine = MA::Adapter::UdpClient MapFile = mcudpclt.map RemoteHost = test.bmc.com RemotePort = 13 Parser = SeparatorParser
All adapter errors are logged as events. Optionally, you can enable tracing by setting the tracing parameters in the global section of the mcxa.conf file. For more information, see
The UDP Client Adapter can generate an
ERR_UDP_INIT error, which indicates that an error occurred when receiving data from the server. For more information, see the event that is created for this error.