MonitoringPeriodicDistributionSettings Class Reference

Configures the distribution of periodic metrics. More...

Inherits Struct.

Public Member Functions
	MonitoringPeriodicDistributionSettings ()
	Constructor. More...
	MonitoringPeriodicDistributionSettings (MonitoringPeriodicDistributionSettings src)
	Copy constructor. More...

Public Attributes
String	datawriter_qos_profile_name
	The fully qualified name of the profile used to configure the com.rti.dds.publication.DataWriter that distributes periodic metrics. More...
ThreadSettings_t	thread = new ThreadSettings_t()
	The settings of the periodic metric thread. More...
Duration_t	polling_period = new Duration_t(5,0)
	Period at which the periodic metric thread polls and publishes the periodic metrics. More...

Detailed Description

Configures the distribution of periodic metrics.

Periodic metrics change often, and they are polled and published periodically by a thread created by the RTI Observability Library.

The RTI Observability Library obtains periodic metrics by polling the current value of periodic statuses such as com.rti.dds.publication.DataWriterProtocolStatus.

Constructor & Destructor Documentation

MonitoringPeriodicDistributionSettings() [1/2]

MonitoringPeriodicDistributionSettings

(

)

Constructor.

MonitoringPeriodicDistributionSettings() [2/2]

MonitoringPeriodicDistributionSettings

(

MonitoringPeriodicDistributionSettings

src

)

Copy constructor.

Parameters

src	<<in>> Source object.

Member Data Documentation

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 periodic metrics.

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

If null (the default value), then the RTI Observability Library uses com.rti.dds.infrastructure.BuiltinQosProfiles.PROFILE_GENERIC_OBSERVABILITY.

[default] null

thread

ThreadSettings_t thread = new ThreadSettings_t()

The settings of the periodic metric thread.

The periodic metric thread periodically polls and publishes periodic event metrics.

The thread runs at the period configured using com.rti.dds.infrastructure.MonitoringPeriodicDistributionSettings.polling_period.

[default] DDS_THREAD_SETTINGS_DEFAULT

polling_period

Duration_t polling_period = new Duration_t(5,0)

Period at which the periodic metric thread polls and publishes the periodic metrics.

[default] 5 seconds

[range] > 0 seconds