The base of a typed DataReader<T>. Provides type-independent methods and properties. More...

Inheritance diagram for Rti.Dds.Subscription.AnyDataReader:

Public Member Functions
ReadCondition	CreateReadCondition (DataState state)
	Creates a ReadCondition. More...

QueryCondition	CreateQueryCondition (Filter filter, DataState state)
	Creates a QueryCondition with a filter and a data state. More...

QueryCondition	CreateQueryCondition (Filter filter)
	Creates a QueryCondition with DataState.Any. More...

PublicationBuiltinTopicData	GetMatchedPublicationData (in InstanceHandle publicationHandle)
	Retrieves the information on a publication that is currently "associated" with this DataReader. More...

IEnumerable< PublicationBuiltinTopicData >	GetMatchedPublicationData ()
	Retrieves the information on all publications that are currently "associated" with this DataReader. More...

ParticipantBuiltinTopicData	GetMatchedPublicationParticipantData (in InstanceHandle publicationHandle)
	Retrieves the information on the discovered Domain.DomainParticipant associated with the publication that is currently matching with the DataReader<T> More...

void	AcknowledgeAll ()
	Acknowledges all previously accessed samples. More...

void	AcknowledgeAll (AckResponseData responseData)
	Acknowledges all previously accessed samples with a response. More...

void	AcknowledgeSample (SampleInfo sampleInfo)
	Acknowledges a single sample explicitly. More...

void	AcknowledgeSample (SampleInfo sampleInfo, AckResponseData responseData)
	Acknowledges a single sample explicitly with a response. More...

void	AcknowledgeSample (SampleIdentity sampleIdentity)
	Acknowledges a single sample explicitly. More...

void	AcknowledgeSample (SampleIdentity sampleIdentity, AckResponseData responseData)
	Acknowledges a single sample explicitly with a response. More...

DataReaderProtocolStatus	GetMatchedPublicationDataReaderProtocolStatus (in InstanceHandle publicationHandle)
	Gets the DataReaderProtocolStatus for this reader, per matched publication identified by its InstanceHandle. More...

bool	IsMatchedPublicationAlive (in InstanceHandle publicationHandle)
	Check if a publication currently matched with this reader is alive. More...

void	WaitForHistoricalData (in Duration duration)
	Waits until all "historical" data is received if the reader was configured with a non-Volatile DurabilityKind. More...

abstract LoanedSamples< object >	ReadUntyped ()
	Allows calling DataReader<T>.Read in a context where the type is not known. More...

abstract LoanedSamples< object >	TakeUntyped ()
	Allows calling DataReader<T>.Take in a context where the type is not known. More...

abstract InstanceHandle	LookupInstanceUntyped (object keyHolder)
	Allows calling DataReader<T>.LookupInstance in a context where the type is not known. More...

abstract object	GetKeyValueUntyped (object keyHolder, in InstanceHandle InstanceHandle)
	Allows calling DataReader<T>.GetKeyValue in a context where the type is not known. More...

abstract SelectorUntyped	SelectUntyped ()
	Allows calling DataReader<T>.Select in a context where the type is not known. More...

override void	ResetEvents (StatusMask eventsToRemove=StatusMask.All)
	Stop notifying of certain events and remove their event handlers More...

void	DisposeContainedEntities ()
	Disposes all the entities that were created by this reader. More...

Public Member Functions inherited from Rti.Dds.Core.Entity
void	Enable ()
	Enables this Entity (by default entities are automatically enabled after creation) More...

abstract void	ResetEvents (StatusMask eventsToRemove=StatusMask.All)
	Stop notifying of events and remove their event handlers. The actual events are defined in each derived entity class. More...

EntityLock	Lock ()
	Locks the Entity using its internal lock. More...

void	Dispose ()
	Releases the resources used by this Entity and disposes its contained entities as well (if any). More...

Properties
DataReaderQos	Qos `[get, set]`
	Gets or sets the reader QoS. More...

abstract Subscriber	Subscriber `[get]`
	Returns the Subscriber to which the DataReader belongs. More...

abstract ITopicDescription	TopicDescription `[get]`
	Returns the TopicDescription associated with this DataReader. More...

SubscriptionMatchedStatus	SubscriptionMatchedStatus `[get]`
	Retrieve the StatusMask.SubscriptionMatched status. More...

