RTI Connext .Net APIs  Version 5.0.0
PROPERTY

<<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...

Classes

class  DDS::Property_t
 Properties are name/value pairs objects. More...
 
class  DDS::PropertySeq
 Declares IDL sequence < DDS::Property_t > More...
 
class  DDS::PropertyQosPolicy
 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...
 
class  DDS::PropertyQosPolicyHelper
 Policy Helpers which facilitate management of the properties in the input policy. More...
 

Functions

static System::String^ DDS::PropertyQosPolicy::get_property_qos_policy_name ()
 Stringified human-readable name for DDS::PropertyQosPolicy.
 
static System::String^ DDS::AvailabilityQosPolicy::get_property_qos_policy_name ()
 Stringified human-readable name for DDS::PropertyQosPolicy.
 
static Int32 DDS::PropertyQosPolicyHelper::get_number_of_properties (PropertyQosPolicy^ policy)
 Gets the number of properties in the input policy.
 
static void DDS::PropertyQosPolicyHelper::assert_property (PropertyQosPolicy^ policy, String^ name, String^ value, System::Boolean propagate)
 Asserts the property identified by name in the input policy.
 
static void DDS::PropertyQosPolicyHelper::add_property (PropertyQosPolicy^ policy, String^ name, String^ value, System::Boolean propagate)
 Adds a new property to the input policy.
 
static Property_tDDS::PropertyQosPolicyHelper::lookup_property (PropertyQosPolicy^ policy, System::String^ name)
 Searches for a property in the input policy given its name.
 
static void DDS::PropertyQosPolicyHelper::remove_property (PropertyQosPolicy^ policy, String^ name)
 Removes a property from the input policy.
 
static void DDS::PropertyQosPolicyHelper::get_properties (PropertyQosPolicy^ policy, PropertySeq^ properties, String^ 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

static System::String ^ DDS::PropertyQosPolicy::get_property_qos_policy_name ( )
inlinestatic

Stringified human-readable name for DDS::PropertyQosPolicy.

static System::String ^ DDS::AvailabilityQosPolicy::get_property_qos_policy_name ( )
inlinestatic

Stringified human-readable name for DDS::PropertyQosPolicy.

static Int32 DDS::PropertyQosPolicyHelper::get_number_of_properties ( PropertyQosPolicy policy)
static

Gets the number of properties in the input policy.

Precondition
policy cannot be null.
Parameters
policy<<in>> Input policy.
Returns
Number of properties.
static void DDS::PropertyQosPolicyHelper::assert_property ( PropertyQosPolicy policy,
String^  name,
String^  value,
System::Boolean  propagate 
)
static

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_OutOfResources.
static void DDS::PropertyQosPolicyHelper::add_property ( PropertyQosPolicy policy,
String^  name,
String^  value,
System::Boolean  propagate 
)
static

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_PreconditionNotMet.

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_OutOfResources or DDS::Retcode_PreconditionNotMet
static Property_t ^ DDS::PropertyQosPolicyHelper::lookup_property ( PropertyQosPolicy policy,
System::String^  name 
)
static

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.
static void DDS::PropertyQosPolicyHelper::remove_property ( PropertyQosPolicy policy,
String^  name 
)
static

Removes a property from the input policy.

If the property does not exist, the function fails with DDS::Retcode_PreconditionNotMet.

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_PreconditionNotMet.
static void DDS::PropertyQosPolicyHelper::get_properties ( PropertyQosPolicy policy,
PropertySeq properties,
String^  name_prefix 
)
static

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_OutOfResources.

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_prefixName prefix.
Returns
One of the Standard Return Codes or DDS::Retcode_OutOfResources.

RTI Connext .Net APIs Version 5.0.0 Copyright © Thu Aug 30 2012 Real-Time Innovations, Inc