PROPERTY
[QoS Policies]

<<eXtension>> Stores name/value (string) pairs that can be used to configure certain parameters of RTI Data Distribution Service 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...

Data Structures
struct	DDS_Property_t
	Properties are name/value pairs objects. More...
struct	DDS_PropertySeq
	Declares IDL sequence < DDS_Property_t >. More...
struct	DDS_PropertyQosPolicy
	Stores name/value(string) pairs that can be used to configure certain parameters of RTI Data Distribution Service 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
DDS_Long	DDS_PropertyQosPolicyHelper_get_number_of_properties (const struct DDS_PropertyQosPolicy *policy)
	Gets the number of properties in the input policy.
DDS_ReturnCode_t	DDS_PropertyQosPolicyHelper_assert_property (struct DDS_PropertyQosPolicy *policy, const char *name, const char *value, DDS_Boolean propagate)
	Asserts the property identified by name in the input policy.
DDS_ReturnCode_t	DDS_PropertyQosPolicyHelper_add_property (struct DDS_PropertyQosPolicy *policy, const char *name, const char *value, DDS_Boolean propagate)
	Adds a new property to the input policy.
struct DDS_Property_t *	DDS_PropertyQosPolicyHelper_lookup_property (struct DDS_PropertyQosPolicy *policy, const char *name)
	Searches for a property in the input policy given its name.
DDS_ReturnCode_t	DDS_PropertyQosPolicyHelper_remove_property (struct DDS_PropertyQosPolicy *policy, const char *name)
	Removes a property from the input policy.
DDS_ReturnCode_t	DDS_PropertyQosPolicyHelper_get_properties (struct DDS_PropertyQosPolicy *policy, struct DDS_PropertySeq *properties, const char *name_prefix)
	Retrieves a list of properties whose names match the input prefix.
Variables
const char *const	DDS_PROPERTY_QOS_POLICY_NAME
	Stringified human-readable name for DDS_PropertyQosPolicy.

---

Detailed Description

<<eXtension>> Stores name/value (string) pairs that can be used to configure certain parameters of RTI Data Distribution Service 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.

See DDS_PropertyQosPolicy

---

Function Documentation

DDS_Long DDS_PropertyQosPolicyHelper_get_number_of_properties

(

const struct DDS_PropertyQosPolicy *

policy

)

Gets the number of properties in the input policy.

Precondition:

policy cannot be NULL.

Parameters:

policy

<<in>> Input policy.

Returns:

Number of properties.

DDS_ReturnCode_t DDS_PropertyQosPolicyHelper_assert_property	(	struct DDS_PropertyQosPolicy *	policy,
		const char *	name,
		const char *	value,
		DDS_Boolean	propagate
	)

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.

DDS_ReturnCode_t DDS_PropertyQosPolicyHelper_add_property	(	struct DDS_PropertyQosPolicy *	policy,
		const char *	name,
		const char *	value,
		DDS_Boolean	propagate
	)

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 Data Distribution Service.

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

struct DDS_Property_t* DDS_PropertyQosPolicyHelper_lookup_property	(	struct DDS_PropertyQosPolicy *	policy,
		const char *	name
	)			[read]

Searches for a property in the input policy given its name.

Precondition:

policy, name and value cannot be NULL.

Parameters:

	policy	<<in>> Input policy.
	name	<<in>> Property name.

Returns:

On success, the function returns the first property with the given name. Otherwise, the function returns NULL.

DDS_ReturnCode_t DDS_PropertyQosPolicyHelper_remove_property	(	struct DDS_PropertyQosPolicy *	policy,
		const char *	name
	)

Removes a property from the input policy.

If the property does not exist, the function fails with DDS_RETCODE_PRECONDITION_NOT_MET.

Precondition:

policy and name cannot be NULL.

The property is in the policy.

Parameters:

	policy	<<in>> Input policy.
	name	<<in>> Property name.

Returns:

One of the Standard Return Codes or DDS_RETCODE_PRECONDITION_NOT_MET.

DDS_ReturnCode_t DDS_PropertyQosPolicyHelper_get_properties	(	struct DDS_PropertyQosPolicy *	policy,
		struct DDS_PropertySeq *	properties,
		const char *	name_prefix
	)

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:

	policy	<<in>> Input policy.
	properties	<<inout>> A DDS_PropertySeq object where the set or list of properties will be returned.
	name_prefix	Name prefix.

Returns:

One of the Standard Return Codes or DDS_RETCODE_OUT_OF_RESOURCES.

---

Variable Documentation

const char* const DDS_PROPERTY_QOS_POLICY_NAME

Stringified human-readable name for DDS_PropertyQosPolicy.