LivelinessChangedStatus	LivelinessChangedStatus `[get]`
	Retrieve the StatusMask.LivelinessChanged status. More...

RequestedDeadlineMissedStatus	RequestedDeadlineMissedStatus `[get]`
	Retrieve the StatusMask.RequestedDeadlineMissed status. More...

RequestedIncompatibleQosStatus	RequestedIncompatibleQosStatus `[get]`
	Retrieve the StatusMask.RequestedIncompatibleQos status. More...

SampleLostStatus	SampleLostStatus `[get]`
	Retrieve the StatusMask.SampleLost status. More...

SampleRejectedStatus	SampleRejectedStatus `[get]`
	Retrieve the StatusMask.SampleRejected status. More...

DataReaderCacheStatus	DataReaderCacheStatus `[get]`
	Retrieve the StatusMask.DataReaderCache status. More...

DataReaderProtocolStatus	DataReaderProtocolStatus `[get]`
	Retrieve the StatusMask.DataReaderProtocol status. More...

IEnumerable< InstanceHandle >	MatchedPublications `[get]`
	Retrieves the list of publications currently "associated" with this DataReader. More...

SubscriptionMatchedEventHandler	SubscriptionMatched
	Event triggered when the Rti.Dds.Core.Status.StatusMask.SubscriptionMatched status changes More...

DataAvailableEventHandler	DataAvailable
	Event triggered when the Rti.Dds.Core.Status.StatusMask.DataAvailable status changes More...

LivelinessChangedEventHandler	LivelinessChanged
	Event triggered when the Rti.Dds.Core.Status.StatusMask.LivelinessChanged status changes More...

RequestedDeadlineMissedEventHandler	RequestedDeadlineMissed
	Event triggered when the Rti.Dds.Core.Status.StatusMask.RequestedDeadlineMissed status changes More...

RequestedIncompatibleQosEventHandler	RequestedIncompatibleQos
	Event triggered when the Rti.Dds.Core.Status.StatusMask.RequestedIncompatibleQos status changes More...

SampleLostEventHandler	SampleLost
	Event triggered when the Rti.Dds.Core.Status.StatusMask.SampleLost status changes More...

SampleRejectedEventHandler	SampleRejected
	Event triggered when the Rti.Dds.Core.Status.StatusMask.SampleRejected status changes More...

Properties inherited from Rti.Dds.Core.Entity
InstanceHandle	InstanceHandle `[get]`
	Gets the InstanceHandle that identifies this Entity More...

StatusMask	StatusChanges `[get]`
	Retrieves the list of communication statuses in this Entity that are triggered. More...

StatusCondition	StatusCondition `[get]`
	Gets the StatusCondition associated with this Entity. More...

bool	Enabled `[get]`
	Indicates whether this Entity is enabled. More...

bool	Disposed `[get]`
	Indicates whether this Entity has already been disposed. More...

Detailed Description

The base of a typed DataReader<T>. Provides type-independent methods and properties.

Member Function Documentation

◆ CreateReadCondition()

ReadCondition Rti.Dds.Subscription.AnyDataReader.CreateReadCondition ( DataState state )

Creates a ReadCondition.

The full documentation is available in the C API: DDS_DataReader_create_readcondition

◆ CreateQueryCondition() [1/2]

QueryCondition Rti.Dds.Subscription.AnyDataReader.CreateQueryCondition	(	Filter	filter,
		DataState	state
	)

Creates a QueryCondition with a filter and a data state.

The full documentation is available in the C API: DDS_DataReader_create_querycondition

◆ CreateQueryCondition() [2/2]

QueryCondition Rti.Dds.Subscription.AnyDataReader.CreateQueryCondition ( Filter filter )

Creates a QueryCondition with DataState.Any.

The full documentation is available in the C API: DDS_DataReader_create_querycondition

◆ GetMatchedPublicationData() [1/2]

PublicationBuiltinTopicData Rti.Dds.Subscription.AnyDataReader.GetMatchedPublicationData ( in InstanceHandle publicationHandle )

Retrieves the information on a publication that is currently "associated" with this DataReader.

The full documentation is available in the C API: DDS_DataReader_get_matched_publication_data

◆ GetMatchedPublicationData() [2/2]

IEnumerable< PublicationBuiltinTopicData > Rti.Dds.Subscription.AnyDataReader.GetMatchedPublicationData ( )

inline

Retrieves the information on all publications that are currently "associated" with this DataReader.

