<<interface>> Keyed string type support.
More...
#include <managed_keyedstringSupport.h>
Inherits DDS::TypedTypeSupport< T >.
|
static System::String ^ | get_type_name () |
| Get the default name for the DDS::KeyedString type. More...
|
|
static void | print_data (KeyedString^ a_data) |
| <<extension>> Print value of data type to standard out. More...
|
|
static void | serialize_data_to_cdr_buffer (array< System::Byte >^ buffer, System::UInt32% length, KeyedString^ a_data) |
| <<extension>> Serializes the input sample into a CDR buffer of octets. More...
|
|
static void | serialize_data_to_cdr_buffer (array< System::Byte >^ buffer, System::UInt32% length, KeyedString^ a_data, System::Int16 representation) |
| <<extension>> Serializes the input sample into a buffer of octets. More...
|
|
static void | deserialize_data_from_cdr_buffer (KeyedString^ a_data, array< System::Byte >^ buffer, System::UInt32 length) |
| <<extension>> Deserializes a sample from a buffer of octets. More...
|
|
static System::String ^ | data_to_string (KeyedString^ sample, PrintFormatProperty^ formatProperty) |
| <<extension>> Get the string representation of an input sample. More...
|
|
static System::String ^ | data_to_string (KeyedString^ sample) |
| <<extension>> Get the string representation of an input sample. More...
|
|
static DDS::TypeCode ^ | get_typecode () |
| <<extension>> Retrieves the TypeCode for the Type. More...
|
|
static void | register_type (DDS::DomainParticipant^ participant, System::String^ type_name) |
| Allows an application to communicate to RTI Connext the existence of the DDS::KeyedString data type. More...
|
|
static void | unregister_type (DDS::DomainParticipant^ participant, System::String^ type_name) |
| 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. More...
|
|
<<interface>> Keyed string type support.
◆ get_type_name()
static System::String ^ DDS::KeyedStringTypeSupport::get_type_name |
( |
| ) |
|
|
static |
◆ print_data()
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
-
◆ serialize_data_to_cdr_buffer() [1/2]
static void DDS::KeyedStringTypeSupport::serialize_data_to_cdr_buffer |
( |
array< System::Byte >^ |
buffer, |
|
|
System::UInt32% |
length, |
|
|
KeyedString^ |
a_data |
|
) |
| |
|
static |
◆ serialize_data_to_cdr_buffer() [2/2]
static void DDS::KeyedStringTypeSupport::serialize_data_to_cdr_buffer |
( |
array< System::Byte >^ |
buffer, |
|
|
System::UInt32% |
length, |
|
|
KeyedString^ |
a_data, |
|
|
System::Int16 |
representation |
|
) |
| |
|
static |
◆ deserialize_data_from_cdr_buffer()
static void DDS::KeyedStringTypeSupport::deserialize_data_from_cdr_buffer |
( |
KeyedString^ |
a_data, |
|
|
array< System::Byte >^ |
buffer, |
|
|
System::UInt32 |
length |
|
) |
| |
|
static |
◆ data_to_string() [1/2]
◆ data_to_string() [2/2]
static System::String ^ DDS::KeyedStringTypeSupport::data_to_string |
( |
KeyedString^ |
sample | ) |
|
|
static |
◆ get_typecode()
static DDS::TypeCode ^ DDS::KeyedStringTypeSupport::get_typecode |
( |
| ) |
|
|
static |
◆ register_type()
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
◆ unregister_type()
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