Public Member Functions |
virtual DDS_ReturnCode_t | read (DDS_KeyedOctetsSeq &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.
|
|
virtual DDS_ReturnCode_t | take (DDS_KeyedOctetsSeq &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.
|
|
virtual DDS_ReturnCode_t | read_w_condition (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples, DDSReadCondition *condition) |
| Accesses via DDSKeyedOctetsDataReader::read the samples that match the criteria specified in the DDSReadCondition.
|
|
virtual DDS_ReturnCode_t | take_w_condition (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples, DDSReadCondition *condition) |
| Analogous to DDSKeyedOctetsDataReader::read_w_condition except it accesses samples via the DDSKeyedOctetsDataReader::take operation.
|
|
virtual DDS_ReturnCode_t | read_next_sample (DDS_KeyedOctets &received_data, DDS_SampleInfo &sample_info) |
| Copies the next not-previously-accessed data value from the DDSDataReader.
|
|
virtual DDS_ReturnCode_t | take_next_sample (DDS_KeyedOctets &received_data, DDS_SampleInfo &sample_info) |
| Copies the next not-previously-accessed data value from the DDSDataReader.
|
|
virtual DDS_ReturnCode_t | read_instance (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, const DDS_InstanceHandle_t &a_handle=DDS_HANDLE_NIL, 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.
|
|
virtual DDS_ReturnCode_t | take_instance (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, const DDS_InstanceHandle_t &a_handle=DDS_HANDLE_NIL, 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.
|
|
virtual DDS_ReturnCode_t | read_instance_w_condition (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, const DDS_InstanceHandle_t &a_handle=DDS_HANDLE_NIL, DDSReadCondition *condition=NULL) |
| Accesses via DDSKeyedOctetsDataReader::read_instance the samples that match the criteria specified in the DDSReadCondition.
|
|
virtual DDS_ReturnCode_t | take_instance_w_condition (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, const DDS_InstanceHandle_t &a_handle=DDS_HANDLE_NIL, DDSReadCondition *condition=NULL) |
| Accesses via DDSKeyedOctetsDataReader::take_instance the samples that match the criteria specified in the DDSReadCondition.
|
|
virtual DDS_ReturnCode_t | read_next_instance (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, const DDS_InstanceHandle_t &previous_handle=DDS_HANDLE_NIL, 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.
|
|
virtual DDS_ReturnCode_t | take_next_instance (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, const DDS_InstanceHandle_t &previous_handle=DDS_HANDLE_NIL, 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.
|
|
virtual DDS_ReturnCode_t | read_next_instance_w_condition (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, const DDS_InstanceHandle_t &previous_handle=DDS_HANDLE_NIL, DDSReadCondition *condition=NULL) |
| Accesses via DDSKeyedOctetsDataReader::read_next_instance the samples that match the criteria specified in the DDSReadCondition.
|
|
virtual DDS_ReturnCode_t | take_next_instance_w_condition (DDS_KeyedOctetsSeq &received_data, DDS_SampleInfoSeq &info_seq, DDS_Long max_samples=DDS_LENGTH_UNLIMITED, const DDS_InstanceHandle_t &previous_handle=DDS_HANDLE_NIL, DDSReadCondition *condition=NULL) |
| Accesses via DDSKeyedOctetsDataReader::take_next_instance the samples that match the criteria specified in the DDSReadCondition.
|
|
virtual DDS_ReturnCode_t | return_loan (DDS_KeyedOctetsSeq &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.
|
|
virtual DDS_ReturnCode_t | get_key_value (DDS_KeyedOctets &key_holder, const DDS_InstanceHandle_t &handle) |
| Retrieve the instance key that corresponds to an instance handle .
|
|
virtual DDS_ReturnCode_t | get_key_value (char *key, const DDS_InstanceHandle_t &handle) |
| <<eXtension>> Retrieve the instance key that corresponds to an instance handle .
|
|
virtual DDS_InstanceHandle_t | lookup_instance (const DDS_KeyedOctets &key_holder) |
| Retrieve the instance handle that corresponds to an instance key_holder .
|
|
virtual DDS_InstanceHandle_t | lookup_instance (const char *key) |
| <<eXtension>> Retrieve the instance handle that corresponds to an instance key .
|
|
virtual DDSReadCondition * | create_readcondition (DDS_SampleStateMask sample_states, DDS_ViewStateMask view_states, DDS_InstanceStateMask instance_states) |
| Creates a DDSReadCondition.
|
|
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.
|
|
virtual DDS_ReturnCode_t | delete_readcondition (DDSReadCondition *condition) |
| Deletes a DDSReadCondition or DDSQueryCondition attached to the DDSDataReader.
|
|
virtual DDS_ReturnCode_t | delete_contained_entities () |
| Deletes all the entities that were created by means of the "create" operations on the DDSDataReader.
|
|
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.
|
|
virtual DDS_ReturnCode_t | acknowledge_sample (const DDS_SampleInfo &sample_info) |
| Acknowledge a single sample explicitly.
|
|
virtual DDS_ReturnCode_t | acknowledge_all () |
| Acknowledge all previously accessed samples.
|
|
virtual DDS_ReturnCode_t | acknowledge_sample (const DDS_SampleInfo &sample_info, const DDS_AckResponseData_t &response_data) |
| [Not supported.] Acknowledge a single sample explicitly
|
|
virtual DDS_ReturnCode_t | acknowledge_all (const DDS_AckResponseData_t &response_data) |
| [Not supported.] Acknowledge all previously accessed samples
|
|
virtual DDS_ReturnCode_t | get_matched_publications (DDS_InstanceHandleSeq &publication_handles) |
| Retrieve the list of publications currently "associated" with this DDSDataReader.
|
|
virtual DDS_ReturnCode_t | get_matched_publication_data (DDS_PublicationBuiltinTopicData &publication_data, const DDS_InstanceHandle_t &publication_handle) |
| This operation retrieves the information on a publication that is currently "associated" with the DDSDataReader.
|
|
virtual DDSTopicDescription * | get_topicdescription () |
| Returns the DDSTopicDescription associated with the DDSDataReader.
|
|
virtual DDSSubscriber * | get_subscriber () |
| Returns the DDSSubscriber to which the DDSDataReader belongs.
|
|
virtual DDS_ReturnCode_t | get_sample_rejected_status (DDS_SampleRejectedStatus &status) |
| Accesses the DDS_SAMPLE_REJECTED_STATUS communication status.
|
|
virtual DDS_ReturnCode_t | get_liveliness_changed_status (DDS_LivelinessChangedStatus &status) |
| Accesses the DDS_LIVELINESS_CHANGED_STATUS communication status.
|
|
virtual DDS_ReturnCode_t | get_requested_deadline_missed_status (DDS_RequestedDeadlineMissedStatus &status) |
| Accesses the DDS_REQUESTED_DEADLINE_MISSED_STATUS communication status.
|
|
virtual DDS_ReturnCode_t | get_requested_incompatible_qos_status (DDS_RequestedIncompatibleQosStatus &status) |
| Accesses the DDS_REQUESTED_INCOMPATIBLE_QOS_STATUS communication status.
|
|
virtual DDS_ReturnCode_t | get_sample_lost_status (DDS_SampleLostStatus &status) |
| Accesses the DDS_SAMPLE_LOST_STATUS communication status.
|
|
virtual DDS_ReturnCode_t | get_subscription_matched_status (DDS_SubscriptionMatchedStatus &status) |
| Accesses the DDS_SUBSCRIPTION_MATCHED_STATUS communication status.
|
|
virtual DDS_ReturnCode_t | get_datareader_cache_status (DDS_DataReaderCacheStatus &status) |
| <<eXtension>> Get the datareader cache status for this reader.
|
|
virtual DDS_ReturnCode_t | get_datareader_protocol_status (DDS_DataReaderProtocolStatus &status) |
| <<eXtension>> Get the datareader protocol status for this reader.
|
|
virtual DDS_ReturnCode_t | get_matched_publication_datareader_protocol_status (DDS_DataReaderProtocolStatus &status, const DDS_InstanceHandle_t &publication_handle) |
| <<eXtension>> Get the datareader protocol status for this reader, per matched publication identified by the publication_handle.
|
|
virtual DDS_ReturnCode_t | set_qos (const DDS_DataReaderQos &qos) |
| Sets the reader QoS.
|
|
virtual DDS_ReturnCode_t | get_qos (DDS_DataReaderQos &qos) |
| Gets the reader QoS.
|
|
virtual DDS_ReturnCode_t | set_qos_with_profile (const char *library_name, const char *profile_name) |
| <<eXtension>> Change the QoS of this reader using the input XML QoS profile.
|
|
virtual DDS_ReturnCode_t | set_listener (DDSDataReaderListener *l, DDS_StatusMask mask=DDS_STATUS_MASK_ALL) |
| Sets the reader listener.
|
|
virtual DDSDataReaderListener * | get_listener () |
| Get the reader listener.
|
|
virtual DDS_ReturnCode_t | enable () |
| Enables the DDSEntity.
|
|
virtual DDSStatusCondition * | get_statuscondition () |
| Allows access to the DDSStatusCondition associated with the DDSEntity.
|
|
virtual DDS_StatusMask | get_status_changes () |
| Retrieves the list of communication statuses in the DDSEntity that are triggered.
|
|
virtual DDS_InstanceHandle_t | get_instance_handle () |
| Allows access to the DDS_InstanceHandle_t associated with the DDSEntity.
|
|
<<interface>> Instantiates DataReader
< DDS_KeyedOctets >.
When reading or taking data with this reader, if you request a copy of the samples instead of a loan, and a string or byte array in a destination data sample is NULL, the middleware will allocate a new string or array for you of sufficient length to hold the received data. New strings will be allocated with DDS_String_alloc; new arrays will be allocated with DDS_OctetBuffer_alloc. The sample's destructor will delete them.
A non- NULL string or array is assumed to be allocated to sufficient length to store the incoming data. It will not be reallocated.
- See Also
- FooDataReader
-
DDSDataReader