Class DomainParticipant used to group Publishers and Subscribers into a single working unit. More...
#include <DomainParticipant.hpp>
Public Member Functions | |
virtual | ~DomainParticipant () |
Destructor. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_qos (DomainParticipantQos &qos) const |
This operation returns the value of the DomainParticipant QoS policies. | |
FASTDDS_EXPORTED_API const DomainParticipantQos & | get_qos () const |
This operation returns the value of the DomainParticipant QoS policies. | |
FASTDDS_EXPORTED_API ReturnCode_t | set_qos (const DomainParticipantQos &qos) const |
This operation sets the value of the DomainParticipant QoS policies. | |
FASTDDS_EXPORTED_API const DomainParticipantListener * | get_listener () const |
Allows accessing the DomainParticipantListener. | |
FASTDDS_EXPORTED_API ReturnCode_t | set_listener (DomainParticipantListener *listener) |
Modifies the DomainParticipantListener, sets the mask to StatusMask::all() | |
FASTDDS_EXPORTED_API ReturnCode_t | set_listener (DomainParticipantListener *listener, const std::chrono::seconds timeout) |
Modifies the DomainParticipantListener, sets the mask to StatusMask::all() | |
FASTDDS_EXPORTED_API ReturnCode_t | set_listener (DomainParticipantListener *listener, const StatusMask &mask) |
Modifies the DomainParticipantListener. | |
FASTDDS_EXPORTED_API ReturnCode_t | set_listener (DomainParticipantListener *listener, const StatusMask &mask, const std::chrono::seconds timeout) |
Modifies the DomainParticipantListener. | |
FASTDDS_EXPORTED_API ReturnCode_t | enable () override |
This operation enables the DomainParticipant. | |
FASTDDS_EXPORTED_API Publisher * | create_publisher (const PublisherQos &qos, PublisherListener *listener=nullptr, const StatusMask &mask=StatusMask::all()) |
Create a Publisher in this Participant. | |
FASTDDS_EXPORTED_API Publisher * | create_publisher_with_profile (const std::string &profile_name, PublisherListener *listener=nullptr, const StatusMask &mask=StatusMask::all()) |
Create a Publisher in this Participant. | |
FASTDDS_EXPORTED_API ReturnCode_t | delete_publisher (const Publisher *publisher) |
Deletes an existing Publisher. | |
FASTDDS_EXPORTED_API Subscriber * | create_subscriber (const SubscriberQos &qos, SubscriberListener *listener=nullptr, const StatusMask &mask=StatusMask::all()) |
Create a Subscriber in this Participant. | |
FASTDDS_EXPORTED_API Subscriber * | create_subscriber_with_profile (const std::string &profile_name, SubscriberListener *listener=nullptr, const StatusMask &mask=StatusMask::all()) |
Create a Subscriber in this Participant. | |
FASTDDS_EXPORTED_API ReturnCode_t | delete_subscriber (const Subscriber *subscriber) |
Deletes an existing Subscriber. | |
FASTDDS_EXPORTED_API Topic * | create_topic (const std::string &topic_name, const std::string &type_name, const TopicQos &qos, TopicListener *listener=nullptr, const StatusMask &mask=StatusMask::all()) |
Create a Topic in this Participant. | |
FASTDDS_EXPORTED_API Topic * | create_topic_with_profile (const std::string &topic_name, const std::string &type_name, const std::string &profile_name, TopicListener *listener=nullptr, const StatusMask &mask=StatusMask::all()) |
Create a Topic in this Participant. | |
FASTDDS_EXPORTED_API ReturnCode_t | delete_topic (const Topic *topic) |
Deletes an existing Topic. | |
FASTDDS_EXPORTED_API ContentFilteredTopic * | create_contentfilteredtopic (const std::string &name, Topic *related_topic, const std::string &filter_expression, const std::vector< std::string > &expression_parameters) |
Create a ContentFilteredTopic in this Participant. | |
FASTDDS_EXPORTED_API ContentFilteredTopic * | create_contentfilteredtopic (const std::string &name, Topic *related_topic, const std::string &filter_expression, const std::vector< std::string > &expression_parameters, const char *filter_class_name) |
Create a ContentFilteredTopic in this Participant using a custom filter. | |
FASTDDS_EXPORTED_API ReturnCode_t | delete_contentfilteredtopic (const ContentFilteredTopic *a_contentfilteredtopic) |
Deletes an existing ContentFilteredTopic. | |
FASTDDS_EXPORTED_API MultiTopic * | create_multitopic (const std::string &name, const std::string &type_name, const std::string &subscription_expression, const std::vector< std::string > &expression_parameters) |
Create a MultiTopic in this Participant. | |
FASTDDS_EXPORTED_API ReturnCode_t | delete_multitopic (const MultiTopic *a_multitopic) |
Deletes an existing MultiTopic. | |
FASTDDS_EXPORTED_API Topic * | find_topic (const std::string &topic_name, const fastdds::dds::Duration_t &timeout) |
Gives access to an existing (or ready to exist) enabled Topic. | |
FASTDDS_EXPORTED_API TopicDescription * | lookup_topicdescription (const std::string &topic_name) const |
Looks up an existing, locally created TopicDescription, based on its name. | |
FASTDDS_EXPORTED_API const Subscriber * | get_builtin_subscriber () const |
Allows access to the builtin Subscriber. | |
FASTDDS_EXPORTED_API ReturnCode_t | ignore_participant (const InstanceHandle_t &handle) |
Locally ignore a remote domain participant. | |
FASTDDS_EXPORTED_API ReturnCode_t | ignore_topic (const InstanceHandle_t &handle) |
Locally ignore a topic. | |
FASTDDS_EXPORTED_API ReturnCode_t | ignore_publication (const InstanceHandle_t &handle) |
Locally ignore a remote datawriter. | |
FASTDDS_EXPORTED_API ReturnCode_t | ignore_subscription (const InstanceHandle_t &handle) |
Locally ignore a remote datareader. | |
FASTDDS_EXPORTED_API DomainId_t | get_domain_id () const |
This operation retrieves the domain_id used to create the DomainParticipant. | |
FASTDDS_EXPORTED_API ReturnCode_t | delete_contained_entities () |
Deletes all the entities that were created by means of the “create” methods. | |
FASTDDS_EXPORTED_API ReturnCode_t | assert_liveliness () |
This operation manually asserts the liveliness of the DomainParticipant. | |
FASTDDS_EXPORTED_API ReturnCode_t | set_default_publisher_qos (const PublisherQos &qos) |
This operation sets a default value of the Publisher QoS policies which will be used for newly created Publisher entities in the case where the QoS policies are defaulted in the create_publisher operation. | |
FASTDDS_EXPORTED_API const PublisherQos & | get_default_publisher_qos () const |
This operation retrieves the default value of the Publisher QoS, that is, the QoS policies which will be used for newly created Publisher entities in the case where the QoS policies are defaulted in the create_publisher operation. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_default_publisher_qos (PublisherQos &qos) const |
This operation retrieves the default value of the Publisher QoS, that is, the QoS policies which will be used for newly created Publisher entities in the case where the QoS policies are defaulted in the create_publisher operation. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_publisher_qos_from_profile (const std::string &profile_name, PublisherQos &qos) const |
Fills the PublisherQos with the values of the XML profile. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_publisher_qos_from_xml (const std::string &xml, PublisherQos &qos) const |
Fills the PublisherQos with the first publisher profile found in the provided XML. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_publisher_qos_from_xml (const std::string &xml, PublisherQos &qos, const std::string &profile_name) const |
Fills the PublisherQos with the publisher profile with profile_name to be found in the provided XML. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_default_publisher_qos_from_xml (const std::string &xml, PublisherQos &qos) const |
Fills the PublisherQos with the default publisher profile found in the provided XML (if there is). | |
FASTDDS_EXPORTED_API ReturnCode_t | set_default_subscriber_qos (const SubscriberQos &qos) |
This operation sets a default value of the Subscriber QoS policies that will be used for newly created Subscriber entities in the case where the QoS policies are defaulted in the create_subscriber operation. | |
FASTDDS_EXPORTED_API const SubscriberQos & | get_default_subscriber_qos () const |
This operation retrieves the default value of the Subscriber QoS, that is, the QoS policies which will be used for newly created Subscriber entities in the case where the QoS policies are defaulted in the create_subscriber operation. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_default_subscriber_qos (SubscriberQos &qos) const |
This operation retrieves the default value of the Subscriber QoS, that is, the QoS policies which will be used for newly created Subscriber entities in the case where the QoS policies are defaulted in the create_subscriber operation. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_subscriber_qos_from_profile (const std::string &profile_name, SubscriberQos &qos) const |
Fills the SubscriberQos with the values of the XML profile. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_subscriber_qos_from_xml (const std::string &xml, SubscriberQos &qos) const |
Fills the SubscriberQos with the first subscriber profile found in the provided XML. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_subscriber_qos_from_xml (const std::string &xml, SubscriberQos &qos, const std::string &profile_name) const |
Fills the SubscriberQos with the subscriber profile with profile_name to be found in the provided XML. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_default_subscriber_qos_from_xml (const std::string &xml, SubscriberQos &qos) const |
Fills the SubscriberQos with the default subscriber profile found in the provided XML (if there is). | |
FASTDDS_EXPORTED_API ReturnCode_t | set_default_topic_qos (const TopicQos &qos) |
This operation sets a default value of the Topic QoS policies which will be used for newly created Topic entities in the case where the QoS policies are defaulted in the create_topic operation. | |
FASTDDS_EXPORTED_API const TopicQos & | get_default_topic_qos () const |
This operation retrieves the default value of the Topic QoS, that is, the QoS policies that will be used for newly created Topic entities in the case where the QoS policies are defaulted in the create_topic operation. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_default_topic_qos (TopicQos &qos) const |
This operation retrieves the default value of the Topic QoS, that is, the QoS policies that will be used for newly created Topic entities in the case where the QoS policies are defaulted in the create_topic operation. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_topic_qos_from_profile (const std::string &profile_name, TopicQos &qos) const |
Fills the TopicQos with the values of the XML profile. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_topic_qos_from_profile (const std::string &profile_name, TopicQos &qos, std::string &topic_name, std::string &topic_data_type) const |
Fills the TopicQos with the values of the XML profile, and also its corresponding topic and data type names (if specified). | |
FASTDDS_EXPORTED_API ReturnCode_t | get_topic_qos_from_xml (const std::string &xml, TopicQos &qos) const |
Fills the TopicQos with the first topic profile found in the provided XML. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_topic_qos_from_xml (const std::string &xml, TopicQos &qos, std::string &topic_name, std::string &topic_data_type) const |
Fills the TopicQos with the first topic profile found in the provided XML, and also its corresponding topic and data type names (if specified). | |
FASTDDS_EXPORTED_API ReturnCode_t | get_topic_qos_from_xml (const std::string &xml, TopicQos &qos, const std::string &profile_name) const |
Fills the TopicQos with the topic profile with profile_name to be found in the provided XML. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_topic_qos_from_xml (const std::string &xml, TopicQos &qos, std::string &topic_name, std::string &topic_data_type, const std::string &profile_name) const |
Fills the TopicQos with the topic profile with profile_name to be found in the provided XML, and also its corresponding topic and data type names (if specified). | |
FASTDDS_EXPORTED_API ReturnCode_t | get_default_topic_qos_from_xml (const std::string &xml, TopicQos &qos) const |
Fills the TopicQos with the default topic profile found in the provided XML (if there is). | |
FASTDDS_EXPORTED_API ReturnCode_t | get_default_topic_qos_from_xml (const std::string &xml, TopicQos &qos, std::string &topic_name, std::string &topic_data_type) const |
Fills the TopicQos with the default topic profile found in the provided XML (if there is), and also its corresponding topic and data type names (if specified). | |
FASTDDS_EXPORTED_API ReturnCode_t | get_replier_qos_from_profile (const std::string &profile_name, ReplierQos &qos) const |
Fills the ReplierQos with the values of the XML profile. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_replier_qos_from_xml (const std::string &xml, ReplierQos &qos) const |
Fills the ReplierQos with the first replier profile found in the provided XML. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_replier_qos_from_xml (const std::string &xml, ReplierQos &qos, const std::string &profile_name) const |
Fills the ReplierQos with the replier profile with profile_name to be found in the provided XML. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_default_replier_qos_from_xml (const std::string &xml, ReplierQos &qos) const |
Fills the ReplierQos with the default replier profile found in the provided XML (if there is). | |
FASTDDS_EXPORTED_API ReturnCode_t | get_requester_qos_from_profile (const std::string &profile_name, RequesterQos &qos) const |
Fills the RequesterQos with the values of the XML profile. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_requester_qos_from_xml (const std::string &xml, RequesterQos &qos) const |
Fills the RequesterQos with the first requester profile found in the provided XML. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_requester_qos_from_xml (const std::string &xml, RequesterQos &qos, const std::string &profile_name) const |
Fills the RequesterQos with the requester profile with profile_name to be found in the provided XML. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_default_requester_qos_from_xml (const std::string &xml, RequesterQos &qos) const |
Fills the RequesterQos with the default requester profile found in the provided XML (if there is). | |
FASTDDS_EXPORTED_API ReturnCode_t | get_discovered_participants (std::vector< InstanceHandle_t > &participant_handles) const |
Retrieves the list of DomainParticipants that have been discovered in the domain and are not "ignored". | |
FASTDDS_EXPORTED_API ReturnCode_t | get_discovered_participant_data (ParticipantBuiltinTopicData &participant_data, const InstanceHandle_t &participant_handle) const |
Retrieves the DomainParticipant data of a discovered not ignored participant. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_discovered_topics (std::vector< InstanceHandle_t > &topic_handles) const |
Retrieves the list of topics that have been discovered in the domain and are not "ignored". | |
FASTDDS_EXPORTED_API ReturnCode_t | get_discovered_topic_data (builtin::TopicBuiltinTopicData &topic_data, const InstanceHandle_t &topic_handle) const |
Retrieves the Topic data of a discovered not ignored topic. | |
FASTDDS_EXPORTED_API bool | contains_entity (const InstanceHandle_t &a_handle, bool recursive=true) const |
This operation checks whether or not the given handle represents an Entity that was created from the DomainParticipant. | |
FASTDDS_EXPORTED_API ReturnCode_t | get_current_time (fastdds::dds::Time_t ¤t_time) const |
This operation returns the current value of the time that the service uses to time-stamp data-writes and to set the reception-timestamp for the data-updates it receives. | |
FASTDDS_EXPORTED_API ReturnCode_t | register_type (TypeSupport type, const std::string &type_name) |
Register a type in this participant. | |
FASTDDS_EXPORTED_API ReturnCode_t | register_type (TypeSupport type) |
Register a type in this participant. | |
FASTDDS_EXPORTED_API ReturnCode_t | unregister_type (const std::string &typeName) |
Unregister a type in this participant. | |
FASTDDS_EXPORTED_API TypeSupport | find_type (const std::string &type_name) const |
This method gives access to a registered type based on its name. | |
FASTDDS_EXPORTED_API const InstanceHandle_t & | get_instance_handle () const |
Returns the DomainParticipant's handle. | |
FASTDDS_EXPORTED_API const fastdds::rtps::GUID_t & | guid () const |
Getter for the Participant GUID. | |
FASTDDS_EXPORTED_API std::vector< std::string > | get_participant_names () const |
Getter for the participant names. | |
FASTDDS_EXPORTED_API bool | new_remote_endpoint_discovered (const fastdds::rtps::GUID_t &partguid, uint16_t userId, fastdds::rtps::EndpointKind_t kind) |
This method can be used when using a StaticEndpointDiscovery mechanism different that the one included in Fast DDS, for example when communicating with other implementations. | |
FASTDDS_EXPORTED_API ReturnCode_t | register_content_filter_factory (const char *filter_class_name, IContentFilterFactory *const filter_factory) |
Register a custom content filter factory, which can be used to create a ContentFilteredTopic. | |
FASTDDS_EXPORTED_API IContentFilterFactory * | lookup_content_filter_factory (const char *filter_class_name) |
Lookup a custom content filter factory previously registered with register_content_filter_factory. | |
FASTDDS_EXPORTED_API ReturnCode_t | unregister_content_filter_factory (const char *filter_class_name) |
Unregister a custom content filter factory previously registered with register_content_filter_factory. | |
FASTDDS_EXPORTED_API bool | has_active_entities () |
Check if the Participant has any Publisher, Subscriber or Topic. | |
![]() | |
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. | |
Protected Member Functions | |
DomainParticipant (const StatusMask &mask=StatusMask::all()) | |
![]() | |
FASTDDS_EXPORTED_API void | set_instance_handle (const InstanceHandle_t &handle) |
Setter for the Instance Handle. | |
Protected Attributes | |
DomainParticipantImpl * | 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 | DomainParticipantFactory |
class | DomainParticipantImpl |
class | ::dds::domain::DomainParticipant |
Class DomainParticipant used to group Publishers and Subscribers into a single working unit.
|
virtual |
Destructor.
|
protected |
FASTDDS_EXPORTED_API ReturnCode_t assert_liveliness | ( | ) |
This operation manually asserts the liveliness of the DomainParticipant.
This is used in combination with the LIVELINESS QoS policy to indicate to the Service that the entity remains active.
This operation needs to only be used if the DomainParticipant contains DataWriter entities with the LIVELINESS set to MANUAL_BY_PARTICIPANT and it only affects the liveliness of those DataWriter entities. Otherwise, it has no effect.
FASTDDS_EXPORTED_API bool contains_entity | ( | const InstanceHandle_t & | a_handle, |
bool | recursive = true ) const |
This operation checks whether or not the given handle represents an Entity that was created from the DomainParticipant.
a_handle | InstanceHandle of the entity to look for. |
recursive | The containment applies recursively. That is, it applies both to entities (TopicDescription, Publisher, or Subscriber) created directly using the DomainParticipant as well as entities created using a contained Publisher, or Subscriber as the factory, and so forth. (default: true) |
FASTDDS_EXPORTED_API ContentFilteredTopic * create_contentfilteredtopic | ( | const std::string & | name, |
Topic * | related_topic, | ||
const std::string & | filter_expression, | ||
const std::vector< std::string > & | expression_parameters ) |
Create a ContentFilteredTopic in this Participant.
name | Name of the ContentFilteredTopic |
related_topic | Related Topic to being subscribed |
filter_expression | Logic expression to create filter |
expression_parameters | Parameters to filter content |
related_topic
does not belong to this participant. name
has already been created. filter_expression
and expression_parameters
. FASTDDS_EXPORTED_API ContentFilteredTopic * create_contentfilteredtopic | ( | const std::string & | name, |
Topic * | related_topic, | ||
const std::string & | filter_expression, | ||
const std::vector< std::string > & | expression_parameters, | ||
const char * | filter_class_name ) |
Create a ContentFilteredTopic in this Participant using a custom filter.
name | Name of the ContentFilteredTopic |
related_topic | Related Topic to being subscribed |
filter_expression | Logic expression to create filter |
expression_parameters | Parameters to filter content |
filter_class_name | Name of the filter class to use |
related_topic
does not belong to this participant. name
has already been created. filter_expression
and expression_parameters
. filter_class_name
has not been registered. FASTDDS_EXPORTED_API MultiTopic * create_multitopic | ( | const std::string & | name, |
const std::string & | type_name, | ||
const std::string & | subscription_expression, | ||
const std::vector< std::string > & | expression_parameters ) |
Create a MultiTopic in this Participant.
name | Name of the MultiTopic |
type_name | Result type of the MultiTopic |
subscription_expression | Logic expression to combine filter |
expression_parameters | Parameters to subscription content |
FASTDDS_EXPORTED_API Publisher * create_publisher | ( | const PublisherQos & | qos, |
PublisherListener * | listener = nullptr, | ||
const StatusMask & | mask = StatusMask::all() ) |
Create a Publisher in this Participant.
qos | QoS of the Publisher. |
listener | Pointer to the listener (default: nullptr) |
mask | StatusMask that holds statuses the listener responds to (default: all) |
FASTDDS_EXPORTED_API Publisher * create_publisher_with_profile | ( | const std::string & | profile_name, |
PublisherListener * | listener = nullptr, | ||
const StatusMask & | mask = StatusMask::all() ) |
Create a Publisher in this Participant.
profile_name | Publisher profile name. |
listener | Pointer to the listener (default: nullptr) |
mask | StatusMask that holds statuses the listener responds to (default: all) |
FASTDDS_EXPORTED_API Subscriber * create_subscriber | ( | const SubscriberQos & | qos, |
SubscriberListener * | listener = nullptr, | ||
const StatusMask & | mask = StatusMask::all() ) |
Create a Subscriber in this Participant.
qos | QoS of the Subscriber. |
listener | Pointer to the listener (default: nullptr) |
mask | StatusMask that holds statuses the listener responds to (default: all) |
FASTDDS_EXPORTED_API Subscriber * create_subscriber_with_profile | ( | const std::string & | profile_name, |
SubscriberListener * | listener = nullptr, | ||
const StatusMask & | mask = StatusMask::all() ) |
Create a Subscriber in this Participant.
profile_name | Subscriber profile name. |
listener | Pointer to the listener (default: nullptr) |
mask | StatusMask that holds statuses the listener responds to (default: all) |
FASTDDS_EXPORTED_API Topic * create_topic | ( | const std::string & | topic_name, |
const std::string & | type_name, | ||
const TopicQos & | qos, | ||
TopicListener * | listener = nullptr, | ||
const StatusMask & | mask = StatusMask::all() ) |
FASTDDS_EXPORTED_API Topic * create_topic_with_profile | ( | const std::string & | topic_name, |
const std::string & | type_name, | ||
const std::string & | profile_name, | ||
TopicListener * | listener = nullptr, | ||
const StatusMask & | mask = StatusMask::all() ) |
Create a Topic in this Participant.
topic_name | Name of the Topic. |
type_name | Data type of the Topic. |
profile_name | Topic profile name. |
listener | Pointer to the listener (default: nullptr) |
mask | StatusMask that holds statuses the listener responds to (default: all) |
FASTDDS_EXPORTED_API ReturnCode_t delete_contained_entities | ( | ) |
Deletes all the entities that were created by means of the “create” methods.
FASTDDS_EXPORTED_API ReturnCode_t delete_contentfilteredtopic | ( | const ContentFilteredTopic * | a_contentfilteredtopic | ) |
Deletes an existing ContentFilteredTopic.
a_contentfilteredtopic | ContentFilteredTopic to be deleted |
FASTDDS_EXPORTED_API ReturnCode_t delete_multitopic | ( | const MultiTopic * | a_multitopic | ) |
Deletes an existing MultiTopic.
a_multitopic | MultiTopic to be deleted |
FASTDDS_EXPORTED_API ReturnCode_t delete_publisher | ( | const Publisher * | publisher | ) |
Deletes an existing Publisher.
publisher | to be deleted. |
FASTDDS_EXPORTED_API ReturnCode_t delete_subscriber | ( | const Subscriber * | subscriber | ) |
Deletes an existing Subscriber.
subscriber | to be deleted. |
FASTDDS_EXPORTED_API ReturnCode_t delete_topic | ( | const Topic * | topic | ) |
|
overridevirtual |
FASTDDS_EXPORTED_API Topic * find_topic | ( | const std::string & | topic_name, |
const fastdds::dds::Duration_t & | timeout ) |
Gives access to an existing (or ready to exist) enabled Topic.
It should be noted that the returned Topic is a local object that acts as a proxy to designate the global concept of topic. Topics obtained by means of find_topic, must also be deleted by means of delete_topic so that the local resources can be released. If a Topic is obtained multiple times by means of find_topic or create_topic, it must also be deleted that same number of times using delete_topic.
FASTDDS_EXPORTED_API TypeSupport find_type | ( | const std::string & | type_name | ) | const |
This method gives access to a registered type based on its name.
type_name | Name of the type |
FASTDDS_EXPORTED_API const Subscriber * get_builtin_subscriber | ( | ) | const |
Allows access to the builtin Subscriber.
FASTDDS_EXPORTED_API ReturnCode_t get_current_time | ( | fastdds::dds::Time_t & | current_time | ) | const |
This operation returns the current value of the time that the service uses to time-stamp data-writes and to set the reception-timestamp for the data-updates it receives.
current_time | Time_t reference where the current time is returned |
FASTDDS_EXPORTED_API const PublisherQos & get_default_publisher_qos | ( | ) | const |
This operation retrieves the default value of the Publisher QoS, that is, the QoS policies which will be used for newly created Publisher entities in the case where the QoS policies are defaulted in the create_publisher operation.
The values retrieved get_default_publisher_qos will match the set of values specified on the last successful call to set_default_publisher_qos, or else, if the call was never made, the default values.
FASTDDS_EXPORTED_API ReturnCode_t get_default_publisher_qos | ( | PublisherQos & | qos | ) | const |
This operation retrieves the default value of the Publisher QoS, that is, the QoS policies which will be used for newly created Publisher entities in the case where the QoS policies are defaulted in the create_publisher operation.
The values retrieved get_default_publisher_qos will match the set of values specified on the last successful call to set_default_publisher_qos, or else, if the call was never made, the default values.
qos | PublisherQos reference where the default_publisher_qos is returned |
FASTDDS_EXPORTED_API ReturnCode_t get_default_publisher_qos_from_xml | ( | const std::string & | xml, |
PublisherQos & | qos ) const |
Fills the PublisherQos with the default publisher profile found in the provided XML (if there is).
get_default_publisher_qos
).xml | Raw XML string containing the profile to be used to fill the qos structure. |
qos | PublisherQos object where the qos is returned. |
FASTDDS_EXPORTED_API ReturnCode_t get_default_replier_qos_from_xml | ( | const std::string & | xml, |
ReplierQos & | qos ) const |
Fills the ReplierQos with the default replier profile found in the provided XML (if there is).
xml | Raw XML string containing the profile to be used to fill the qos structure. |
qos | ReplierQos object where the qos is returned. |
FASTDDS_EXPORTED_API ReturnCode_t get_default_requester_qos_from_xml | ( | const std::string & | xml, |
RequesterQos & | qos ) const |
Fills the RequesterQos with the default requester profile found in the provided XML (if there is).
xml | Raw XML string containing the profile to be used to fill the qos structure. |
qos | RequesterQos object where the qos is returned. |
FASTDDS_EXPORTED_API const SubscriberQos & get_default_subscriber_qos | ( | ) | const |
This operation retrieves the default value of the Subscriber QoS, that is, the QoS policies which will be used for newly created Subscriber entities in the case where the QoS policies are defaulted in the create_subscriber operation.
The values retrieved get_default_subscriber_qos will match the set of values specified on the last successful call to set_default_subscriber_qos, or else, if the call was never made, the default values.
FASTDDS_EXPORTED_API ReturnCode_t get_default_subscriber_qos | ( | SubscriberQos & | qos | ) | const |
This operation retrieves the default value of the Subscriber QoS, that is, the QoS policies which will be used for newly created Subscriber entities in the case where the QoS policies are defaulted in the create_subscriber operation.
The values retrieved get_default_subscriber_qos will match the set of values specified on the last successful call to set_default_subscriber_qos, or else, if the call was never made, the default values.
qos | SubscriberQos reference where the default_subscriber_qos is returned |
FASTDDS_EXPORTED_API ReturnCode_t get_default_subscriber_qos_from_xml | ( | const std::string & | xml, |
SubscriberQos & | qos ) const |
Fills the SubscriberQos with the default subscriber profile found in the provided XML (if there is).
get_default_subscriber_qos
).xml | Raw XML string containing the profile to be used to fill the qos structure. |
qos | SubscriberQos object where the qos is returned. |
FASTDDS_EXPORTED_API const TopicQos & get_default_topic_qos | ( | ) | const |
This operation retrieves the default value of the Topic QoS, that is, the QoS policies that will be used for newly created Topic entities in the case where the QoS policies are defaulted in the create_topic operation.
The values retrieved get_default_topic_qos will match the set of values specified on the last successful call to set_default_topic_qos, or else, TOPIC_QOS_DEFAULT if the call was never made.
FASTDDS_EXPORTED_API ReturnCode_t get_default_topic_qos | ( | TopicQos & | qos | ) | const |
This operation retrieves the default value of the Topic QoS, that is, the QoS policies that will be used for newly created Topic entities in the case where the QoS policies are defaulted in the create_topic operation.
The values retrieved get_default_topic_qos will match the set of values specified on the last successful call to set_default_topic_qos, or else, TOPIC_QOS_DEFAULT if the call was never made.
qos | TopicQos reference where the default_topic_qos is returned |
FASTDDS_EXPORTED_API ReturnCode_t get_default_topic_qos_from_xml | ( | const std::string & | xml, |
TopicQos & | qos ) const |
Fills the TopicQos with the default topic profile found in the provided XML (if there is).
get_default_topic_qos
).xml | Raw XML string containing the profile to be used to fill the qos structure. |
qos | TopicQos object where the qos is returned. |
FASTDDS_EXPORTED_API ReturnCode_t get_default_topic_qos_from_xml | ( | const std::string & | xml, |
TopicQos & | qos, | ||
std::string & | topic_name, | ||
std::string & | topic_data_type ) const |
Fills the TopicQos with the default topic profile found in the provided XML (if there is), and also its corresponding topic and data type names (if specified).
get_default_topic_qos
).xml | Raw XML string containing the profile to be used to fill the qos structure. |
qos | TopicQos object where the qos is returned. |
topic_name | String where the name of the topic associated to this profile is returned (if specified). |
topic_data_type | String where the name of the topic data type associated to this profile is returned (if specified). |
FASTDDS_EXPORTED_API ReturnCode_t get_discovered_participant_data | ( | ParticipantBuiltinTopicData & | participant_data, |
const InstanceHandle_t & | participant_handle ) const |
Retrieves the DomainParticipant data of a discovered not ignored participant.
[out] | participant_data | Reference to the ParticipantBuiltinTopicData object to return the data |
participant_handle | InstanceHandle of DomainParticipant to retrieve the data from |
FASTDDS_EXPORTED_API ReturnCode_t get_discovered_participants | ( | std::vector< InstanceHandle_t > & | participant_handles | ) | const |
Retrieves the list of DomainParticipants that have been discovered in the domain and are not "ignored".
[out] | participant_handles | Reference to the vector where discovered participants will be returned |
FASTDDS_EXPORTED_API ReturnCode_t get_discovered_topic_data | ( | builtin::TopicBuiltinTopicData & | topic_data, |
const InstanceHandle_t & | topic_handle ) const |
Retrieves the Topic data of a discovered not ignored topic.
[out] | topic_data | Reference to the TopicBuiltinTopicData object to return the data |
topic_handle | InstanceHandle of Topic to retrieve the data from |
FASTDDS_EXPORTED_API ReturnCode_t get_discovered_topics | ( | std::vector< InstanceHandle_t > & | topic_handles | ) | const |
Retrieves the list of topics that have been discovered in the domain and are not "ignored".
[out] | topic_handles | Reference to the vector where discovered topics will be returned |
FASTDDS_EXPORTED_API DomainId_t get_domain_id | ( | ) | const |
This operation retrieves the domain_id used to create the DomainParticipant.
The domain_id identifies the DDS domain to which the DomainParticipant belongs.
FASTDDS_EXPORTED_API const InstanceHandle_t & get_instance_handle | ( | ) | const |
Returns the DomainParticipant's handle.
FASTDDS_EXPORTED_API const DomainParticipantListener * get_listener | ( | ) | const |
Allows accessing the DomainParticipantListener.
FASTDDS_EXPORTED_API std::vector< std::string > get_participant_names | ( | ) | const |
Getter for the participant names.
FASTDDS_EXPORTED_API ReturnCode_t get_publisher_qos_from_profile | ( | const std::string & | profile_name, |
PublisherQos & | qos ) const |
Fills the PublisherQos with the values of the XML profile.
profile_name | Publisher profile name. |
qos | PublisherQos object where the qos is returned. |
FASTDDS_EXPORTED_API ReturnCode_t get_publisher_qos_from_xml | ( | const std::string & | xml, |
PublisherQos & | qos ) const |
Fills the PublisherQos with the first publisher profile found in the provided XML.
xml | Raw XML string containing the profile to be used to fill the qos structure. |
qos | PublisherQos object where the qos is returned. |
FASTDDS_EXPORTED_API ReturnCode_t get_publisher_qos_from_xml | ( | const std::string & | xml, |
PublisherQos & | qos, | ||
const std::string & | profile_name ) const |
Fills the PublisherQos with the publisher profile with profile_name
to be found in the provided XML.
xml | Raw XML string containing the profile to be used to fill the qos structure. |
qos | PublisherQos object where the qos is returned. |
profile_name | Publisher profile name. |
FASTDDS_EXPORTED_API const DomainParticipantQos & get_qos | ( | ) | const |
This operation returns the value of the DomainParticipant QoS policies.
FASTDDS_EXPORTED_API ReturnCode_t get_qos | ( | DomainParticipantQos & | qos | ) | const |
This operation returns the value of the DomainParticipant QoS policies.
qos | DomainParticipantQos reference where the qos is going to be returned |
FASTDDS_EXPORTED_API ReturnCode_t get_replier_qos_from_profile | ( | const std::string & | profile_name, |
ReplierQos & | qos ) const |
Fills the ReplierQos with the values of the XML profile.
profile_name | Replier profile name. |
qos | ReplierQos object where the qos is returned. |
FASTDDS_EXPORTED_API ReturnCode_t get_replier_qos_from_xml | ( | const std::string & | xml, |
ReplierQos & | qos ) const |
Fills the ReplierQos with the first replier profile found in the provided XML.
xml | Raw XML string containing the profile to be used to fill the qos structure. |
qos | ReplierQos object where the qos is returned. |
FASTDDS_EXPORTED_API ReturnCode_t get_replier_qos_from_xml | ( | const std::string & | xml, |
ReplierQos & | qos, | ||
const std::string & | profile_name ) const |
Fills the ReplierQos with the replier profile with profile_name
to be found in the provided XML.
xml | Raw XML string containing the profile to be used to fill the qos structure. |
qos | ReplierQos object where the qos is returned. |
profile_name | Replier profile name. |
FASTDDS_EXPORTED_API ReturnCode_t get_requester_qos_from_profile | ( | const std::string & | profile_name, |
RequesterQos & | qos ) const |
Fills the RequesterQos with the values of the XML profile.
profile_name | Requester profile name. |
qos | RequesterQos object where the qos is returned. |
FASTDDS_EXPORTED_API ReturnCode_t get_requester_qos_from_xml | ( | const std::string & | xml, |
RequesterQos & | qos ) const |
Fills the RequesterQos with the first requester profile found in the provided XML.
xml | Raw XML string containing the profile to be used to fill the qos structure. |
qos | RequesterQos object where the qos is returned. |
FASTDDS_EXPORTED_API ReturnCode_t get_requester_qos_from_xml | ( | const std::string & | xml, |
RequesterQos & | qos, | ||
const std::string & | profile_name ) const |
Fills the RequesterQos with the requester profile with profile_name
to be found in the provided XML.
xml | Raw XML string containing the profile to be used to fill the qos structure. |
qos | RequesterQos object where the qos is returned. |
profile_name | Requester profile name. |
FASTDDS_EXPORTED_API ReturnCode_t get_subscriber_qos_from_profile | ( | const std::string & | profile_name, |
SubscriberQos & | qos ) const |
Fills the SubscriberQos with the values of the XML profile.
profile_name | Subscriber profile name. |
qos | SubscriberQos object where the qos is returned. |
FASTDDS_EXPORTED_API ReturnCode_t get_subscriber_qos_from_xml | ( | const std::string & | xml, |
SubscriberQos & | qos ) const |
Fills the SubscriberQos with the first subscriber profile found in the provided XML.
xml | Raw XML string containing the profile to be used to fill the qos structure. |
qos | SubscriberQos object where the qos is returned. |
FASTDDS_EXPORTED_API ReturnCode_t get_subscriber_qos_from_xml | ( | const std::string & | xml, |
SubscriberQos & | qos, | ||
const std::string & | profile_name ) const |
Fills the SubscriberQos with the subscriber profile with profile_name
to be found in the provided XML.
xml | Raw XML string containing the profile to be used to fill the qos structure. |
qos | SubscriberQos object where the qos is returned. |
profile_name | Subscriber profile name. |
FASTDDS_EXPORTED_API ReturnCode_t get_topic_qos_from_profile | ( | const std::string & | profile_name, |
TopicQos & | qos ) const |
Fills the TopicQos with the values of the XML profile.
FASTDDS_EXPORTED_API ReturnCode_t get_topic_qos_from_profile | ( | const std::string & | profile_name, |
TopicQos & | qos, | ||
std::string & | topic_name, | ||
std::string & | topic_data_type ) const |
Fills the TopicQos with the values of the XML profile, and also its corresponding topic and data type names (if specified).
profile_name | Topic profile name. |
qos | TopicQos object where the qos is returned. |
topic_name | String where the name of the topic associated to this profile is returned (if specified). |
topic_data_type | String where the name of the topic data type associated to this profile is returned (if specified). |
FASTDDS_EXPORTED_API ReturnCode_t get_topic_qos_from_xml | ( | const std::string & | xml, |
TopicQos & | qos ) const |
Fills the TopicQos with the first topic profile found in the provided XML.
xml | Raw XML string containing the profile to be used to fill the qos structure. |
qos | TopicQos object where the qos is returned. |
FASTDDS_EXPORTED_API ReturnCode_t get_topic_qos_from_xml | ( | const std::string & | xml, |
TopicQos & | qos, | ||
const std::string & | profile_name ) const |
Fills the TopicQos with the topic profile with profile_name
to be found in the provided XML.
xml | Raw XML string containing the profile to be used to fill the qos structure. |
qos | TopicQos object where the qos is returned. |
profile_name | Topic profile name. |
FASTDDS_EXPORTED_API ReturnCode_t get_topic_qos_from_xml | ( | const std::string & | xml, |
TopicQos & | qos, | ||
std::string & | topic_name, | ||
std::string & | topic_data_type ) const |
Fills the TopicQos with the first topic profile found in the provided XML, and also its corresponding topic and data type names (if specified).
xml | Raw XML string containing the profile to be used to fill the qos structure. |
qos | TopicQos object where the qos is returned. |
topic_name | String where the name of the topic associated to this profile is returned (if specified). |
topic_data_type | String where the name of the topic data type associated to this profile is returned (if specified). |
FASTDDS_EXPORTED_API ReturnCode_t get_topic_qos_from_xml | ( | const std::string & | xml, |
TopicQos & | qos, | ||
std::string & | topic_name, | ||
std::string & | topic_data_type, | ||
const std::string & | profile_name ) const |
Fills the TopicQos with the topic profile with profile_name
to be found in the provided XML, and also its corresponding topic and data type names (if specified).
xml | Raw XML string containing the profile to be used to fill the qos structure. |
qos | TopicQos object where the qos is returned. |
topic_name | String where the name of the topic associated to this profile is returned (if specified). |
topic_data_type | String where the name of the topic data type associated to this profile is returned (if specified). |
profile_name | Topic profile name. |
FASTDDS_EXPORTED_API const fastdds::rtps::GUID_t & guid | ( | ) | const |
Getter for the Participant GUID.
FASTDDS_EXPORTED_API bool has_active_entities | ( | ) |
Check if the Participant has any Publisher, Subscriber or Topic.
FASTDDS_EXPORTED_API ReturnCode_t ignore_participant | ( | const InstanceHandle_t & | handle | ) |
Locally ignore a remote domain participant.
handle | Identifier of the remote participant to ignore |
FASTDDS_EXPORTED_API ReturnCode_t ignore_publication | ( | const InstanceHandle_t & | handle | ) |
Locally ignore a remote datawriter.
handle | Identifier of the datawriter to ignore |
FASTDDS_EXPORTED_API ReturnCode_t ignore_subscription | ( | const InstanceHandle_t & | handle | ) |
Locally ignore a remote datareader.
handle | Identifier of the datareader to ignore |
FASTDDS_EXPORTED_API ReturnCode_t ignore_topic | ( | const InstanceHandle_t & | handle | ) |
Locally ignore a topic.
handle | Identifier of the topic to ignore |
FASTDDS_EXPORTED_API IContentFilterFactory * lookup_content_filter_factory | ( | const char * | filter_class_name | ) |
Lookup a custom content filter factory previously registered with register_content_filter_factory.
filter_class_name | Name of the filter class. Cannot be nullptr. |
FASTDDS_EXPORTED_API TopicDescription * lookup_topicdescription | ( | const std::string & | topic_name | ) | const |
Looks up an existing, locally created TopicDescription, based on its name.
May be called on a disabled participant.
topic_name | Name of the TopicDescription to search for. |
FASTDDS_EXPORTED_API bool new_remote_endpoint_discovered | ( | const fastdds::rtps::GUID_t & | partguid, |
uint16_t | userId, | ||
fastdds::rtps::EndpointKind_t | kind ) |
This method can be used when using a StaticEndpointDiscovery mechanism different that the one included in Fast DDS, for example when communicating with other implementations.
It indicates the Participant that an Endpoint from the XML has been discovered and should be activated.
partguid | Participant GUID_t. |
userId | User defined ID as shown in the XML file. |
kind | EndpointKind (WRITER or READER) |
FASTDDS_EXPORTED_API ReturnCode_t register_content_filter_factory | ( | const char * | filter_class_name, |
IContentFilterFactory *const | filter_factory ) |
Register a custom content filter factory, which can be used to create a ContentFilteredTopic.
DDS specifies a SQL-like content filter to be used by content filtered topics. If this filter does not meet your filtering requirements, you can register a custom filter factory.
To use a custom filter, a factory for it must be registered in the following places:
For example, suppose Application A on the subscription side creates a Topic named X and a ContentFilteredTopic named filteredX (and a corresponding DataReader), using a previously registered content filter factory, myFilterFactory. With only that, you will have filtering at the subscription side. If you also want to perform filtering in any application that publishes Topic X, then you also need to register the same definition of the ContentFilterFactory myFilterFactory in that application.
Each filter_class_name
can only be used to register a content filter factory once per DomainParticipant.
filter_class_name | Name of the filter class. Cannot be nullptr, must not exceed 255 characters, and must be unique within this DomainParticipant. |
filter_factory | Factory of content filters to be registered. Cannot be nullptr. |
FASTDDS_EXPORTED_API ReturnCode_t register_type | ( | TypeSupport | type | ) |
Register a type in this participant.
type | TypeSupport. |
FASTDDS_EXPORTED_API ReturnCode_t register_type | ( | TypeSupport | type, |
const std::string & | type_name ) |
Register a type in this participant.
type | TypeSupport. |
type_name | The name that will be used to identify the Type. |
FASTDDS_EXPORTED_API ReturnCode_t set_default_publisher_qos | ( | const PublisherQos & | qos | ) |
This operation sets a default value of the Publisher QoS policies which will be used for newly created Publisher entities in the case where the QoS policies are defaulted in the create_publisher 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 PUBLISHER_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_publisher_qos operation had never been called.
qos | PublisherQos to be set |
FASTDDS_EXPORTED_API ReturnCode_t set_default_subscriber_qos | ( | const SubscriberQos & | qos | ) |
This operation sets a default value of the Subscriber QoS policies that will be used for newly created Subscriber entities in the case where the QoS policies are defaulted in the create_subscriber 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 SUBSCRIBER_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_subscriber_qos operation had never been called.
qos | SubscriberQos to be set |
FASTDDS_EXPORTED_API ReturnCode_t set_default_topic_qos | ( | const TopicQos & | qos | ) |
This operation sets a default value of the Topic QoS policies which will be used for newly created Topic entities in the case where the QoS policies are defaulted in the create_topic operation.
This operation will check that the resulting policies are self consistent; if they are not, the operation will have no effect and return INCONSISTENT_POLICY.
The special value TOPIC_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_topic_qos operation had never been called.
qos | TopicQos to be set |
FASTDDS_EXPORTED_API ReturnCode_t set_listener | ( | DomainParticipantListener * | listener | ) |
Modifies the DomainParticipantListener, sets the mask to StatusMask::all()
listener | New value for the DomainParticipantListener |
DomainParticipantListener
callback. FASTDDS_EXPORTED_API ReturnCode_t set_listener | ( | DomainParticipantListener * | listener, |
const StatusMask & | mask ) |
Modifies the DomainParticipantListener.
listener | New value for the DomainParticipantListener |
mask | StatusMask that holds statuses the listener responds to |
DomainParticipantListener
callback. FASTDDS_EXPORTED_API ReturnCode_t set_listener | ( | DomainParticipantListener * | listener, |
const StatusMask & | mask, | ||
const std::chrono::seconds | timeout ) |
Modifies the DomainParticipantListener.
listener | New value for the DomainParticipantListener |
mask | StatusMask that holds statuses the listener responds to |
timeout | Maximum time to wait for executing callbacks to finish. |
DomainParticipantListener
callback. FASTDDS_EXPORTED_API ReturnCode_t set_listener | ( | DomainParticipantListener * | listener, |
const std::chrono::seconds | timeout ) |
Modifies the DomainParticipantListener, sets the mask to StatusMask::all()
listener | New value for the DomainParticipantListener |
timeout | Maximum time to wait for executing callbacks to finish. |
DomainParticipantListener
callback. FASTDDS_EXPORTED_API ReturnCode_t set_qos | ( | const DomainParticipantQos & | qos | ) | const |
This operation sets the value of the DomainParticipant QoS policies.
qos | DomainParticipantQos to be set |
FASTDDS_EXPORTED_API ReturnCode_t unregister_content_filter_factory | ( | const char * | filter_class_name | ) |
Unregister a custom content filter factory previously registered with register_content_filter_factory.
A filter_class_name can be unregistered only if it has been previously registered to the DomainParticipant with register_content_filter_factory.
The unregistration of filter is not allowed if there are any existing ContentFilteredTopic objects that are using the filter.
If there is any existing discovered DataReader with the same filter_class_name, filtering on the writer side will be stopped, but this operation will not fail.
filter_class_name | Name of the filter class. Cannot be nullptr. |
FASTDDS_EXPORTED_API ReturnCode_t unregister_type | ( | const std::string & | typeName | ) |
Unregister a type in this participant.
typeName | Name of the type |
|
friend |
|
friend |
|
friend |
|
protected |