<<interface>> Instantiates DataReader < DDS_Octets >. More...

Inheritance diagram for DDSOctetsDataReader:

Public Member Functions
virtual DDS_ReturnCode_t	read (DDS_OctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, DDS_SampleStateMask sample_states=DDS_ANY_SAMPLE_STATE, DDS_ViewStateMask view_states=DDS_ANY_VIEW_STATE, DDS_InstanceStateMask instance_states=DDS_ANY_INSTANCE_STATE)
	Access a collection of data samples from the DDSDataReader. More...

virtual DDS_ReturnCode_t	take (DDS_OctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, DDS_SampleStateMask sample_states=DDS_ANY_SAMPLE_STATE, DDS_ViewStateMask view_states=DDS_ANY_VIEW_STATE, DDS_InstanceStateMask instance_states=DDS_ANY_INSTANCE_STATE)
	Access a collection of data-samples from the DDSDataReader. More...

virtual DDS_ReturnCode_t	read_w_condition (DDS_OctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples, DDSReadCondition *condition)
	Accesses via DDSOctetsDataReader::read the samples that match the criteria specified in the DDSReadCondition. More...

virtual DDS_ReturnCode_t	take_w_condition (DDS_OctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples, DDSReadCondition *condition)
	Analogous to DDSOctetsDataReader::read_w_condition except it accesses samples via the DDSOctetsDataReader::take operation. More...

virtual DDS_ReturnCode_t	read_next_sample (DDS_Octets &received_data, DDS_SampleInfo &sample_info)
	Copies the next not-previously-accessed data value from the DDSDataReader. More...

virtual DDS_ReturnCode_t	take_next_sample (DDS_Octets &received_data, DDS_SampleInfo &sample_info)
	Copies the next not-previously-accessed data value from the DDSDataReader. More...

virtual DDS_ReturnCode_t	return_loan (DDS_OctetsSeq &received_data, DDS_SampleInfoSeq &info_seq)
	Indicates to the DDSDataReader that the application is done accessing the collection of `received_data` and `info_seq` obtained by some earlier invocation of read or take on the DDSDataReader. More...

Public Member Functions inherited from DDSDataReader
virtual DDSReadCondition *	create_readcondition (DDS_SampleStateMask sample_states, DDS_ViewStateMask view_states, DDS_InstanceStateMask instance_states)
	Creates a DDSReadCondition. More...

virtual DDSReadCondition *	create_readcondition_w_params (DDS_ReadConditionParams &params)
	<<extension>> Creates a DDSReadCondition with parameters. More...

virtual DDSQueryCondition *	create_querycondition (DDS_SampleStateMask sample_states, DDS_ViewStateMask view_states, DDS_InstanceStateMask instance_states, const char *query_expression, const struct DDS_StringSeq &query_parameters)
	Creates a DDSQueryCondition. More...

virtual DDSQueryCondition *	create_querycondition_w_params (DDS_QueryConditionParams &params)
	<<extension>> Creates a DDSQueryCondition with parameters. More...

virtual DDS_ReturnCode_t	delete_readcondition (DDSReadCondition *condition)
	Deletes a DDSReadCondition or DDSQueryCondition attached to the DDSDataReader. More...

virtual DDS_ReturnCode_t	delete_contained_entities ()
	Deletes all the entities that were created by means of the "create" operations on the DDSDataReader. More...

virtual DDS_ReturnCode_t	wait_for_historical_data (const DDS_Duration_t &max_wait)
	Waits until all "historical" data is received for DDSDataReader entities that have a non-VOLATILE Durability Qos kind. More...

virtual DDS_ReturnCode_t	acknowledge_sample (const DDS_SampleInfo &sample_info)
	<<extension>> Acknowledges a single sample explicitly. More...

virtual DDS_ReturnCode_t	acknowledge_all ()
	<<extension>> Acknowledges all previously accessed samples. More...

virtual DDS_ReturnCode_t	acknowledge_sample (const DDS_SampleInfo &sample_info, const DDS_AckResponseData_t &response_data)
	<<extension>> Acknowledges a single sample explicitly. More...

virtual DDS_ReturnCode_t	acknowledge_all (const DDS_AckResponseData_t &response_data)
	<<extension>> Acknowledges all previously accessed samples. More...

virtual DDS_ReturnCode_t	get_matched_publications (DDS_InstanceHandleSeq &publication_handles)
	Retrieves the list of publications currently "associated" with this DDSDataReader. More...

virtual DDS_ReturnCode_t	get_matched_publication_data (DDS_PublicationBuiltinTopicData &publication_data, const DDS_InstanceHandle_t &publication_handle)
	Retrieves the information on a publication that is currently "associated" with the DDSDataReader. More...

virtual DDS_ReturnCode_t	is_matched_publication_alive (DDS_Boolean &is_alive, const DDS_InstanceHandle_t &publication_handle)
	Check if a publication currently matched with a DataReader is alive. More...

