DataReaders

DDSDataReader entity and associated elements More...

Modules
	Read Conditions
	DDSReadCondition and associated elements
	Query Conditions
	DDSQueryCondition and associated elements
	Topic Queries
	DDSTopicQuery and associated elements.

Classes
struct	DDS_RequestedDeadlineMissedStatus
	DDS_REQUESTED_DEADLINE_MISSED_STATUS More...
struct	DDS_LivelinessChangedStatus
	DDS_LIVELINESS_CHANGED_STATUS More...
struct	DDS_RequestedIncompatibleQosStatus
	DDS_REQUESTED_INCOMPATIBLE_QOS_STATUS More...
struct	DDS_SampleLostStatus
	DDS_SAMPLE_LOST_STATUS More...
struct	DDS_SampleRejectedStatus
	DDS_SAMPLE_REJECTED_STATUS More...
struct	DDS_SubscriptionMatchedStatus
	DDS_SUBSCRIPTION_MATCHED_STATUS More...
struct	DDS_DataReaderCacheStatus
	<<extension>> The status of the reader's cache. More...
struct	DDS_DataReaderProtocolStatus
	<<extension>> The status of a reader's internal protocol related metrics, like the number of samples received, filtered, rejected; and status of wire protocol traffic. More...
struct	DDS_DataReaderQos
	QoS policies supported by a DDSDataReader entity. More...
class	FooDataReader
	<<interface>> <<generic>> User data type-specific data reader. More...
class	DDSDataReaderSeq
	Declares IDL sequence < DDSDataReader > . More...
class	DDSDataReaderListener
	<<interface>> DDSListener for reader status. More...
class	DDSDataReader
	<<interface>> Allows the application to: (1) declare the data it wishes to receive (i.e. make a subscription) and (2) access the data received by the attached DDSSubscriber. More...

Enumerations
enum	DDS_SampleLostStatusKind {   DDS_NOT_LOST,   DDS_LOST_BY_WRITER,   DDS_LOST_BY_INSTANCES_LIMIT,   DDS_LOST_BY_REMOTE_WRITERS_PER_INSTANCE_LIMIT,   DDS_LOST_BY_INCOMPLETE_COHERENT_SET,   DDS_LOST_BY_LARGE_COHERENT_SET,   DDS_LOST_BY_SAMPLES_PER_REMOTE_WRITER_LIMIT,   DDS_LOST_BY_VIRTUAL_WRITERS_LIMIT,   DDS_LOST_BY_REMOTE_WRITERS_PER_SAMPLE_LIMIT,   DDS_LOST_BY_AVAILABILITY_WAITING_TIME,   DDS_LOST_BY_REMOTE_WRITER_SAMPLES_PER_VIRTUAL_QUEUE_LIMIT,   DDS_LOST_BY_OUT_OF_MEMORY }
	<<extension>> Kinds of reasons why a sample was lost. More...
enum	DDS_SampleRejectedStatusKind {   DDS_NOT_REJECTED,   DDS_REJECTED_BY_INSTANCES_LIMIT,   DDS_REJECTED_BY_SAMPLES_LIMIT,   DDS_REJECTED_BY_SAMPLES_PER_INSTANCE_LIMIT,   DDS_REJECTED_BY_REMOTE_WRITERS_LIMIT,   DDS_REJECTED_BY_REMOTE_WRITERS_PER_INSTANCE_LIMIT,   DDS_REJECTED_BY_SAMPLES_PER_REMOTE_WRITER_LIMIT,   DDS_REJECTED_BY_VIRTUAL_WRITERS_LIMIT,   DDS_REJECTED_BY_REMOTE_WRITERS_PER_SAMPLE_LIMIT,   DDS_REJECTED_BY_REMOTE_WRITER_SAMPLES_PER_VIRTUAL_QUEUE_LIMIT }
	Kinds of reasons for rejecting a sample. More...

Functions
DDS_Boolean	DDS_DataReaderQos_equals (const struct DDS_DataReaderQos *self, const struct DDS_DataReaderQos *other)
	Compares two DDS_DataReaderQos for equality.

Detailed Description

DDSDataReader entity and associated elements

Enumeration Type Documentation

enum DDS_SampleLostStatusKind

<<extension>> Kinds of reasons why a sample was lost.

Enumerator:

DDS_NOT_LOST	The sample was not lost. This constant is an extension to the DDS standard. See Also DDS_ResourceLimitsQosPolicy
DDS_LOST_BY_WRITER	A DDSDataWriter removed the sample before being received by the DDSDataReader. This constant is an extension to the DDS standard.
DDS_LOST_BY_INSTANCES_LIMIT	A resource limit on the number of instances was reached. This constant is an extension to the DDS standard. See Also DDS_ResourceLimitsQosPolicy
DDS_LOST_BY_REMOTE_WRITERS_PER_INSTANCE_LIMIT	A resource limit on the number of remote writers for a single instance from which a DDSDataReader may read was reached. This constant is an extension to the DDS standard. See Also DDS_DataReaderResourceLimitsQosPolicy
DDS_LOST_BY_INCOMPLETE_COHERENT_SET	A sample is lost because it is part of an incomplete coherent set. This constant is an extension to the DDS standard.
DDS_LOST_BY_LARGE_COHERENT_SET	A sample is lost because it is part of a large coherent set. This constant is an extension to the DDS standard.
DDS_LOST_BY_SAMPLES_PER_REMOTE_WRITER_LIMIT	A resource limit on the number of samples from a given remote writer that a DDSDataReader may store was reached. This constant is an extension to the DDS standard. See Also DDS_DataReaderResourceLimitsQosPolicy
DDS_LOST_BY_VIRTUAL_WRITERS_LIMIT	A resource limit on the number of virtual writers from which a DDSDataReader may read was reached. This constant is an extension to the DDS standard. See Also DDS_DataReaderResourceLimitsQosPolicy
DDS_LOST_BY_REMOTE_WRITERS_PER_SAMPLE_LIMIT	A resource limit on the number of remote writers per sample was reached. This constant is an extension to the DDS standard. See Also DDS_DataReaderResourceLimitsQosPolicy
DDS_LOST_BY_AVAILABILITY_WAITING_TIME	DDS_AvailabilityQosPolicy::max_data_availability_waiting_time expired. This constant is an extension to the DDS standard. See Also DDS_DataReaderResourceLimitsQosPolicy
DDS_LOST_BY_REMOTE_WRITER_SAMPLES_PER_VIRTUAL_QUEUE_LIMIT	A resource limit on the number of samples published by a remote writer on behalf of a virtual writer that a DDSDataReader may store was reached. This constant is an extension to the DDS standard. See Also DDS_DataReaderResourceLimitsQosPolicy
DDS_LOST_BY_OUT_OF_MEMORY	A sample was lost because there was not enough memory to store the sample. This constant is an extension to the DDS standard. See Also DDS_DataReaderResourceLimitsQosPolicy

enum DDS_SampleRejectedStatusKind

Kinds of reasons for rejecting a sample.

Enumerator:

DDS_NOT_REJECTED	Samples are never rejected. See Also DDS_DataReaderResourceLimitsQosPolicy
DDS_REJECTED_BY_INSTANCES_LIMIT	A resource limit on the number of instances was reached. See Also DDS_DataReaderResourceLimitsQosPolicy
DDS_REJECTED_BY_SAMPLES_LIMIT	A resource limit on the number of samples was reached. See Also DDS_DataReaderResourceLimitsQosPolicy
DDS_REJECTED_BY_SAMPLES_PER_INSTANCE_LIMIT	A resource limit on the number of samples per instance was reached. See Also ResourceLimitsQosPolicy
DDS_REJECTED_BY_REMOTE_WRITERS_LIMIT	A resource limit on the number of remote writers from which a DDSDataReader may read was reached. This constant is an extension to the DDS standard. See Also DDS_DataReaderResourceLimitsQosPolicy
DDS_REJECTED_BY_REMOTE_WRITERS_PER_INSTANCE_LIMIT	A resource limit on the number of remote writers for a single instance from which a DDSDataReader may read was reached. This constant is an extension to the DDS standard. See Also DDS_DataReaderResourceLimitsQosPolicy
DDS_REJECTED_BY_SAMPLES_PER_REMOTE_WRITER_LIMIT	A resource limit on the number of samples from a given remote writer that a DDSDataReader may store was reached. This constant is an extension to the DDS standard. See Also DDS_DataReaderResourceLimitsQosPolicy
DDS_REJECTED_BY_VIRTUAL_WRITERS_LIMIT	A resource limit on the number of virtual writers from which a DDSDataReader may read was reached. This constant is an extension to the DDS standard. See Also DDS_DataReaderResourceLimitsQosPolicy
DDS_REJECTED_BY_REMOTE_WRITERS_PER_SAMPLE_LIMIT	A resource limit on the number of remote writers per sample was reached. This constant is an extension to the DDS standard. See Also DDS_DataReaderResourceLimitsQosPolicy
DDS_REJECTED_BY_REMOTE_WRITER_SAMPLES_PER_VIRTUAL_QUEUE_LIMIT	A resource limit on the number of samples published by a remote writer on behalf of a virtual writer that a DDSDataReader may store was reached. This constant is an extension to the DDS standard. See Also DDS_DataReaderResourceLimitsQosPolicy

Function Documentation

DDS_Boolean DDS_DataReaderQos_equals	(	const struct DDS_DataReaderQos *	self,
		const struct DDS_DataReaderQos *	other
	)

Compares two DDS_DataReaderQos for equality.

Parameters

self	<<in>> This DataReaderQos.
other	<<in>> The other DataReaderQos to be compared with this DataReaderQos.

Returns

DDS_BOOLEAN_TRUE if the two Qos objects are equal or DDS_BOOLEAN_FALSE otherwise.