<<interface>> DDS_KeyedOctets type support.
More...
|
static DDS_ReturnCode_t | register_type (DDSDomainParticipant *participant, const char *type_name="DDS::KeyedOctets") |
| Allows an application to communicate to RTI Connext the existence of the DDS_KeyedOctets data type. More...
|
|
static DDS_ReturnCode_t | unregister_type (DDSDomainParticipant *participant, const char *type_name="DDS::KeyedOctets") |
| Allows an application to unregister the DDS_KeyedOctets data type from RTI Connext. After calling unregister_type, no further communication using this type is possible. More...
|
|
static const char * | get_type_name () |
| Get the default name for the DDS_KeyedOctets type. More...
|
|
static void | print_data (const DDS_KeyedOctets *a_data) |
| <<extension>> Print value of data type to standard out. More...
|
|
static DDS_TypeCode * | get_typecode () |
| <<extension>> Retrieves the TypeCode for the Type. More...
|
|
static DDS_ReturnCode_t | serialize_data_to_cdr_buffer (char *buffer, unsigned int &length, const DDS_KeyedOctets *a_data) |
| <<extension>> Serializes the input sample into a CDR buffer of octets. More...
|
|
static DDS_ReturnCode_t | serialize_data_to_cdr_buffer_ex (char *buffer, unsigned int &length, const DDS_KeyedOctets *a_data, DDS_DataRepresentationId_t representation) |
| <<extension>> Serializes the input sample into a buffer of octets. More...
|
|
static DDS_ReturnCode_t | deserialize_data_from_cdr_buffer (DDS_KeyedOctets *a_data, const char *buffer, unsigned int length) |
| <<extension>> Deserializes a sample from a buffer of octets. More...
|
|
static DDS_ReturnCode_t | data_to_string (DDS_KeyedOctets *sample, char *str, DDS_UnsignedLong &str_size, const DDS_PrintFormatProperty &property) |
| <<extension>> Get the string representation of an input sample. More...
|
|
◆ register_type()
Allows an application to communicate to RTI Connext the existence of the DDS_KeyedOctets data type.
By default, The DDS_KeyedOctets built-in type is automatically registered when a DomainParticipant is created using the type_name returned by DDSKeyedOctetsTypeSupport::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 DDSKeyedOctetsTypeSupport with a DDSDomainParticipant using different values for the type_name.
If register_type
is called multiple times with the same DDSDomainParticipant 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
- DDSDomainParticipant::create_topic
◆ unregister_type()
Allows an application to unregister the DDS_KeyedOctets data type from RTI Connext. After calling unregister_type, no further communication using this type is possible.
- Precondition
- The DDS_KeyedOctets type with
type_name
is registered with the participant and all DDSTopic objects referencing the type have been destroyed. If the type is not registered with the participant, or if any DDSTopic 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 DDSDomainParticipant to unregister the data type DDS_KeyedOctets from. Cannot be NULL. |
type_name | <<in>> the type name under with the data type DDS_KeyedOctets 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
- DDSKeyedOctetsTypeSupport::register_type
◆ get_type_name()
static const char * DDSKeyedOctetsTypeSupport::get_type_name |
( |
| ) |
|
|
static |
◆ print_data()
static void DDSKeyedOctetsTypeSupport::print_data |
( |
const DDS_KeyedOctets * |
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
-
◆ get_typecode()
static DDS_TypeCode * DDSKeyedOctetsTypeSupport::get_typecode |
( |
| ) |
|
|
static |
◆ serialize_data_to_cdr_buffer()
◆ serialize_data_to_cdr_buffer_ex()
◆ deserialize_data_from_cdr_buffer()
◆ data_to_string()