Qos Policy to configure the data sharing. More...
#include <QosPolicies.hpp>
Public Member Functions | |
FASTDDS_EXPORTED_API | DataSharingQosPolicy () |
Constructor. | |
virtual FASTDDS_EXPORTED_API | ~DataSharingQosPolicy ()=default |
Destructor. | |
FASTDDS_EXPORTED_API | DataSharingQosPolicy (const DataSharingQosPolicy &b) |
Copy constructor. | |
FASTDDS_EXPORTED_API DataSharingQosPolicy & | operator= (const DataSharingQosPolicy &b) |
bool | operator== (const DataSharingQosPolicy &b) const |
void | clear () override |
Clears the QosPolicy object. | |
FASTDDS_EXPORTED_API const DataSharingKind & | kind () const |
FASTDDS_EXPORTED_API const std::string & | shm_directory () const |
FASTDDS_EXPORTED_API const std::vector< uint64_t > & | domain_ids () const |
Gets the set of DataSharing domain IDs. | |
FASTDDS_EXPORTED_API void | set_max_domains (uint32_t size) |
FASTDDS_EXPORTED_API const uint32_t & | max_domains () const |
FASTDDS_EXPORTED_API void | automatic () |
Configures the DataSharing in automatic mode. | |
FASTDDS_EXPORTED_API void | automatic (const std::vector< uint16_t > &domain_ids) |
Configures the DataSharing in automatic mode. | |
FASTDDS_EXPORTED_API void | automatic (const std::string &directory) |
Configures the DataSharing in automatic mode. | |
FASTDDS_EXPORTED_API void | automatic (const std::string &directory, const std::vector< uint16_t > &domain_ids) |
Configures the DataSharing in automatic mode. | |
FASTDDS_EXPORTED_API void | on (const std::string &directory) |
Configures the DataSharing in active mode. | |
FASTDDS_EXPORTED_API void | on (const std::string &directory, const std::vector< uint16_t > &domain_ids) |
Configures the DataSharing in active mode. | |
FASTDDS_EXPORTED_API void | off () |
Configures the DataSharing in disabled mode. | |
FASTDDS_EXPORTED_API void | add_domain_id (uint16_t id) |
Adds a user-specific DataSharing domain ID. | |
void | add_domain_id (uint64_t id) |
rtps::ThreadSettings & | data_sharing_listener_thread () |
Getter for DataSharing listener thread ThreadSettings. | |
const rtps::ThreadSettings & | data_sharing_listener_thread () const |
Getter for DataSharing listener thread ThreadSettings. | |
void | data_sharing_listener_thread (const rtps::ThreadSettings &value) |
Setter for the DataSharing listener thread ThreadSettings. | |
![]() | |
FASTDDS_EXPORTED_API | Parameter_t () |
Constructor without parameters. | |
FASTDDS_EXPORTED_API | Parameter_t (ParameterId_t pid, uint16_t length) |
Constructor using a parameter PID and the parameter length. | |
virtual FASTDDS_EXPORTED_API | ~Parameter_t () |
Destructor. | |
bool | operator== (const Parameter_t &b) const |
![]() | |
QosPolicy () | |
Constructor without parameters. | |
QosPolicy (bool send_always) | |
Constructor. | |
QosPolicy (const QosPolicy &b)=default | |
Copy Constructor. | |
virtual | ~QosPolicy ()=default |
Destructor. | |
bool | operator== (const QosPolicy &b) const |
QosPolicy & | operator= (const QosPolicy &b)=default |
virtual bool | send_always () const |
Whether it should always be sent. | |
Additional Inherited Members | |
![]() | |
ParameterId_t | Pid |
Parameter ID. By default, PID_PAD. | |
uint16_t | length |
Parameter length. By default, 0. | |
![]() | |
bool | hasChanged |
Boolean that indicates if the Qos has been changed with respect to the default Qos. | |
![]() | |
bool | send_always_ |
Boolean that indicates if the Qos has to be sent even if it is not changed. | |
Qos Policy to configure the data sharing.
|
inline |
Constructor.
|
virtualdefault |
Destructor.
|
inline |
Copy constructor.
b | Another DataSharingQosPolicy instance |
|
inline |
Adds a user-specific DataSharing domain ID.
id | 16 bit identifier |
|
inline |
|
inline |
Configures the DataSharing in automatic mode.
The default shared memory directory of the OS is used. A default domain ID is automatically computed.
|
inline |
Configures the DataSharing in automatic mode.
A default domain ID is automatically computed.
directory | The shared memory directory to use. |
|
inline |
Configures the DataSharing in automatic mode.
directory | The shared memory directory to use. |
domain_ids | the user configured DataSharing domain IDs (16 bits). |
|
inline |
Configures the DataSharing in automatic mode.
The default shared memory directory of the OS is used.
domain_ids | the user configured DataSharing domain IDs (16 bits). |
|
inline |
Getter for DataSharing listener thread ThreadSettings.
|
inline |
Getter for DataSharing listener thread ThreadSettings.
|
inline |
Setter for the DataSharing listener thread ThreadSettings.
value | New ThreadSettings to be set |
|
inline |
Gets the set of DataSharing domain IDs.
Each domain ID is 64 bit long. However, user-defined domain IDs are only 16 bit long, while the rest of the 48 bits are used for the automatically generated domain ID (if any).
|
inline |
|
inline |
|
inline |
Configures the DataSharing in disabled mode.
|
inline |
Configures the DataSharing in active mode.
A default domain ID is automatically computed.
directory | The shared memory directory to use. It is mandatory to provide a non-empty name or the creation of endpoints will fail. |
|
inline |
Configures the DataSharing in active mode.
directory | The shared memory directory to use. It is mandatory to provide a non-empty name or the creation of endpoints will fail. |
domain_ids | the user configured DataSharing domain IDs (16 bits). |
|
inline |
|
inline |
|
inline |
size | the new maximum number of domain IDs |
|
inline |