org.opennms.netmgt.telemetry.ipc

Interface ProtocolDefinition

All Known Implementing Classes:

MapBasedProtocolDef, Protocol

public interface ProtocolDefinition

Protocol configuration details that are required by both OpenNMS and Minion.

Method Summary

Modifier and Type	Method and Description
Optional<Integer>	getBatchIntervalMs() Messages are aggregated in batches before being dispatched.
Optional<Integer>	getBatchSize() Messages are aggregated in batches before being dispatched.
String	getName() The name of the protocol.
Optional<Integer>	getNumThreads() Number of threads used for consuming/dispatching messages.
Optional<Integer>	getQueueSize() Maximum number of messages to keep in memory while waiting to be dispatched.

Method Detail

getName

String getName()

The name of the protocol. This is used as a suffix for any associated queues that are created and must be the same on both OpenNMS and Minion.

Returns:

the protocol name

getNumThreads

Optional<Integer> getNumThreads()

Number of threads used for consuming/dispatching messages.

Returns:

the number of threads

getBatchSize

Optional<Integer> getBatchSize()

Messages are aggregated in batches before being dispatched. When the batch reaches this size, it will be dispatched.

Returns:

the batch size

getBatchIntervalMs

Optional<Integer> getBatchIntervalMs()

Messages are aggregated in batches before being dispatched. When the batch has been created for longer than this interval (ms) it will be dispatched, regardless of the current size.

Returns:

the batch interval

getQueueSize

Optional<Integer> getQueueSize()

Maximum number of messages to keep in memory while waiting to be dispatched.

Returns:

the queue size