Class RTPSReader, manages the reception of data from its matched writers. More...
#include <RTPSReader.hpp>
Public Member Functions | |
virtual FASTDDS_EXPORTED_API bool | matched_writer_add (const PublicationBuiltinTopicData &info)=0 |
Add a matched writer represented by its publication info. | |
virtual FASTDDS_EXPORTED_API bool | matched_writer_remove (const GUID_t &writer_guid, bool removed_by_lease=false)=0 |
Remove a writer from the matched writers. | |
virtual FASTDDS_EXPORTED_API bool | matched_writer_is_matched (const GUID_t &writer_guid)=0 |
Check if a specific writer is matched against this reader. | |
virtual FASTDDS_EXPORTED_API void | assert_writer_liveliness (const GUID_t &writer)=0 |
Assert the liveliness of a matched writer. | |
virtual FASTDDS_EXPORTED_API bool | is_in_clean_state ()=0 |
Check if this reader is in a clean state with all its matched writers. | |
virtual FASTDDS_EXPORTED_API ReaderListener * | get_listener () const =0 |
Get the associated listener. | |
virtual FASTDDS_EXPORTED_API void | set_listener (ReaderListener *listener)=0 |
Change the listener associated to this reader. | |
virtual FASTDDS_EXPORTED_API bool | expects_inline_qos () const =0 |
virtual FASTDDS_EXPORTED_API ReaderHistory * | get_history () const =0 |
virtual FASTDDS_EXPORTED_API eprosima::fastdds::rtps::IReaderDataFilter * | get_content_filter () const =0 |
virtual FASTDDS_EXPORTED_API void | set_content_filter (eprosima::fastdds::rtps::IReaderDataFilter *filter)=0 |
Set the content filter associated to this reader. | |
virtual FASTDDS_EXPORTED_API CacheChange_t * | next_unread_cache ()=0 |
Read the next unread CacheChange_t from the history. | |
virtual FASTDDS_EXPORTED_API CacheChange_t * | next_untaken_cache ()=0 |
Get the next CacheChange_t from the history to take. | |
virtual FASTDDS_EXPORTED_API bool | wait_for_unread_cache (const eprosima::fastdds::dds::Duration_t &timeout)=0 |
Wait until there is an unread CacheChange_t in the history. | |
virtual FASTDDS_EXPORTED_API uint64_t | get_unread_count () const =0 |
Get the number of unread CacheChange_t in the history. | |
virtual FASTDDS_EXPORTED_API uint64_t | get_unread_count (bool mark_as_read)=0 |
Get the number of unread CacheChange_t in the history and optionally mark them as read. | |
virtual FASTDDS_EXPORTED_API bool | is_sample_valid (const void *data, const GUID_t &writer, const SequenceNumber_t &sn) const =0 |
Checks whether the sample is still valid or is corrupted. | |
![]() | |
FASTDDS_EXPORTED_API const GUID_t & | getGuid () const |
Get associated GUID. | |
FASTDDS_EXPORTED_API RecursiveTimedMutex & | getMutex () |
Get mutex. | |
FASTDDS_EXPORTED_API EndpointAttributes & | getAttributes () |
Get associated attributes. | |
Protected Member Functions | |
RTPSReader (RTPSParticipantImpl *pimpl, const GUID_t &guid, const ReaderAttributes &att, ReaderHistory *hist) | |
~RTPSReader () | |
![]() | |
Endpoint ()=default | |
Endpoint (RTPSParticipantImpl *pimpl, const GUID_t &guid, const EndpointAttributes &att) | |
virtual | ~Endpoint () |
Protected Attributes | |
ReaderHistory * | history_ |
ReaderHistory. | |
![]() | |
RTPSParticipantImpl * | mp_RTPSParticipant |
Pointer to the RTPSParticipant containing this endpoint. | |
const GUID_t | m_guid |
Endpoint GUID. | |
EndpointAttributes | m_att |
Endpoint Attributes. | |
RecursiveTimedMutex | mp_mutex |
Endpoint Mutex. | |
uint32_t | fixed_payload_size_ = 0 |
Fixed size of payloads. | |
Class RTPSReader, manages the reception of data from its matched writers.
Needs to be constructed using the createRTPSReader method from the RTPSDomain.
|
protected |
|
protected |
|
pure virtual |
Assert the liveliness of a matched writer.
writer | GUID of the writer on which to assert liveliness. |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
Get the associated listener.
|
pure virtual |
Get the number of unread CacheChange_t in the history.
|
pure virtual |
Get the number of unread CacheChange_t in the history and optionally mark them as read.
mark_as_read | Whether to mark the unread CacheChange_t as read. |
|
pure virtual |
Check if this reader is in a clean state with all its matched writers.
This will happen when the reader has received all samples announced by all its matched writers.
|
pure virtual |
Checks whether the sample is still valid or is corrupted.
data | Pointer to the sample data to check. If it does not belong to the payload pool passed to the reader on construction, it yields undefined behavior. |
writer | GUID of the writer that sent data . |
sn | Sequence number related to data . |
|
pure virtual |
Add a matched writer represented by its publication info.
info | Publication info of the writer being matched. |
|
pure virtual |
Check if a specific writer is matched against this reader.
writer_guid | GUID of the writer to check. |
|
pure virtual |
Remove a writer from the matched writers.
writer_guid | GUID of the writer to remove. |
removed_by_lease | Whether the writer is being unmatched due to a participant drop. |
|
pure virtual |
Read the next unread CacheChange_t from the history.
|
pure virtual |
Get the next CacheChange_t from the history to take.
|
pure virtual |
Set the content filter associated to this reader.
filter | Pointer to the content filter to associate to this reader. |
|
pure virtual |
Change the listener associated to this reader.
listener | The new listener to associate to this reader. |
|
pure virtual |
Wait until there is an unread CacheChange_t in the history.
timeout | Maximum time to wait. |
|
protected |