|
RTI Connext Java API Version 7.1.0
|
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 the RTI Observability Library. 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... | |
Configures the distribution of event metrics.
Event metrics are provided to the RTI Observability Library 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 the RTI Observability Library so that the liveliness status change can be distributed.
There are three kinds of event metrics:
Constructor.
Copy constructor.
| src | <<in>> Source object. |
| int concurrency_level |
Defines how concurrent the push is of event metrics to the RTI Observability Library.
With a concurrency_level of one, all the event metrics pushed to the RTI Observability Library will be stored in a single queue protected by a single mutex.
With a concurrency_level of 'n', the RTI Observability Library 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 the RTI Observability Library. 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]
| 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 the RTI Observability Library uses com.rti.dds.infrastructure.BuiltinQosProfiles.PROFILE_GENERIC_OBSERVABILITY.
[default] null
| ThreadSettings_t thread = new ThreadSettings_t() |
The settings of the event metric thread.
The event metric thread periodically publishes the event metrics pushed into the RTI Observability Library 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
| 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 the RTI Observability Library.
[default] 5 seconds