RTI Connext Java API Version 7.2.0
MonitoringEventDistributionSettings Class Reference

Configures the distribution of event metrics. More...

Inherits Struct.

Public Member Functions

 MonitoringEventDistributionSettings ()
 Constructor. More...
 
 MonitoringEventDistributionSettings (MonitoringEventDistributionSettings src)
 Copy constructor. More...
 

Public Attributes

int concurrency_level
 Defines how concurrent the push is of event metrics to RTI Monitoring Library 2.0. More...
 
String datawriter_qos_profile_name
 The fully qualified name of the profile used to configure the com.rti.dds.publication.DataWriter that distributes event metrics. More...
 
ThreadSettings_t thread = new ThreadSettings_t()
 The settings of the event metric thread. More...
 
Duration_t publication_period = new Duration_t(1,0)
 Period at which the event metric thread publishes the event metrics that have changed since the last time they were published. More...
 

Detailed Description

Configures the distribution of event metrics.

Event metrics are provided to RTI Monitoring Library 2.0 when they change.

For example, if the liveliness of a com.rti.dds.publication.DataWriter is lost, a matching com.rti.dds.subscription.DataReader will push the new value of com.rti.dds.subscription.LivelinessChangedStatus to RTI Monitoring Library 2.0 so that the liveliness status change can be distributed.

There are three kinds of event metrics:

The event metrics that will be distributed for an observable resource can be configured with com.rti.dds.infrastructure.MonitoringTelemetryData.metrics.

Constructor & Destructor Documentation

◆ MonitoringEventDistributionSettings() [1/2]

◆ MonitoringEventDistributionSettings() [2/2]

Copy constructor.

Parameters
src<<in>> Source object.

Member Data Documentation

◆ concurrency_level

int concurrency_level

Defines how concurrent the push is of event metrics to RTI Monitoring Library 2.0.

With a concurrency_level of one, all the event metrics pushed to RTI Monitoring Library 2.0 will be stored in a single queue protected by a single mutex.

With a concurrency_level of 'n', RTI Monitoring Library 2.0 will create 'n' queues for event metrics, each queue protected by its own mutex. Each resource (e.g, a com.rti.dds.subscription.DataReader) will be associated with one of the queues when the resource is registered with RTI Monitoring Library 2.0. Therefore, all the event metrics for a single resource always go to the same queue.

The event metrics for two resources associated with different event queues can be pushed in parallel. This is why a higher concurrency_level provides more concurrency.

The event metrics added to the event queues are processed by a single thread configured using com.rti.dds.infrastructure.MonitoringEventDistributionSettings.thread.

[default] 5

[range] [1, 100]

◆ datawriter_qos_profile_name

String datawriter_qos_profile_name

The fully qualified name of the profile used to configure the com.rti.dds.publication.DataWriter that distributes event metrics.

The com.rti.dds.publication.DataWriter Topic is com.rti.ndds.utility.MONITORING_EVENT_TOPIC_NAME.

If null (the default value), then RTI Monitoring Library 2.0 uses com.rti.dds.infrastructure.BuiltinQosProfiles.PROFILE_GENERIC_MONITORING2.

[default] null

◆ thread

The settings of the event metric thread.

The event metric thread periodically publishes the event metrics pushed into RTI Monitoring Library 2.0 event metric queues after they change their values.

The thread runs at the period configured using com.rti.dds.infrastructure.MonitoringEventDistributionSettings.publication_period.

[default] DDS_THREAD_SETTINGS_DEFAULT

◆ publication_period

Duration_t publication_period = new Duration_t(1,0)

Period at which the event metric thread publishes the event metrics that have changed since the last time they were published.

With a period of 0 seconds, changes to event metrics will be published immediately after they are pushed into RTI Monitoring Library 2.0.

[default] 5 seconds