<<interface>> Keyed string type support.
More...
#include <managed_keyedstringSupport.h>
Inherits DDS::TypedTypeSupport< T >.
Detailed Description
<<interface>> Keyed string type support.
Member Function Documentation
static System::String ^ DDS::KeyedStringTypeSupport::get_type_name |
( |
| ) |
|
|
static |
static void DDS::KeyedStringTypeSupport::print_data |
( |
KeyedString^ |
a_data | ) |
|
|
static |
<<eXtension>> Print value of data type to standard out.
The generated implementation of the operation knows how to print value of a data type.
- Parameters
-
static void DDS::KeyedStringTypeSupport::register_type |
( |
DDS::DomainParticipant^ |
participant, |
|
|
System::String^ |
type_name |
|
) |
| |
|
static |
Allows an application to communicate to RTI Connext the existence of the DDS::KeyedString data type.
By default, The DDS::KeyedString built-in type is automatically registered when a DomainParticipant is created using the type_name returned by DDS::KeyedStringTypeSupport::get_type_name. Therefore, the usage of this function is optional and it is only required when the automatic built-in type registration is disabled using the participant property "dds.builtin_type.auto_register".
This method can also be used to register the same DDS::KeyedStringTypeSupport with a DDS::DomainParticipant using different values for the type_name.
If register_type
is called multiple times with the same DDS::DomainParticipant and type_name
, the second (and subsequent) registrations are ignored by the operation.
- Parameters
-
- Exceptions
-
- MT Safety:
- UNSAFE on the FIRST call. It is not safe for two threads to simultaneously make the first call to register a type. Subsequent calls are thread safe.
- See Also
- DDS::DomainParticipant::create_topic
static void DDS::KeyedStringTypeSupport::unregister_type |
( |
DDS::DomainParticipant^ |
participant, |
|
|
System::String^ |
type_name |
|
) |
| |
|
static |
Allows an application to unregister the DDS::KeyedString data type from RTI Connext. After calling unregister_type, no further communication using this type is possible.
- Precondition
- The DDS::KeyedString type with
type_name
is registered with the participant and all DDS::Topic objects referencing the type have been destroyed. If the type is not registered with the participant, or if any DDS::Topic is associated with the type, the operation will fail with DDS::Retcode_Error.
- Postcondition
- All information about the type is removed from RTI Connext. No further communication using this type is possible.
- Parameters
-
participant | <<in>> the DDS::DomainParticipant to unregister the data type DDS::KeyedString from. Cannot be null. |
type_name | <<in>> the type name under with the data type DDS::KeyedString is registered with the participant. The name should match a name that has been previously used to register a type with the participant. Cannot be null. |
- Exceptions
-
- MT Safety:
- SAFE.
- See Also
- DDS::KeyedStringTypeSupport::register_type