virtual DDS_ReturnCode_t	get_matched_publication_participant_data (DDS_ParticipantBuiltinTopicData &participant_data, const DDS_InstanceHandle_t &publication_handle)
	<<extension>> Retrieves the information on the discovered DDSDomainParticipant associated with the publication that is currently matching with the DDSDataReader. More...

virtual DDSTopicDescription *	get_topicdescription ()
	Returns the DDSTopicDescription associated with the DDSDataReader. More...

virtual DDSSubscriber *	get_subscriber ()
	Returns the DDSSubscriber to which the DDSDataReader belongs. More...

virtual DDS_ReturnCode_t	get_sample_rejected_status (DDS_SampleRejectedStatus &status)
	Accesses the DDS_SAMPLE_REJECTED_STATUS communication status. More...

virtual DDS_ReturnCode_t	get_liveliness_changed_status (DDS_LivelinessChangedStatus &status)
	Accesses the DDS_LIVELINESS_CHANGED_STATUS communication status. More...

virtual DDS_ReturnCode_t	get_requested_deadline_missed_status (DDS_RequestedDeadlineMissedStatus &status)
	Accesses the DDS_REQUESTED_DEADLINE_MISSED_STATUS communication status. More...

virtual DDS_ReturnCode_t	get_requested_incompatible_qos_status (DDS_RequestedIncompatibleQosStatus &status)
	Accesses the DDS_REQUESTED_INCOMPATIBLE_QOS_STATUS communication status. More...

virtual DDS_ReturnCode_t	get_sample_lost_status (DDS_SampleLostStatus &status)
	Accesses the DDS_SAMPLE_LOST_STATUS communication status. More...

virtual DDS_ReturnCode_t	get_subscription_matched_status (DDS_SubscriptionMatchedStatus &status)
	Accesses the DDS_SUBSCRIPTION_MATCHED_STATUS communication status. More...

virtual DDS_ReturnCode_t	get_datareader_cache_status (DDS_DataReaderCacheStatus &status)
	<<extension>> Gets the datareader cache status for this reader. More...

virtual DDS_ReturnCode_t	get_datareader_protocol_status (DDS_DataReaderProtocolStatus &status)
	<<extension>> Gets the datareader protocol status for this reader. More...

virtual DDS_ReturnCode_t	get_matched_publication_datareader_protocol_status (DDS_DataReaderProtocolStatus &status, const DDS_InstanceHandle_t &publication_handle)
	<<extension>> Gets the datareader protocol status for this reader, per matched publication identified by the publication_handle. More...

virtual DDS_ReturnCode_t	set_qos (const DDS_DataReaderQos &qos)
	Sets the reader QoS. More...

virtual DDS_ReturnCode_t	get_qos (DDS_DataReaderQos &qos)
	Gets the reader QoS. More...

virtual DDS_ReturnCode_t	set_qos_with_profile (const char library_name, const char profile_name)
	<<extension>> Changes the QoS of this reader using the input XML QoS profile. More...

virtual DDS_ReturnCode_t	set_property (const char property_name, const char value, bool propagate)
	Set the value for a property that applies to a DataReader. More...

virtual DDS_ReturnCode_t	set_listener (DDSDataReaderListener *l, DDS_StatusMask mask=DDS_STATUS_MASK_ALL)
	Sets the reader listener. More...

virtual DDSDataReaderListener *	get_listener ()
	Gets the reader listener. More...

virtual DDSTopicQuery *	create_topic_query (const DDS_TopicQuerySelection &selection)
	Creates a DDSTopicQuery. More...

virtual DDS_ReturnCode_t	delete_topic_query (DDSTopicQuery *query)
	Deletes a DDSTopicQuery. More...

virtual DDSTopicQuery *	lookup_topic_query (const DDS_GUID_t &guid)
	Retrieves an existing DDSTopicQuery. More...

virtual DDS_ReturnCode_t	take_discovery_snapshot ()
	Take a snapshot of the compatible and incompatible remote writers matched by a local reader. More...

virtual DDS_ReturnCode_t	take_discovery_snapshot (const char *file_name)
	Take a snapshot of the compatible and incompatible remote writers matched by a local reader. More...

virtual DDS_ReturnCode_t	enable ()
	Enables the DDSEntity. More...

virtual DDSStatusCondition *	get_statuscondition ()
	Allows access to the DDSStatusCondition associated with the DDSEntity. More...

virtual DDS_StatusMask	get_status_changes ()
	Retrieves the list of communication statuses in the DDSEntity that are triggered. More...

virtual DDS_InstanceHandle_t	get_instance_handle ()
	Allows access to the DDS_InstanceHandle_t associated with the DDSEntity. More...

virtual DDS_ReturnCode_t	enable ()=0
	Enables the DDSEntity. More...

