RTI Connext C# API  7.1.0
DataReaderProtocol Class Reference

Configures Subscription.DataReader<T>-specific aspects of the RTPS protocol. More...

Inherits IEquatable< DataReaderProtocol >.

Public Member Functions

DataReaderProtocol With (Action< DataReaderProtocolBuilder > build)
 Creates a new DataReaderProtocol 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 (DataReaderProtocol other)
 Compares for equality More...
 

Properties

Guid VirtualGuid [get]
 The virtual GUID (Global Unique Identifier). More...
 
uint RtpsObjectId [get]
 The RTPS Object ID. More...
 
bool ExpectsInlineQos [get]
 Specifies whether this DataReader expects inline QoS with every sample. More...
 
bool DisablePositiveAcks [get]
 Whether the reader sends positive acknowledgements to writers. More...
 
bool PropagateDisposeOfUnregisteredInstances [get]
 Indicates whether or not an instance can move to the Omg.Dds.Subscription.InstanceState.NotAliveDisposed state without being in the Omg.Dds.Subscription.InstanceState.Alive state. More...
 
bool PropagateUnregisterOfDisposedInstances [get]
 Indicates whether or not an instance can move to the Omg.Dds.Subscription.InstanceState.NotAliveNoWriters state without being in the Omg.Dds.Subscription.InstanceState.Alive state. More...
 
RtpsReliableReaderProtocol RtpsReliableReader [get]
 RTPS protocol-related configuration settings for the RTPS reliable reader associated with a Subscription.DataReader<T>. This parameter only has effect if the reader is configured with ReliabilityKind.Reliable Reliability. More...
 
static DataReaderProtocol Default [get]
 Singleton containing the default value of a DataReaderProtocol More...
 

Detailed Description

Configures Subscription.DataReader<T>-specific aspects of the RTPS protocol.

The full documentation is available in the C API: DDS_DataReaderProtocolQosPolicy::virtual_guid

Member Function Documentation

◆ Equals() [1/2]

bool Equals ( DataReaderProtocol  other)

Compares for equality

◆ Equals() [2/2]

override bool Equals ( object  other)

Compares for equality

◆ GetHashCode()

override int GetHashCode ( )

Gets the hash code

◆ With()

DataReaderProtocol With ( Action< DataReaderProtocolBuilder build)

Creates a new DataReaderProtocol 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 DataReaderProtocol.
Returns
A new DataReaderProtocol with the changes applied by the Action

Property Documentation

◆ Default

DataReaderProtocol Default
staticget

Singleton containing the default value of a DataReaderProtocol

◆ DisablePositiveAcks

bool DisablePositiveAcks
get

Whether the reader sends positive acknowledgements to writers.

The full documentation is available in the C API: DDS_DataReaderProtocolQosPolicy::disable_positive_acks

◆ ExpectsInlineQos

bool ExpectsInlineQos
get

Specifies whether this DataReader expects inline QoS with every sample.

The full documentation is available in the C API: DDS_DataReaderProtocolQosPolicy::expects_inline_qos

◆ PropagateDisposeOfUnregisteredInstances

bool PropagateDisposeOfUnregisteredInstances
get

Indicates whether or not an instance can move to the Omg.Dds.Subscription.InstanceState.NotAliveDisposed state without being in the Omg.Dds.Subscription.InstanceState.Alive state.

The full documentation is available in the C API: DDS_DataReaderProtocolQosPolicy::propagate_dispose_of_unregistered_instances

◆ PropagateUnregisterOfDisposedInstances

bool PropagateUnregisterOfDisposedInstances
get

Indicates whether or not an instance can move to the Omg.Dds.Subscription.InstanceState.NotAliveNoWriters state without being in the Omg.Dds.Subscription.InstanceState.Alive state.

The full documentation is available in the C API: DDS_DataReaderProtocolQosPolicy::propagate_unregister_of_disposed_instances

◆ RtpsObjectId

uint RtpsObjectId
get

The RTPS Object ID.

The full documentation is available in the C API: DDS_DataReaderProtocolQosPolicy::rtps_object_id

◆ RtpsReliableReader

RtpsReliableReaderProtocol RtpsReliableReader
get

RTPS protocol-related configuration settings for the RTPS reliable reader associated with a Subscription.DataReader<T>. This parameter only has effect if the reader is configured with ReliabilityKind.Reliable Reliability.

The full documentation is available in the C API: DDS_DataReaderProtocolQosPolicy::rtps_reliable_reader

◆ VirtualGuid

Guid VirtualGuid
get

The virtual GUID (Global Unique Identifier).

The full documentation is available in the C API: DDS_DataReaderProtocolQosPolicy::virtual_guid