Class RTPSParticipant, contains the public API for a RTPSParticipant. More...
#include <RTPSParticipant.hpp>
Public Member Functions | |
const GUID_t & | getGuid () const |
Get the GUID_t of the RTPSParticipant. | |
void | announceRTPSParticipantState () |
Force the announcement of the RTPSParticipant state. | |
void | stopRTPSParticipantAnnouncement () |
Stop the RTPSParticipant announcement period. //TODO remove this method because is only for testing. | |
void | resetRTPSParticipantAnnouncement () |
Reset the RTPSParticipant announcement period. //TODO remove this method because is only for testing. | |
bool | newRemoteWriterDiscovered (const GUID_t &pguid, int16_t userDefinedId) |
Indicate the Participant that you have discovered a new Remote Writer. | |
bool | newRemoteReaderDiscovered (const GUID_t &pguid, int16_t userDefinedId) |
Indicate the Participant that you have discovered a new Remote Reader. | |
uint32_t | getRTPSParticipantID () const |
Get the Participant ID. | |
bool | register_writer (RTPSWriter *rtps_writer, const TopicDescription &topic, const fastdds::dds::WriterQos &qos) |
Register a Writer in the BuiltinProtocols. | |
bool | register_reader (RTPSReader *rtps_reader, const TopicDescription &topic, const fastdds::dds::ReaderQos &qos, const ContentFilterProperty *content_filter=nullptr) |
Register a Reader in the BuiltinProtocols. | |
void | update_attributes (const RTPSParticipantAttributes &patt) |
Update participant attributes. | |
bool | update_writer (RTPSWriter *rtps_writer, const fastdds::dds::WriterQos &wqos) |
Update local writer QoS. | |
bool | update_reader (RTPSReader *rtps_reader, const fastdds::dds::ReaderQos &rqos, const ContentFilterProperty *content_filter=nullptr) |
Update local reader QoS. | |
std::vector< std::string > | getParticipantNames () const |
Returns a list with the participant names. | |
const RTPSParticipantAttributes & | get_attributes () const |
Get a reference of the current state of the RTPSParticipantParameters. | |
uint32_t | getMaxMessageSize () const |
Retrieves the maximum message size. | |
uint32_t | getMaxDataSize () const |
Retrieves the maximum data size. | |
ResourceEvent & | get_resource_event () const |
WLP * | wlp () const |
A method to retrieve the built-in writer liveliness protocol. | |
bool | get_new_entity_id (EntityId_t &entityId) |
Fills a new entityId if set to unknown, or checks if a entity already exists with that entityId in other case. | |
void | set_check_type_function (std::function< bool(const std::string &)> &&check_type) |
Allows setting a function to check if a type is already known by the top level API participant. | |
void | set_listener (RTPSParticipantListener *listener) |
Modifies the participant listener. | |
uint32_t | get_domain_id () const |
Retrieves the DomainId. | |
void | enable () |
This operation enables the RTPSParticipantImpl. | |
bool | ignore_participant (const GuidPrefix_t &participant_guid) |
Ignore all messages coming from the RTPSParticipant. | |
bool | ignore_writer (const GUID_t &writer_guid) |
Ignore all messages coming from the RTPSWriter. | |
bool | ignore_reader (const GUID_t &reader_guid) |
Ignore all messages coming from the RTPSReader. | |
std::vector< TransportNetmaskFilterInfo > | get_netmask_filter_info () const |
Returns registered transports' netmask filter information (transport's netmask filter kind and allowlist). | |
Protected Attributes | |
RTPSParticipantImpl * | mp_impl |
Pointer to the implementation. | |
Friends | |
class | RTPSParticipantImpl |
class | RTPSDomain |
class | RTPSDomainImpl |
Class RTPSParticipant, contains the public API for a RTPSParticipant.
void announceRTPSParticipantState | ( | ) |
Force the announcement of the RTPSParticipant state.
void enable | ( | ) |
This operation enables the RTPSParticipantImpl.
const RTPSParticipantAttributes & get_attributes | ( | ) | const |
Get a reference of the current state of the RTPSParticipantParameters.
uint32_t get_domain_id | ( | ) | const |
Retrieves the DomainId.
std::vector< TransportNetmaskFilterInfo > get_netmask_filter_info | ( | ) | const |
Returns registered transports' netmask filter information (transport's netmask filter kind and allowlist).
bool get_new_entity_id | ( | EntityId_t & | entityId | ) |
Fills a new entityId if set to unknown, or checks if a entity already exists with that entityId in other case.
entityId | to check of fill. If filled, EntityKind will be "vendor-specific" (0x01) |
ResourceEvent & get_resource_event | ( | ) | const |
const GUID_t & getGuid | ( | ) | const |
Get the GUID_t of the RTPSParticipant.
uint32_t getMaxDataSize | ( | ) | const |
Retrieves the maximum data size.
uint32_t getMaxMessageSize | ( | ) | const |
Retrieves the maximum message size.
std::vector< std::string > getParticipantNames | ( | ) | const |
Returns a list with the participant names.
uint32_t getRTPSParticipantID | ( | ) | const |
Get the Participant ID.
bool ignore_participant | ( | const GuidPrefix_t & | participant_guid | ) |
Ignore all messages coming from the RTPSParticipant.
[in] | participant_guid | RTPSParticipant GUID to be ignored |
bool ignore_reader | ( | const GUID_t & | reader_guid | ) |
Ignore all messages coming from the RTPSReader.
[in] | reader_guid | RTPSReader GUID to be ignored |
bool ignore_writer | ( | const GUID_t & | writer_guid | ) |
Ignore all messages coming from the RTPSWriter.
[in] | writer_guid | RTPSWriter GUID to be ignored |
bool newRemoteReaderDiscovered | ( | const GUID_t & | pguid, |
int16_t | userDefinedId ) |
bool newRemoteWriterDiscovered | ( | const GUID_t & | pguid, |
int16_t | userDefinedId ) |
bool register_reader | ( | RTPSReader * | rtps_reader, |
const TopicDescription & | topic, | ||
const fastdds::dds::ReaderQos & | qos, | ||
const ContentFilterProperty * | content_filter = nullptr ) |
Register a Reader in the BuiltinProtocols.
rtps_reader | Pointer to the RTPSReader. |
topic | Information regarding the topic where the reader is registering. |
qos | Qos policies of the reader. |
content_filter | Optional content filtering information. |
bool register_writer | ( | RTPSWriter * | rtps_writer, |
const TopicDescription & | topic, | ||
const fastdds::dds::WriterQos & | qos ) |
Register a Writer in the BuiltinProtocols.
rtps_writer | Pointer to the RTPSWriter. |
topic | Information regarding the topic where the writer is registering. |
qos | Qos policies of the writer. |
void resetRTPSParticipantAnnouncement | ( | ) |
Reset the RTPSParticipant announcement period. //TODO remove this method because is only for testing.
void set_check_type_function | ( | std::function< bool(const std::string &)> && | check_type | ) |
Allows setting a function to check if a type is already known by the top level API participant.
void set_listener | ( | RTPSParticipantListener * | listener | ) |
Modifies the participant listener.
listener |
void stopRTPSParticipantAnnouncement | ( | ) |
Stop the RTPSParticipant announcement period. //TODO remove this method because is only for testing.
void update_attributes | ( | const RTPSParticipantAttributes & | patt | ) |
Update participant attributes.
patt | New participant attributes. |
bool update_reader | ( | RTPSReader * | rtps_reader, |
const fastdds::dds::ReaderQos & | rqos, | ||
const ContentFilterProperty * | content_filter = nullptr ) |
Update local reader QoS.
rtps_reader | Reader to update. |
rqos | New QoS for the reader. |
content_filter | Optional content filtering information. |
bool update_writer | ( | RTPSWriter * | rtps_writer, |
const fastdds::dds::WriterQos & | wqos ) |
Update local writer QoS.
rtps_writer | Writer to update. |
wqos | New QoS for the writer. |
WLP * wlp | ( | ) | const |
A method to retrieve the built-in writer liveliness protocol.
|
friend |
|
friend |
|
friend |
|
protected |
Pointer to the implementation.