|
Safe DDS
|
DDS DomainParticipant interface. More...
#include <DomainParticipant.hpp>
Public Member Functions | |
| virtual protocol::GUID | guid () const noexcept=0 |
| Retrieves the DomainParticipant GUID. More... | |
| virtual ReturnCode | register_type (const dds::TypeSupport &type_support, const memory::IStringView &type_name) noexcept=0 |
| Register type support. More... | |
| virtual const dds::TypeSupport * | get_type (const memory::IStringView &type_name) noexcept=0 |
| Get type for given type name. More... | |
| virtual ReturnCode | set_qos (const DomainParticipantQos &qos) noexcept=0 |
| Set DomainParticipant QoS. More... | |
| virtual ReturnCode | get_qos (DomainParticipantQos &qos) const noexcept=0 |
| Get DomainParticipant QoS. More... | |
| virtual DomainParticipantQos | get_qos () const noexcept=0 |
| Get DomainParticipant QoS by value. More... | |
| virtual ReturnCode | set_listener (DomainParticipantListener *listener, const StatusMask &mask) noexcept=0 |
| Set DomainParticipant listener. More... | |
| virtual DomainParticipantListener * | get_listener () const noexcept=0 |
| Get DomainParticipant listener. More... | |
| virtual Publisher * | create_publisher (const PublisherQos &qos, PublisherListener *listener, const StatusMask &mask) noexcept=0 |
| Create a Publisher in this Domain Participant. More... | |
| virtual ReturnCode | delete_publisher (const Publisher *publisher) noexcept=0 |
| Deletes an existing Publisher. More... | |
| virtual Subscriber * | create_subscriber (const SubscriberQos &qos, SubscriberListener *listener, const StatusMask &mask) noexcept=0 |
| Create a Subscriber in this Participant. More... | |
| virtual ReturnCode | delete_subscriber (const Subscriber *subscriber) noexcept=0 |
| Deletes an existing Subscriber. More... | |
| virtual Topic * | create_topic (const memory::IStringView &topic_name, const memory::IStringView &type_name, const TopicQos &qos, TopicListener *listener, const StatusMask &mask) noexcept=0 |
| Create a Topic in this Participant. More... | |
| virtual ReturnCode | delete_topic (const Topic *topic) noexcept=0 |
| Deletes an existing Topic. More... | |
| virtual Topic * | find_topic (const memory::IStringView &topic_name, const execution::TimePeriod &timeout) noexcept=0 |
| Gives access to an existing (or ready to exist) enabled Topic. More... | |
| virtual TopicDescription * | lookup_topicdescription (const memory::IStringView &topic_name) const noexcept=0 |
| Looks up an existing, locally created TopicDescription, based on its name. More... | |
| virtual const Subscriber * | get_builtin_subscriber () const noexcept=0 |
| Allows access to the builtin Subscriber. More... | |
| virtual ReturnCode | ignore_participant (const InstanceHandle &handle) noexcept=0 |
| Locally ignore a remote domain participant. More... | |
| virtual ReturnCode | ignore_topic (const InstanceHandle &handle) noexcept=0 |
| Locally ignore a topic. More... | |
| virtual ReturnCode | ignore_publication (const InstanceHandle &handle) noexcept=0 |
| Locally ignore a datawriter. More... | |
| virtual ReturnCode | ignore_subscription (const InstanceHandle &handle) noexcept=0 |
| Locally ignore a datareader. More... | |
| virtual DomainId | get_domain_id () const noexcept=0 |
| This operation retrieves the domain_id used to create the DomainParticipant. More... | |
| virtual ReturnCode | delete_contained_entities () noexcept=0 |
| Deletes all the entities that were created by means of the “create” methods. More... | |
| virtual ReturnCode | assert_liveliness () noexcept=0 |
| This operation manually asserts the liveliness of the DomainParticipant. More... | |
| virtual ReturnCode | set_default_publisher_qos (const PublisherQos &qos) noexcept=0 |
| 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. More... | |
| virtual ReturnCode | get_default_publisher_qos (PublisherQos &qos) const noexcept=0 |
| 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. More... | |
| virtual ReturnCode | set_default_subscriber_qos (const SubscriberQos &qos) noexcept=0 |
| 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. More... | |
| virtual ReturnCode | get_default_subscriber_qos (SubscriberQos &qos) const noexcept=0 |
| 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. More... | |
| virtual ReturnCode | set_default_topic_qos (const TopicQos &qos) noexcept=0 |
| 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. More... | |
| virtual ReturnCode | get_default_topic_qos (TopicQos &qos) const noexcept=0 |
| 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. More... | |
| virtual ReturnCode | get_discovered_participant_data (ParticipantBuiltinTopicData &participant_data, const InstanceHandle &participant_handle) const noexcept=0 |
| Retrieves the DomainParticipant data of a discovered participant. More... | |
| virtual ReturnCode | get_discovered_participants (memory::IList< InstanceHandle > &participant_handles) const noexcept=0 |
| Fills a vector with the InstanceHandles of the discovered participants. More... | |
| virtual ReturnCode | get_discovered_topic_data (TopicBuiltinTopicData &topic_data, const InstanceHandle &topic_handle) const noexcept=0 |
| Retrieves the Topic data of a discovered topic. More... | |
| virtual ReturnCode | get_discovered_topics (memory::IList< InstanceHandle > &topic_handles) const noexcept=0 |
| Fills a vector with the InstanceHandles of the discovered topics. More... | |
| virtual bool | contains_entity (const InstanceHandle &handle, bool recursive) const noexcept=0 |
| This operation checks whether or not the given handle represents an Entity that was created from the DomainParticipant. More... | |
| virtual ReturnCode | get_current_time (execution::TimePoint ¤t_time) const noexcept=0 |
| 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. More... | |
| virtual ContentFilteredTopic * | create_contentfilteredtopic (const memory::IStringView &name, Topic *related_topic, const memory::IStringView &filter_expression, const memory::IStringViewSequence &expression_parameters) noexcept=0 |
| Create content filtered topic. More... | |
| virtual ReturnCode | delete_contentfilteredtopic (ContentFilteredTopic *topic) noexcept=0 |
| Delete content filtered topic. More... | |
| virtual MultiTopic * | create_multitopic (const memory::IStringView &name, const memory::IStringView &type_name, const memory::IStringView &subscription_expression, const memory::IStringViewSequence &expression_parameters) noexcept=0 |
| Create multi topic. More... | |
| virtual ReturnCode | delete_multitopic (MultiTopic *topic) noexcept=0 |
| Delete multi topic. More... | |
Public Member Functions inherited from eprosima::safedds::dds::Entity | |
| virtual ReturnCode | enable () noexcept=0 |
| Enables the entity. More... | |
| virtual bool | is_enabled () const noexcept=0 |
| Check if the entity and its hierarchically ascending entities are enabled. More... | |
| virtual StatusCondition * | get_statuscondition () &noexcept=0 |
| Retrieves entity status condition. Can only be used on lvalue objects. More... | |
| virtual StatusMask | get_status_changes () const noexcept=0 |
| Retrieves the set of triggered statuses in the Entity. More... | |
| virtual InstanceHandle | get_instance_handle () const noexcept=0 |
| Retrieves the instance handler that represents the Entity. More... | |
| execution::ISpinnable * | get_spinnable () &&noexcept=delete |
| Deletes get_spinnable for rvalue objects to avoid usage of a dangling pointer (Helix Rule-6.4.2) More... | |
| virtual execution::ISpinnable * | get_spinnable () &noexcept=0 |
| Retrieves the spinnable interface of the entity in case it has one, otherwise returns nullptr. More... | |
Protected Member Functions | |
| ~DomainParticipant () noexcept=default | |
| Protected destructor ownership defined on creation. More... | |
| DomainParticipant () noexcept=default | |
| Default creation. More... | |
| DomainParticipant (const DomainParticipant &) noexcept=default | |
| Copy allowed. More... | |
| DomainParticipant (DomainParticipant &&) noexcept=default | |
| Movement allowed. More... | |
| DomainParticipant & | operator= (const DomainParticipant &) noexcept=default |
| Copy operator allowed. More... | |
| DomainParticipant & | operator= (DomainParticipant &&) noexcept=default |
| Movement operator allowed. More... | |
Protected Member Functions inherited from eprosima::safedds::dds::Entity | |
| ~Entity () noexcept=default | |
| Protected destructor ownership defined on creation. More... | |
| Entity () noexcept=default | |
| Default creation. More... | |
| Entity (const Entity &) noexcept=default | |
| Copy allowed. More... | |
| Entity (Entity &&) noexcept=default | |
| Movement allowed. More... | |
| Entity & | operator= (const Entity &) noexcept=default |
| Copy operator allowed. More... | |
| Entity & | operator= (Entity &&) noexcept=default |
| Movement operator allowed. More... | |
DDS DomainParticipant interface.
|
protecteddefaultnoexcept |
Protected destructor ownership defined on creation.
|
protecteddefaultnoexcept |
Default creation.
|
protecteddefaultnoexcept |
Copy allowed.
|
protecteddefaultnoexcept |
Movement allowed.
|
pure virtualnoexcept |
This operation manually asserts the liveliness of the DomainParticipant.
|
pure virtualnoexcept |
This operation checks whether or not the given handle represents an Entity that was created from the DomainParticipant.
| [in] | handle | InstanceHandle of the entity to look for. |
| recursive | The containment applies recursively. |
|
pure virtualnoexcept |
Create content filtered topic.
| [in] | name | Name of the ContentFilteredTopic. |
| [in] | related_topic | Topic to be filtered. |
| [in] | filter_expression | Filter expression. |
| [in] | expression_parameters | Filter parameters. |
|
pure virtualnoexcept |
Create multi topic.
| [in] | name | Name of the MultiTopic. |
| [in] | type_name | Type name. |
| [in] | subscription_expression | Subscription expression. |
| [in] | expression_parameters | Expression parameters. |
|
pure virtualnoexcept |
|
pure virtualnoexcept |
Create a Subscriber in this Participant.
| [in] | qos | QoS of the Subscriber. |
| [in,out] | listener | Pointer to the listener (default: nullptr) |
| [in] | mask | StatusMask that holds statuses the listener responds to (default: all) |
|
pure virtualnoexcept |
Create a Topic in this Participant.
| [in] | topic_name | Name of the Topic. Ownership is not taken |
| [in] | type_name | Data type of the Topic. Ownership is not taken |
| [in] | qos | QoS of the Topic. |
| [in,out] | listener | Pointer to the listener (default: nullptr) |
| [in] | mask | StatusMask that holds statuses the listener responds to (default: all) |
|
pure virtualnoexcept |
Deletes all the entities that were created by means of the “create” methods.
|
pure virtualnoexcept |
Delete content filtered topic.
| [in] | topic | ContentFilteredTopic to be deleted. |
|
pure virtualnoexcept |
Delete multi topic.
| [in] | topic | MultiTopic to be deleted. |
|
pure virtualnoexcept |
Deletes an existing Publisher.
| [in] | publisher | to be deleted. |
|
pure virtualnoexcept |
Deletes an existing Subscriber.
| [in] | subscriber | to be deleted. |
|
pure virtualnoexcept |
|
pure virtualnoexcept |
|
pure virtualnoexcept |
Allows access to the builtin Subscriber.
|
pure virtualnoexcept |
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.
| [out] | current_time | Time_t reference where the current time is returned |
|
pure virtualnoexcept |
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.
| [out] | qos | PublisherQos reference where the default_publisher_qos is returned |
|
pure virtualnoexcept |
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.
| [out] | qos | SubscriberQos reference where the default_subscriber_qos is returned |
|
pure virtualnoexcept |
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.
| [out] | qos | TopicQos reference where the default_topic_qos is returned |
|
pure virtualnoexcept |
Retrieves the DomainParticipant data of a discovered participant.
| [out] | participant_data | Reference to the ParticipantBuiltinTopicData object to return the data |
| [in] | participant_handle | InstanceHandle of DomainParticipant to retrieve the data from |
|
pure virtualnoexcept |
Fills a vector with the InstanceHandles of the discovered participants.
| [out] | participant_handles | Vector to be filled with the InstanceHandles of the discovered participants. |
|
pure virtualnoexcept |
Retrieves the Topic data of a discovered topic.
| [out] | topic_data | Reference to the TopicBuiltinTopicData object to return the data |
| [in] | topic_handle | InstanceHandle of DomainParticipant to retrieve the data from |
|
pure virtualnoexcept |
Fills a vector with the InstanceHandles of the discovered topics.
| [out] | topic_handles | Vector to be filled with the InstanceHandles of the discovered topics. |
|
pure virtualnoexcept |
This operation retrieves the domain_id used to create the DomainParticipant.
|
pure virtualnoexcept |
Get DomainParticipant listener.
|
pure virtualnoexcept |
Get DomainParticipant QoS by value.
|
pure virtualnoexcept |
|
pure virtualnoexcept |
Get type for given type name.
| [in] | type_name | type name. |
|
pure virtualnoexcept |
Retrieves the DomainParticipant GUID.
|
pure virtualnoexcept |
Locally ignore a remote domain participant.
| [in] | handle | Identifier of the remote participant to ignore |
|
pure virtualnoexcept |
Locally ignore a datawriter.
| [in] | handle | Identifier of the datawriter to ignore |
|
pure virtualnoexcept |
Locally ignore a datareader.
| [in] | handle | Identifier of the datareader to ignore |
|
pure virtualnoexcept |
Locally ignore a topic.
| [in] | handle | Identifier of the topic to ignore |
|
pure virtualnoexcept |
Looks up an existing, locally created TopicDescription, based on its name.
| [in] | topic_name | Name of the TopicDescription to search for. |
|
protecteddefaultnoexcept |
Copy operator allowed.
|
protecteddefaultnoexcept |
Movement operator allowed.
|
pure virtualnoexcept |
Register type support.
| [in] | type_support | type support. |
| [in] | type_name | type name. |
|
pure virtualnoexcept |
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.
| [in] | qos | PublisherQos to be set |
|
pure virtualnoexcept |
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.
| [in] | qos | SubscriberQos to be set |
|
pure virtualnoexcept |
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.
| [in] | qos | TopicQos to be set |
|
pure virtualnoexcept |
Set DomainParticipant listener.
| [in,out] | listener | domain participant listener. |
| [in] | mask | listener configuration. |
|
pure virtualnoexcept |