Class Subscriber, contains the public API that allows the user to control the reception of messages. More...
#include <Subscriber.hpp>
Public Member Functions | |
virtual | ~Subscriber () |
Destructor. | |
FASTDDS_EXPORTED_API ReturnCode_t | enable () override |
This operation enables the Subscriber. | |
FASTDDS_EXPORTED_API const SubscriberQos & | get_qos () const |
Allows accessing the Subscriber Qos. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_qos (SubscriberQos &qos) const |
Retrieves the Subscriber Qos. | |
FASTDDS_EXPORTED_API ReturnCode_t | set_qos (const SubscriberQos &qos) |
Allows modifying the Subscriber Qos. | |
FASTDDS_EXPORTED_API const SubscriberListener * | get_listener () const |
Retrieves the attached SubscriberListener. | |
FASTDDS_EXPORTED_API ReturnCode_t | set_listener (SubscriberListener *listener) |
Modifies the SubscriberListener, sets the mask to StatusMask::all() | |
FASTDDS_EXPORTED_API ReturnCode_t | set_listener (SubscriberListener *listener, const StatusMask &mask) |
Modifies the SubscriberListener. | |
FASTDDS_EXPORTED_API DataReader * | create_datareader (TopicDescription *topic, const DataReaderQos &reader_qos, DataReaderListener *listener=nullptr, const StatusMask &mask=StatusMask::all(), std::shared_ptr< fastdds::rtps::IPayloadPool > payload_pool=nullptr) |
This operation creates a DataReader. | |
FASTDDS_EXPORTED_API DataReader * | create_datareader_with_profile (TopicDescription *topic, const std::string &profile_name, DataReaderListener *listener=nullptr, const StatusMask &mask=StatusMask::all(), std::shared_ptr< fastdds::rtps::IPayloadPool > payload_pool=nullptr) |
This operation creates a DataReader. | |
FASTDDS_EXPORTED_API ReturnCode_t | delete_datareader (const DataReader *reader) |
This operation deletes a DataReader that belongs to the Subscriber. | |
FASTDDS_EXPORTED_API DataReader * | lookup_datareader (const std::string &topic_name) const |
This operation retrieves a previously-created DataReader belonging to the Subscriber that is attached to a Topic with a matching topic_name. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_datareaders (std::vector< DataReader * > &readers) const |
This operation allows the application to access the DataReader objects. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_datareaders (std::vector< DataReader * > &readers, const std::vector< SampleStateKind > &sample_states, const std::vector< ViewStateKind > &view_states, const std::vector< InstanceStateKind > &instance_states) const |
This operation allows the application to access the DataReader objects that contain samples with the specified sample_states, view_states, and instance_states. | |
FASTDDS_EXPORTED_API bool | has_datareaders () const |
This operation checks if the subscriber has DataReaders. | |
FASTDDS_EXPORTED_API ReturnCode_t | begin_access () |
Indicates that the application is about to access the data samples in any of the DataReader objects attached to the Subscriber. | |
FASTDDS_EXPORTED_API ReturnCode_t | end_access () |
Indicates that the application has finished accessing the data samples in DataReader objects managed by the Subscriber. | |
FASTDDS_EXPORTED_API ReturnCode_t | notify_datareaders () const |
This operation invokes the operation on_data_available on the DataReaderListener objects attached to contained DataReader entities. | |
FASTDDS_EXPORTED_API ReturnCode_t | delete_contained_entities () |
Deletes all contained DataReaders. | |
FASTDDS_EXPORTED_API ReturnCode_t | set_default_datareader_qos (const DataReaderQos &qos) |
This operation sets a default value of the DataReader QoS policies which will be used for newly created DataReader entities in the case where the QoS policies are defaulted in the create_datareader operation. | |
FASTDDS_EXPORTED_API const DataReaderQos & | get_default_datareader_qos () const |
This operation returns the default value of the DataReader QoS, that is, the QoS policies which will be used for newly created DataReader entities in the case where the QoS policies are defaulted in the create_datareader operation. | |
FASTDDS_EXPORTED_API DataReaderQos & | get_default_datareader_qos () |
This operation returns the default value of the DataReader QoS, that is, the QoS policies which will be used for newly created DataReader entities in the case where the QoS policies are defaulted in the create_datareader operation. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_default_datareader_qos (DataReaderQos &qos) const |
This operation retrieves the default value of the DataReader QoS, that is, the QoS policies which will be used for newly created DataReader entities in the case where the QoS policies are defaulted in the create_datareader operation. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_datareader_qos_from_profile (const std::string &profile_name, DataReaderQos &qos) const |
Fills the DataReaderQos with the values of the XML profile. | |
FASTDDS_EXPORTED_API const DomainParticipant * | get_participant () const |
This operation returns the DomainParticipant to which the Subscriber belongs. | |
FASTDDS_EXPORTED_API const InstanceHandle_t & | get_instance_handle () const |
Returns the Subscriber's handle. | |
![]() | |
DomainEntity (const StatusMask &mask=StatusMask::all()) | |
Constructor. | |
![]() | |
FASTDDS_EXPORTED_API | Entity (const StatusMask &mask=StatusMask::all()) |
Constructor. | |
void | close () |
This operation disables the Entity before closing it. | |
FASTDDS_EXPORTED_API const StatusMask & | get_status_mask () const |
Retrieves the set of relevant statuses for the Entity. | |
FASTDDS_EXPORTED_API const StatusMask & | get_status_changes () const |
Retrieves the set of triggered statuses in the Entity. | |
const InstanceHandle_t & | get_instance_handle () const |
Retrieves the instance handler that represents the Entity. | |
FASTDDS_EXPORTED_API bool | is_enabled () const |
Checks if the Entity is enabled. | |
FASTDDS_EXPORTED_API bool | operator== (const Entity &other) const |
FASTDDS_EXPORTED_API StatusCondition & | get_statuscondition () |
Allows access to the StatusCondition associated with the Entity. | |
Static Public Member Functions | |
static FASTDDS_EXPORTED_API ReturnCode_t | copy_from_topic_qos (DataReaderQos &reader_qos, const TopicQos &topic_qos) |
Copies TopicQos into the corresponding DataReaderQos. | |
Protected Member Functions | |
Subscriber (SubscriberImpl *pimpl, const StatusMask &mask=StatusMask::all()) | |
Create a subscriber, assigning its pointer to the associated implementation. | |
Subscriber (DomainParticipant *dp, const SubscriberQos &qos=SUBSCRIBER_QOS_DEFAULT, SubscriberListener *listener=nullptr, const StatusMask &mask=StatusMask::all()) | |
![]() | |
FASTDDS_EXPORTED_API void | set_instance_handle (const InstanceHandle_t &handle) |
Setter for the Instance Handle. | |
Protected Attributes | |
SubscriberImpl * | impl_ |
![]() | |
StatusMask | status_mask_ |
StatusMask with relevant statuses set to 1. | |
StatusCondition | status_condition_ |
Condition associated to the Entity. | |
InstanceHandle_t | instance_handle_ |
InstanceHandle associated to the Entity. | |
bool | enable_ |
Boolean that states if the Entity is enabled or disabled. | |
Friends | |
class | SubscriberImpl |
class | DomainParticipantImpl |
class | ::dds::sub::Subscriber |
Class Subscriber, contains the public API that allows the user to control the reception of messages.
This class should not be instantiated directly. DomainRTPSParticipant class should be used to correctly create this element.
|
protected |
Create a subscriber, assigning its pointer to the associated implementation.
Don't use directly, create Subscriber using create_subscriber from DomainParticipant.
|
protected |
|
inlinevirtual |
Destructor.
FASTDDS_EXPORTED_API ReturnCode_t begin_access | ( | ) |
Indicates that the application is about to access the data samples in any of the DataReader objects attached to the Subscriber.
|
static |
Copies TopicQos into the corresponding DataReaderQos.
[in,out] | reader_qos | |
[in] | topic_qos |
FASTDDS_EXPORTED_API DataReader * create_datareader | ( | TopicDescription * | topic, |
const DataReaderQos & | reader_qos, | ||
DataReaderListener * | listener = nullptr , |
||
const StatusMask & | mask = StatusMask::all() , |
||
std::shared_ptr< fastdds::rtps::IPayloadPool > | payload_pool = nullptr |
||
) |
This operation creates a DataReader.
The returned DataReader will be attached and belong to the Subscriber.
topic | Topic the DataReader will be listening. |
reader_qos | QoS of the DataReader. |
listener | Pointer to the listener (default: nullptr) |
mask | StatusMask that holds statuses the listener responds to (default: all). |
payload_pool | IPayloadPool shared pointer that defines reader payload (default: nullptr). |
FASTDDS_EXPORTED_API DataReader * create_datareader_with_profile | ( | TopicDescription * | topic, |
const std::string & | profile_name, | ||
DataReaderListener * | listener = nullptr , |
||
const StatusMask & | mask = StatusMask::all() , |
||
std::shared_ptr< fastdds::rtps::IPayloadPool > | payload_pool = nullptr |
||
) |
This operation creates a DataReader.
The returned DataReader will be attached and belongs to the Subscriber.
topic | Topic the DataReader will be listening. |
profile_name | DataReader profile name. |
listener | Pointer to the listener (default: nullptr) |
mask | StatusMask that holds statuses the listener responds to (default: all). |
payload_pool | IPayloadPool shared pointer that defines reader payload (default: nullptr). |
FASTDDS_EXPORTED_API ReturnCode_t delete_contained_entities | ( | ) |
Deletes all contained DataReaders.
If the DataReaders have any QueryCondition or ReadCondition, they are deleted before the DataReader itself.
FASTDDS_EXPORTED_API ReturnCode_t delete_datareader | ( | const DataReader * | reader | ) |
This operation deletes a DataReader that belongs to the Subscriber.
The delete_datareader operation must be called on the same Subscriber object used to create the DataReader. If delete_datareader is called on a different Subscriber, the operation will have no effect and it will return an error.
reader | DataReader to delete |
|
overridevirtual |
This operation enables the Subscriber.
Reimplemented from Entity.
FASTDDS_EXPORTED_API ReturnCode_t end_access | ( | ) |
Indicates that the application has finished accessing the data samples in DataReader objects managed by the Subscriber.
FASTDDS_EXPORTED_API ReturnCode_t get_datareader_qos_from_profile | ( | const std::string & | profile_name, |
DataReaderQos & | qos | ||
) | const |
Fills the DataReaderQos with the values of the XML profile.
profile_name | DataReader profile name. |
qos | DataReaderQos object where the qos is returned. |
FASTDDS_EXPORTED_API ReturnCode_t get_datareaders | ( | std::vector< DataReader * > & | readers | ) | const |
This operation allows the application to access the DataReader objects.
readers | Vector of DataReader where the list of existing readers is returned |
FASTDDS_EXPORTED_API ReturnCode_t get_datareaders | ( | std::vector< DataReader * > & | readers, |
const std::vector< SampleStateKind > & | sample_states, | ||
const std::vector< ViewStateKind > & | view_states, | ||
const std::vector< InstanceStateKind > & | instance_states | ||
) | const |
This operation allows the application to access the DataReader objects that contain samples with the specified sample_states, view_states, and instance_states.
[out] | readers | Vector of DataReader where the list of existing readers is returned |
sample_states | Vector of SampleStateKind | |
view_states | Vector of ViewStateKind | |
instance_states | Vector of InstanceStateKind |
FASTDDS_EXPORTED_API DataReaderQos & get_default_datareader_qos | ( | ) |
This operation returns the default value of the DataReader QoS, that is, the QoS policies which will be used for newly created DataReader entities in the case where the QoS policies are defaulted in the create_datareader operation.
The values retrieved get_default_datareader_qos will match the set of values specified on the last successful call to get_default_datareader_qos, or else, if the call was never made, the default values.
FASTDDS_EXPORTED_API const DataReaderQos & get_default_datareader_qos | ( | ) | const |
This operation returns the default value of the DataReader QoS, that is, the QoS policies which will be used for newly created DataReader entities in the case where the QoS policies are defaulted in the create_datareader operation.
The values retrieved get_default_datareader_qos will match the set of values specified on the last successful call to get_default_datareader_qos, or else, if the call was never made, the default values.
FASTDDS_EXPORTED_API ReturnCode_t get_default_datareader_qos | ( | DataReaderQos & | qos | ) | const |
This operation retrieves the default value of the DataReader QoS, that is, the QoS policies which will be used for newly created DataReader entities in the case where the QoS policies are defaulted in the create_datareader operation.
The values retrieved get_default_datareader_qos will match the set of values specified on the last successful call to get_default_datareader_qos, or else, if the call was never made, the default values.
qos | DataReaderQos where the default_qos is returned |
FASTDDS_EXPORTED_API const InstanceHandle_t & get_instance_handle | ( | ) | const |
Returns the Subscriber's handle.
FASTDDS_EXPORTED_API const SubscriberListener * get_listener | ( | ) | const |
Retrieves the attached SubscriberListener.
FASTDDS_EXPORTED_API const DomainParticipant * get_participant | ( | ) | const |
This operation returns the DomainParticipant to which the Subscriber belongs.
FASTDDS_EXPORTED_API const SubscriberQos & get_qos | ( | ) | const |
Allows accessing the Subscriber Qos.
FASTDDS_EXPORTED_API ReturnCode_t get_qos | ( | SubscriberQos & | qos | ) | const |
Retrieves the Subscriber Qos.
qos | SubscriberQos where the qos is returned |
FASTDDS_EXPORTED_API bool has_datareaders | ( | ) | const |
This operation checks if the subscriber has DataReaders.
FASTDDS_EXPORTED_API DataReader * lookup_datareader | ( | const std::string & | topic_name | ) | const |
This operation retrieves a previously-created DataReader belonging to the Subscriber that is attached to a Topic with a matching topic_name.
If no such DataReader exists, the operation will return nullptr.
If multiple DataReaders attached to the Subscriber satisfy this condition, then the operation will return one of them. It is not specified which one.
topic_name | Name of the topic associated to the DataReader |
FASTDDS_EXPORTED_API ReturnCode_t notify_datareaders | ( | ) | const |
This operation invokes the operation on_data_available on the DataReaderListener objects attached to contained DataReader entities.
This operation is typically invoked from the on_data_on_readers operation in the SubscriberListener. That way the SubscriberListener can delegate to the DataReaderListener objects the handling of the data.
FASTDDS_EXPORTED_API ReturnCode_t set_default_datareader_qos | ( | const DataReaderQos & | qos | ) |
This operation sets a default value of the DataReader QoS policies which will be used for newly created DataReader entities in the case where the QoS policies are defaulted in the create_datareader operation.
This operation will check that the resulting policies are self consistent; if they are not, the operation will have no effect and return false.
The special value DATAREADER_QOS_DEFAULT may be passed to this operation to indicate that the default QoS should be reset back to the initial values the factory would use, that is the values that would be used if the set_default_datareader_qos operation had never been called.
qos | new value for DataReaderQos to set as default |
FASTDDS_EXPORTED_API ReturnCode_t set_listener | ( | SubscriberListener * | listener | ) |
Modifies the SubscriberListener, sets the mask to StatusMask::all()
listener | new value for SubscriberListener |
FASTDDS_EXPORTED_API ReturnCode_t set_listener | ( | SubscriberListener * | listener, |
const StatusMask & | mask | ||
) |
Modifies the SubscriberListener.
listener | new value for the SubscriberListener |
mask | StatusMask that holds statuses the listener responds to. |
FASTDDS_EXPORTED_API ReturnCode_t set_qos | ( | const SubscriberQos & | qos | ) |
Allows modifying the Subscriber Qos.
The given Qos must be supported by the SubscriberQos.
qos | new value for SubscriberQos |
|
friend |
|
friend |
|
friend |
|
protected |