◆ GetMatchedPublicationParticipantData()

ParticipantBuiltinTopicData Rti.Dds.Subscription.AnyDataReader.GetMatchedPublicationParticipantData ( in InstanceHandle publicationHandle )

Retrieves the information on the discovered Domain.DomainParticipant associated with the publication that is currently matching with the DataReader<T>

The full documentation is available in the C API: DDS_DataReader_get_matched_publication_participant_data

◆ AcknowledgeAll() [1/2]

void Rti.Dds.Subscription.AnyDataReader.AcknowledgeAll ( )

Acknowledges all previously accessed samples.

The full documentation is available in the C API: DDS_DataReader_acknowledge_all

◆ AcknowledgeAll() [2/2]

void Rti.Dds.Subscription.AnyDataReader.AcknowledgeAll ( AckResponseData responseData )

Acknowledges all previously accessed samples with a response.

The full documentation is available in the C API: DDS_DataReader_acknowledge_all_w_response

◆ AcknowledgeSample() [1/4]

void Rti.Dds.Subscription.AnyDataReader.AcknowledgeSample ( SampleInfo sampleInfo )

Acknowledges a single sample explicitly.

The full documentation is available in the C API: DDS_DataReader_acknowledge_sample

◆ AcknowledgeSample() [2/4]

void Rti.Dds.Subscription.AnyDataReader.AcknowledgeSample	(	SampleInfo	sampleInfo,
		AckResponseData	responseData
	)

Acknowledges a single sample explicitly with a response.

The full documentation is available in the C API: DDS_DataReader_acknowledge_sample_w_response

◆ AcknowledgeSample() [3/4]

void Rti.Dds.Subscription.AnyDataReader.AcknowledgeSample ( SampleIdentity sampleIdentity )

Acknowledges a single sample explicitly.

The SampleIdentity from a specific LoanedSample<T> can be obtained from its SampleInfo. This method is equivalent to AcknowledgeSample(SampleInfo), but can be used with a previously stored SampleIdentity when the specific LoanedSample<T> has already been disposed.

◆ AcknowledgeSample() [4/4]

void Rti.Dds.Subscription.AnyDataReader.AcknowledgeSample	(	SampleIdentity	sampleIdentity,
		AckResponseData	responseData
	)

Acknowledges a single sample explicitly with a response.

The SampleIdentity from a specific LoanedSample<T> can be obtained from its SampleInfo. This method is equivalent to AcknowledgeSample(SampleInfo, AckResponseData), but can be used with a previously stored SampleIdentity when the specific LoanedSample<T> has already been disposed.

◆ GetMatchedPublicationDataReaderProtocolStatus()

DataReaderProtocolStatus Rti.Dds.Subscription.AnyDataReader.GetMatchedPublicationDataReaderProtocolStatus ( in InstanceHandle publicationHandle )

Gets the DataReaderProtocolStatus for this reader, per matched publication identified by its InstanceHandle.

The full documentation is available in the C API: DDS_DataReader_get_matched_publication_datareader_protocol_status

◆ IsMatchedPublicationAlive()

bool Rti.Dds.Subscription.AnyDataReader.IsMatchedPublicationAlive ( in InstanceHandle publicationHandle )

Check if a publication currently matched with this reader is alive.

The full documentation is available in the C API: DDS_DataReader_is_matched_publication_alive

◆ WaitForHistoricalData()

void Rti.Dds.Subscription.AnyDataReader.WaitForHistoricalData ( in Duration duration )

Waits until all "historical" data is received if the reader was configured with a non-Volatile DurabilityKind.

The full documentation is available in the C API: DDS_DataReader_wait_for_historical_data

◆ ReadUntyped()

abstract LoanedSamples< object > Rti.Dds.Subscription.AnyDataReader.ReadUntyped ( )

pure virtual

Allows calling DataReader<T>.Read in a context where the type is not known.

Returns: A collection equivalent to the one returned by DataReader<T>.Read, but one where the declared type of the data is object, instead of a concrete T.

Implemented in Rti.Dds.Subscription.DataReader< T >.

◆ TakeUntyped()

abstract LoanedSamples< object > Rti.Dds.Subscription.AnyDataReader.TakeUntyped ( )

pure virtual

Allows calling DataReader<T>.Take in a context where the type is not known.

Returns: A collection equivalent to the one returned by DataReader<T>.Take, but one where the declared type of the data is object, instead of a concrete T.

