<<eXtension>> Stores name/value (string) pairs that can be used to configure certain parameters of RTI Connext that are not exposed through formal QoS policies. Can also be used to store and propagate application-specific name/value pairs that can be retrieved by user code during discovery.
More...
Functions |
static DDS_Long | DDSPropertyQosPolicyHelper::get_number_of_properties (DDS_PropertyQosPolicy &policy) |
| Gets the number of properties in the input policy.
|
|
static DDS_ReturnCode_t | DDSPropertyQosPolicyHelper::assert_property (DDS_PropertyQosPolicy &policy, const char *name, const char *value, DDS_Boolean propagate) |
| Asserts the property identified by name in the input policy.
|
|
static DDS_ReturnCode_t | DDSPropertyQosPolicyHelper::add_property (DDS_PropertyQosPolicy &policy, const char *name, const char *value, DDS_Boolean propagate) |
| Adds a new property to the input policy.
|
|
static struct DDS_Property_t * | DDSPropertyQosPolicyHelper::lookup_property (DDS_PropertyQosPolicy &policy, const char *name) |
| Searches for a property in the input policy given its name.
|
|
static DDS_ReturnCode_t | DDSPropertyQosPolicyHelper::remove_property (DDS_PropertyQosPolicy &policy, const char *name) |
| Removes a property from the input policy.
|
|
static DDS_ReturnCode_t | DDSPropertyQosPolicyHelper::get_properties (DDS_PropertyQosPolicy &policy, struct DDS_PropertySeq &properties, const char *name_prefix) |
| Retrieves a list of properties whose names match the input prefix.
|
|
Detailed Description
<<eXtension>> Stores name/value (string) pairs that can be used to configure certain parameters of RTI Connext that are not exposed through formal QoS policies. Can also be used to store and propagate application-specific name/value pairs that can be retrieved by user code during discovery.
RTI Connext will automatically set some system properties in the DDS_PropertyQosPolicy associated with a DDS_DomainParticipantQos. See System Properties for additional details.
Function Documentation
Gets the number of properties in the input policy.
- Precondition
- policy cannot be NULL.
- Parameters
-
- Returns
- Number of properties.
Asserts the property identified by name in the input policy.
If the property already exists, this function replaces its current value with the new one.
If the property identified by name does not exist, this function adds it to the property set.
This function increases the maximum number of elements of the policy sequence when this number is not enough to store the new property.
- Precondition
- policy, name and value cannot be NULL.
- Parameters
-
policy | <<in>> Input policy. |
name | <<in>> Property name. |
value | <<in>> Property value. |
propagate | <<in>> Indicates if the property will be propagated on discovery. |
- Returns
- One of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES.
Adds a new property 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 property, this function will increase it.
If the property already exists the function fails with DDS_RETCODE_PRECONDITION_NOT_MET.
- Precondition
- policy, name and value cannot be NULL.
-
The property is not in the policy.
- Parameters
-
policy | <<in>> Input policy. |
name | <<in>> Property name. |
value | <<in>> Property value. |
propagate | <<in>> Indicates if the property will be propagated on discovery. |
- Returns
- One of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES or DDS_RETCODE_PRECONDITION_NOT_MET
Searches for a property in the input policy given its name.
- Precondition
- policy, name and value cannot be NULL.
- Parameters
-
- Returns
- On success, the function returns the first property with the given name. Otherwise, the function returns NULL.
Retrieves a list of properties whose names match the input prefix.
If the properties sequence doesn't own its buffer, and its maximum is less than the total number of properties matching the input prefix, it will be filled up to its maximum and fail with an error of DDS_RETCODE_OUT_OF_RESOURCES.
- Precondition
- policy, properties and name_prefix cannot be NULL.
- Parameters
-
- Returns
- One of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES.
Variable Documentation
const char* const DDS_PROPERTY_QOS_POLICY_NAME |