#include <CorePolicy.hpp>
Inheritance diagram for UserData< D >:
Public Member Functions | |
| UserData () | |
| UserData (const dds::core::ByteSeq &seq) | |
| UserData (const uint8_t *value_begin, const uint8_t *value_end) | |
| void | value (const dds::core::ByteSeq &seq) |
| template<typename OCTET_ITER > | |
| void | value (OCTET_ITER begin, OCTET_ITER end) |
| const dds::core::ByteSeq | value () const |
| dds::core::ByteSeq & | value (dds::core::ByteSeq &dst) const |
| const uint8_t * | begin () const |
| const uint8_t * | end () const |
Detailed Description
template<typename D>
class tdds::core::policy::UserData< D >
The purpose of this QoS is to allow the application to attach additional information to the created Entity objects such that when a remote application discovers their existence it can access that information and use it for its own purposes. One possible use of this QoS is to attach security credentials or some other information that can be used by the remote application to authenticate the source. In combination with operations such as ignore_participant, ignore_publication, ignore_subscription, and ignore_topic these QoS can assist an application to define and enforce its own security policies. The use of this QoS is not limited to security, rather it offers a simple, yet flexible extensibility mechanism.
Definition at line 46 of file CorePolicy.hpp.
Constructor & Destructor Documentation
| UserData | ( | ) | [inline] |
Create a UserData instance with an empty user data.
Definition at line 51 of file CorePolicy.hpp.
| UserData | ( | const dds::core::ByteSeq & | seq | ) | [inline, explicit] |
Create a UserData instance.
- Parameters:
-
seq the sequence of octet representing the user data
Definition at line 58 of file CorePolicy.hpp.
| UserData | ( | const uint8_t * | value_begin, | |
| const uint8_t * | value_end | |||
| ) |
Member Function Documentation
| const uint8_t* begin | ( | ) | const |
| const uint8_t* end | ( | ) | const |
| void value | ( | OCTET_ITER | begin, | |
| OCTET_ITER | end | |||
| ) |
Set the value for the user data.
| dds::core::ByteSeq& value | ( | dds::core::ByteSeq & | dst | ) | const |
Get the user data.
| const dds::core::ByteSeq value | ( | ) | const [inline] |
Get the user data.
- Returns:
- the sequence of bytes representing the user data
Definition at line 83 of file CorePolicy.hpp.
| void value | ( | const dds::core::ByteSeq & | seq | ) | [inline] |
Set the value for the user data.
- Parameters:
-
seq a sequence of bytes representing the user data.
Definition at line 68 of file CorePolicy.hpp.
The documentation for this class was generated from the following file:
- src/hpp/tdds/core/policy/CorePolicy.hpp