virtual DDSStatusCondition *	get_statuscondition ()=0
	Allows access to the DDSStatusCondition associated with the DDSEntity. More...

virtual DDS_StatusMask	get_status_changes ()=0
	Retrieves the list of communication statuses in the DDSEntity that are triggered. More...

virtual DDS_InstanceHandle_t	get_instance_handle ()=0
	Allows access to the DDS_InstanceHandle_t associated with the DDSEntity. More...

Static Public Member Functions
static DDSOctetsDataReader *	narrow (DDSDataReader *reader)
	Narrow the given DDSDataReader pointer to a DDSOctetsDataReader pointer. More...

Detailed Description

<<interface>> Instantiates DataReader < DDS_Octets >.

When reading or taking data with this reader, if you request a copy of the samples instead of a loan, and the byte array in a destination data sample is NULL, the middleware will allocate a new array for you of sufficient length to hold the received data. The new array will be allocated with DDS_OctetBuffer_alloc; the sample's destructor will delete it.

A non- NULL array is assumed to be allocated to sufficient length to store the incoming data. It will not be reallocated.

See also: FooDataReader; DDSDataReader

Member Function Documentation

◆ read()

virtual DDS_ReturnCode_t DDSOctetsDataReader::read	(	DDS_OctetsSeq &	received_data,
		DDS_SampleInfoSeq &	info_seq,
		DDS_Long	max_samples = `DDS_LENGTH_UNLIMITED`,
		DDS_SampleStateMask	sample_states = `DDS_ANY_SAMPLE_STATE`,
		DDS_ViewStateMask	view_states = `DDS_ANY_VIEW_STATE`,
		DDS_InstanceStateMask	instance_states = `DDS_ANY_INSTANCE_STATE`
	)

virtual

Access a collection of data samples from the DDSDataReader.

See also: FooDataReader::read

◆ take()

virtual DDS_ReturnCode_t DDSOctetsDataReader::take	(	DDS_OctetsSeq &	received_data,
		DDS_SampleInfoSeq &	info_seq,
		DDS_Long	max_samples = `DDS_LENGTH_UNLIMITED`,
		DDS_SampleStateMask	sample_states = `DDS_ANY_SAMPLE_STATE`,
		DDS_ViewStateMask	view_states = `DDS_ANY_VIEW_STATE`,
		DDS_InstanceStateMask	instance_states = `DDS_ANY_INSTANCE_STATE`
	)

virtual

Access a collection of data-samples from the DDSDataReader.

See also: FooDataReader::take

◆ read_w_condition()

virtual DDS_ReturnCode_t DDSOctetsDataReader::read_w_condition	(	DDS_OctetsSeq &	received_data,
		DDS_SampleInfoSeq &	info_seq,
		DDS_Long	max_samples,
		DDSReadCondition *	condition
	)

virtual

Accesses via DDSOctetsDataReader::read the samples that match the criteria specified in the DDSReadCondition.

See also: FooDataReader::read_w_condition

◆ take_w_condition()

virtual DDS_ReturnCode_t DDSOctetsDataReader::take_w_condition	(	DDS_OctetsSeq &	received_data,
		DDS_SampleInfoSeq &	info_seq,
		DDS_Long	max_samples,
		DDSReadCondition *	condition
	)

virtual

Analogous to DDSOctetsDataReader::read_w_condition except it accesses samples via the DDSOctetsDataReader::take operation.

See also: FooDataReader::take_w_condition

◆ read_next_sample()

virtual DDS_ReturnCode_t DDSOctetsDataReader::read_next_sample	(	DDS_Octets &	received_data,
		DDS_SampleInfo &	sample_info
	)

virtual

Copies the next not-previously-accessed data value from the DDSDataReader.

See also: FooDataReader::read_next_sample

◆ take_next_sample()

virtual DDS_ReturnCode_t DDSOctetsDataReader::take_next_sample	(	DDS_Octets &	received_data,
		DDS_SampleInfo &	sample_info
	)

virtual

Copies the next not-previously-accessed data value from the DDSDataReader.

See also: FooDataReader::take_next_sample

◆ return_loan()

virtual DDS_ReturnCode_t DDSOctetsDataReader::return_loan	(	DDS_OctetsSeq &	received_data,
		DDS_SampleInfoSeq &	info_seq
	)

virtual

Indicates to the DDSDataReader that the application is done accessing the collection of received_data and info_seq obtained by some earlier invocation of read or take on the DDSDataReader.

See also: FooDataReader::return_loan

◆ narrow()

static DDSOctetsDataReader * DDSOctetsDataReader::narrow ( DDSDataReader * reader )

static

Narrow the given DDSDataReader pointer to a DDSOctetsDataReader pointer.

See also: FooDataReader::narrow

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ read()

◆ take()

◆ read_w_condition()

◆ take_w_condition()

◆ read_next_sample()

◆ take_next_sample()

◆ return_loan()

◆ narrow()