PROPERTY

<<eXtension>> Stores (name, value) pairs that can be used to configure certain parameters of RTI Connext DDS Micro that are not exposed through formal QoS policies. 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 Connext DDS Micro that are not exposed through formal QoS policies. More...

Functions
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 (const 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.

---

Detailed Description

<<eXtension>> Stores (name, value) pairs that can be used to configure certain parameters of RTI Connext DDS Micro that are not exposed through formal QoS policies.

---

Function Documentation

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. Must be DDS_BOOLEAN_FALSE.

Returns:

One of the Standard Return Codes, 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 Connext DDS Micro.

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. Must be DDS_BOOLEAN_FALSE?

Returns:

One of the Standard Return Codes, DDS_RETCODE_PRECONDITION_NOT_MET, DDS_RETCODE_OUT_OF_RESOURCES

struct DDS_Property_t* DDS_PropertyQosPolicyHelper_lookup_property ( const 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:

The function returns the first property with the given name. If such a property does not exist, 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, DDS_RETCODE_PRECONDITION_NOT_MET