Implemented in Rti.Dds.Subscription.DataReader< T >.

◆ LookupInstanceUntyped()

abstract InstanceHandle Rti.Dds.Subscription.AnyDataReader.LookupInstanceUntyped ( object keyHolder )

pure virtual

Allows calling DataReader<T>.LookupInstance in a context where the type is not known.

Returns: The InstanceHandle corresponding to the provided keyholder. The runtime type of the keyholder must match that of the actual DataReader<T> otherwise this operation throws InvalidCastException.

Implemented in Rti.Dds.Subscription.DataReader< T >.

◆ GetKeyValueUntyped()

abstract object Rti.Dds.Subscription.AnyDataReader.GetKeyValueUntyped	(	object	keyHolder,
		in InstanceHandle	InstanceHandle
	)

pure virtual

Allows calling DataReader<T>.GetKeyValue in a context where the type is not known.

Returns: The key values corresponding to the provided instance handle.

◆ SelectUntyped()

abstract SelectorUntyped Rti.Dds.Subscription.AnyDataReader.SelectUntyped ( )

pure virtual

Allows calling DataReader<T>.Select in a context where the type is not known.

Returns: A Selector<T>, but one where the declared type of the data is object, instead of a concrete T.

Implemented in Rti.Dds.Subscription.DataReader< T >.

◆ ResetEvents()

override void Rti.Dds.Subscription.AnyDataReader.ResetEvents ( StatusMask eventsToRemove = StatusMask.All )

inlinevirtual

Stop notifying of certain events and remove their event handlers

Parameters

eventsToRemove Selects which events will stop receiving notifications. Use StatusMask.All to remove all event handlers.

Implements Rti.Dds.Core.Entity.

◆ DisposeContainedEntities()

void Rti.Dds.Subscription.AnyDataReader.DisposeContainedEntities ( )

inline

Disposes all the entities that were created by this reader.

The full documentation is available in the C API: DDS_DataReader_delete_contained_entities

Property Documentation

◆ Qos

DataReaderQos Rti.Dds.Subscription.AnyDataReader.Qos

getset

Gets or sets the reader QoS.

The full documentation is available in the C API: DDS_DataReader_set_qos

◆ Subscriber

abstract Subscriber Rti.Dds.Subscription.AnyDataReader.Subscriber

get

Returns the Subscriber to which the DataReader belongs.

The full documentation is available in the C API: DDS_DataReader_get_subscriber

◆ TopicDescription

abstract ITopicDescription Rti.Dds.Subscription.AnyDataReader.TopicDescription

get

Returns the TopicDescription associated with this DataReader.

The full documentation is available in the C API: DDS_DataReader_get_topicdescription

◆ SubscriptionMatchedStatus

SubscriptionMatchedStatus Rti.Dds.Subscription.AnyDataReader.SubscriptionMatchedStatus

get

Retrieve the StatusMask.SubscriptionMatched status.

The full documentation is available in the C API: DDS_DataReader_get_subscription_matched_status

◆ LivelinessChangedStatus

LivelinessChangedStatus Rti.Dds.Subscription.AnyDataReader.LivelinessChangedStatus

get

Retrieve the StatusMask.LivelinessChanged status.

The full documentation is available in the C API: DDS_DataReader_get_liveliness_changed_status

◆ RequestedDeadlineMissedStatus

RequestedDeadlineMissedStatus Rti.Dds.Subscription.AnyDataReader.RequestedDeadlineMissedStatus

get

Retrieve the StatusMask.RequestedDeadlineMissed status.

The full documentation is available in the C API: DDS_DataReader_get_requested_deadline_missed_status

◆ RequestedIncompatibleQosStatus

RequestedIncompatibleQosStatus Rti.Dds.Subscription.AnyDataReader.RequestedIncompatibleQosStatus

get

Retrieve the StatusMask.RequestedIncompatibleQos status.

The full documentation is available in the C API: DDS_DataReader_get_requested_incompatible_qos_status

◆ SampleLostStatus

SampleLostStatus Rti.Dds.Subscription.AnyDataReader.SampleLostStatus

get

Retrieve the StatusMask.SampleLost status.

The full documentation is available in the C API: DDS_DataReader_get_sample_lost_status

◆ SampleRejectedStatus

SampleRejectedStatus Rti.Dds.Subscription.AnyDataReader.SampleRejectedStatus

