RTI Connext C# API Version 7.2.0
Rti.Dds.Core.Policy.MonitoringPeriodicDistributionSettings Class Reference

Configures the distribution of periodic metrics More...

Inherits IEquatable< MonitoringPeriodicDistributionSettings >.

Public Member Functions

MonitoringPeriodicDistributionSettings With (Action< MonitoringPeriodicDistributionSettingsBuilder > build)
 Creates a new MonitoringPeriodicDistributionSettings with a set of changes specified in an Action More...
 
override bool Equals (object other)
 Compares for equality More...
 
override int GetHashCode ()
 Gets the hash code More...
 
bool Equals (MonitoringPeriodicDistributionSettings other)
 Compares for equality More...
 

Properties

string DataWriterQosProfileName [get]
 The fully qualified name of the profile used to configure the configure the DataWriter that distributes periodic metrics More...
 
ThreadSettings Thread [get]
 The settings of the periodic metrics thread More...
 
Duration PollingPeriod [get]
 Period at which the periodic metric thread polls and publishes the periodic metrics More...
 
static MonitoringPeriodicDistributionSettings Default [get]
 Singleton containing the default value of a MonitoringPeriodicDistributionSettings More...
 

Detailed Description

Configures the distribution of periodic metrics

The full documentation is available in the C API: DDS_MonitoringPeriodicDistributionSettings

Member Function Documentation

◆ With()

MonitoringPeriodicDistributionSettings Rti.Dds.Core.Policy.MonitoringPeriodicDistributionSettings.With ( Action< MonitoringPeriodicDistributionSettingsBuilder build)
inline

Creates a new MonitoringPeriodicDistributionSettings with a set of changes specified in an Action

Parameters
buildAn Action (typically a lambda function) that receives a modifiable object with the values of this Monitoring
Returns
A new Monitoring with the changes applied by the Action

◆ Equals() [1/2]

override bool Rti.Dds.Core.Policy.MonitoringPeriodicDistributionSettings.Equals ( object  other)

Compares for equality

◆ GetHashCode()

override int Rti.Dds.Core.Policy.MonitoringPeriodicDistributionSettings.GetHashCode ( )
inline

Gets the hash code

◆ Equals() [2/2]

bool Rti.Dds.Core.Policy.MonitoringPeriodicDistributionSettings.Equals ( MonitoringPeriodicDistributionSettings  other)
inline

Compares for equality

Property Documentation

◆ DataWriterQosProfileName

string Rti.Dds.Core.Policy.MonitoringPeriodicDistributionSettings.DataWriterQosProfileName
get

The fully qualified name of the profile used to configure the configure the DataWriter that distributes periodic metrics

The full documentation is available in the C API: DDS_MonitoringPeriodicDistributionSettings_datawriter_qos_profile_name

◆ Thread

ThreadSettings Rti.Dds.Core.Policy.MonitoringPeriodicDistributionSettings.Thread
get

The settings of the periodic metrics thread

The full documentation is available in the C API: DDS_MonitoringPeriodicDistributionSettings_thread

◆ PollingPeriod

Duration Rti.Dds.Core.Policy.MonitoringPeriodicDistributionSettings.PollingPeriod
get

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

The full documentation is available in the C API: DDS_MonitoringPeriodicDistributionSettings_polling_period

◆ Default

MonitoringPeriodicDistributionSettings Rti.Dds.Core.Policy.MonitoringPeriodicDistributionSettings.Default
staticget

Singleton containing the default value of a MonitoringPeriodicDistributionSettings