RTI Connext C# API  6.1.0
TopicQueryDispatch Class Reference

Configures the ability of a Publication.DataWriter<T> to publish samples in response to a TopicQueryDispatch. More...

Inherits IEquatable< TopicQueryDispatch >.

Public Member Functions

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

Properties

bool Enable [get]
 Allows this writer to dispatch TopicQueries More...
 
Duration PublicationPeriod [get]
 Sets the periodic interval at which samples are published. More...
 
int SamplesPerPeriod [get]
 Sets the maximum number of samples to publish in each publication_period. More...
 
static TopicQueryDispatch Default [get]
 Singleton containing the default value of a TopicQueryDispatch More...
 

Detailed Description

Configures the ability of a Publication.DataWriter<T> to publish samples in response to a TopicQueryDispatch.

The full documentation is available in the C API: DDS_TopicQueryDispatchQosPolicy

Member Function Documentation

◆ Equals() [1/2]

override bool Equals ( object  other)

Compares for equality

◆ Equals() [2/2]

bool Equals ( TopicQueryDispatch  other)

Compares for equality

◆ GetHashCode()

override int GetHashCode ( )

Gets the hash code

◆ With()

TopicQueryDispatch With ( Action< TopicQueryDispatchBuilder build)

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

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

Property Documentation

◆ Default

TopicQueryDispatch Default
staticget

Singleton containing the default value of a TopicQueryDispatch

◆ Enable

bool Enable
get

Allows this writer to dispatch TopicQueries

The full documentation is available in the C API: DDS_TopicQueryDispatchQosPolicy::enable

◆ PublicationPeriod

Duration PublicationPeriod
get

Sets the periodic interval at which samples are published.

The full documentation is available in the C API: DDS_TopicQueryDispatchQosPolicy::publication_period

◆ SamplesPerPeriod

int SamplesPerPeriod
get

Sets the maximum number of samples to publish in each publication_period.

The full documentation is available in the C API: DDS_TopicQueryDispatchQosPolicy::samples_per_period