get

Retrieve the StatusMask.SampleRejected status.

The full documentation is available in the C API: DDS_DataReader_get_sample_rejected_status

◆ DataReaderCacheStatus

DataReaderCacheStatus Rti.Dds.Subscription.AnyDataReader.DataReaderCacheStatus

get

Retrieve the StatusMask.DataReaderCache status.

The full documentation is available in the C API: DDS_DataReader_get_datareader_cache_status

◆ DataReaderProtocolStatus

DataReaderProtocolStatus Rti.Dds.Subscription.AnyDataReader.DataReaderProtocolStatus

get

Retrieve the StatusMask.DataReaderProtocol status.

The full documentation is available in the C API: DDS_DataReader_get_datareader_protocol_status

◆ MatchedPublications

IEnumerable<InstanceHandle> Rti.Dds.Subscription.AnyDataReader.MatchedPublications

get

Retrieves the list of publications currently "associated" with this DataReader.

The full documentation is available in the C API: DDS_DataReader_get_matched_publications

◆ SubscriptionMatched

SubscriptionMatchedEventHandler Rti.Dds.Subscription.AnyDataReader.SubscriptionMatched

addremove

Event triggered when the Rti.Dds.Core.Status.StatusMask.SubscriptionMatched status changes

◆ DataAvailable

DataAvailableEventHandler Rti.Dds.Subscription.AnyDataReader.DataAvailable

addremove

Event triggered when the Rti.Dds.Core.Status.StatusMask.DataAvailable status changes

◆ LivelinessChanged

LivelinessChangedEventHandler Rti.Dds.Subscription.AnyDataReader.LivelinessChanged

addremove

Event triggered when the Rti.Dds.Core.Status.StatusMask.LivelinessChanged status changes

◆ RequestedDeadlineMissed

RequestedDeadlineMissedEventHandler Rti.Dds.Subscription.AnyDataReader.RequestedDeadlineMissed

addremove

Event triggered when the Rti.Dds.Core.Status.StatusMask.RequestedDeadlineMissed status changes

◆ RequestedIncompatibleQos

RequestedIncompatibleQosEventHandler Rti.Dds.Subscription.AnyDataReader.RequestedIncompatibleQos

addremove

Event triggered when the Rti.Dds.Core.Status.StatusMask.RequestedIncompatibleQos status changes

◆ SampleLost

SampleLostEventHandler Rti.Dds.Subscription.AnyDataReader.SampleLost

addremove

Event triggered when the Rti.Dds.Core.Status.StatusMask.SampleLost status changes

◆ SampleRejected

SampleRejectedEventHandler Rti.Dds.Subscription.AnyDataReader.SampleRejected

addremove

Event triggered when the Rti.Dds.Core.Status.StatusMask.SampleRejected status changes

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ CreateReadCondition()

◆ CreateQueryCondition() [1/2]

◆ CreateQueryCondition() [2/2]

◆ GetMatchedPublicationData() [1/2]

◆ GetMatchedPublicationData() [2/2]

◆ GetMatchedPublicationParticipantData()

◆ AcknowledgeAll() [1/2]

◆ AcknowledgeAll() [2/2]

◆ AcknowledgeSample() [1/4]

◆ AcknowledgeSample() [2/4]

◆ AcknowledgeSample() [3/4]

◆ AcknowledgeSample() [4/4]

◆ GetMatchedPublicationDataReaderProtocolStatus()

◆ IsMatchedPublicationAlive()

◆ WaitForHistoricalData()

◆ ReadUntyped()

◆ TakeUntyped()

◆ LookupInstanceUntyped()

◆ GetKeyValueUntyped()

◆ SelectUntyped()

◆ ResetEvents()

◆ DisposeContainedEntities()

Property Documentation

◆ Qos

◆ Subscriber

◆ TopicDescription

◆ SubscriptionMatchedStatus

◆ LivelinessChangedStatus

◆ RequestedDeadlineMissedStatus

◆ RequestedIncompatibleQosStatus

◆ SampleLostStatus

◆ SampleRejectedStatus

◆ DataReaderCacheStatus

◆ DataReaderProtocolStatus

◆ MatchedPublications

◆ SubscriptionMatched

◆ DataAvailable

◆ LivelinessChanged

◆ RequestedDeadlineMissed

◆ RequestedIncompatibleQos

◆ SampleLost

◆ SampleRejected