RTI Connext Traditional C++ API
Version 6.1.2
|
Stores (name, value) pairs that can be used to determine access permissions. More...
Classes | |
struct | DDS_Tag |
Tags are name/value pair objects. More... | |
struct | DDS_TagSeq |
Declares IDL sequence < DDS_Tag > More... | |
struct | DDS_DataTags |
Definition of DDS_DataTagQosPolicy. More... | |
class | DDSDataTagQosPolicyHelper |
Policy helpers that facilitate management of the data tags in the input policy. More... | |
Typedefs | |
typedef struct DDS_DataTags | DDS_DataTagQosPolicy |
Stores (name, value) pairs that can be used to determine access permissions. More... | |
Functions | |
static DDS_Long | DDSDataTagQosPolicyHelper::get_number_of_tags (DDS_DataTagQosPolicy &policy) |
Gets the number of data tags in the input policy. More... | |
static DDS_ReturnCode_t | DDSDataTagQosPolicyHelper::assert_tag (DDS_DataTagQosPolicy &policy, const char *name, const char *value) |
Asserts the tag identified by name in the input policy. More... | |
static DDS_ReturnCode_t | DDSDataTagQosPolicyHelper::add_tag (DDS_DataTagQosPolicy &policy, const char *name, const char *value) |
Adds a new tag to the input policy. More... | |
static struct DDS_Tag * | DDSDataTagQosPolicyHelper::lookup_tag (DDS_DataTagQosPolicy &policy, const char *name) |
Searches by tag name for a tag in the input policy. More... | |
static DDS_ReturnCode_t | DDSDataTagQosPolicyHelper::remove_tag (DDS_DataTagQosPolicy &policy, const char *name) |
Removes a tag from the input policy. More... | |
Variables | |
const char *const | DDS_DATATAG_QOS_POLICY_NAME |
Stringified human-readable name for DDS_DataTagQosPolicy. More... | |
Stores (name, value) pairs that can be used to determine access permissions.
The DDS_DataTagQosPolicy can be used to associate a set of tags in the form of (name, value) pairs with a DDSDataReader or DDSDataWriter. This is similar to the DDS_PropertyQosPolicy, except you cannot select whether or not a particular pair should be propagated (included in the built-in topic). Data tags are always propagated. The Access Control plugin may use the tags to determine publish and subscribe permissions.
typedef struct DDS_DataTags DDS_DataTagQosPolicy |
Stores (name, value) pairs that can be used to determine access permissions.
The DATA_TAG QoS policy can be used to associate a set of tags in the form of (name, value) pairs with a DDSDataReader or DDSDataWriter. This is similar to the DDS_PropertyQosPolicy, except for the following differences:
There are helper functions to facilitate working with data tags. See the DATA_TAG page.
|
static |
Gets the number of data tags in the input policy.
policy | <<in>> Input policy. |
|
static |
Asserts the tag identified by name in the input policy.
If the tag already exists, this function replaces its current value with the new one.
If the tag identified by name does not exist, this function adds it to the tag set.
This function increases the maximum number of elements of the policy sequence by 10 when this number is not enough to store the new tag.
|
static |
Adds a new tag to the input policy.
This function will allocate memory to store the (name, value) pair. The memory allocated is owned by RTI Connext.
If the maximum number of elements of the policy sequence is not enough to store the new tag, this function will increase it by 10.
If the tag already exists, the function will fail with DDS_RETCODE_PRECONDITION_NOT_MET.
|
static |
|
static |
Removes a tag from the input policy.
If the tag does not exist, the function fails with DDS_RETCODE_PRECONDITION_NOT_MET.
const char* const DDS_DATATAG_QOS_POLICY_NAME |
Stringified human-readable name for DDS_DataTagQosPolicy.