RTI Connext Java API
Version 6.1.1
|
<<interface>> Keyed string type support. More...
Public Member Functions | |
long | serialize_to_cdr_buffer (byte[] buffer, long length, KeyedString src) |
<<extension>> Serializes the input sample into a CDR buffer of octets. More... | |
long | serialize_to_cdr_buffer (byte[] buffer, long length, KeyedString src, short representation) |
<<extension>> Serializes the input sample into a buffer of octets. More... | |
String | data_to_string (KeyedString src, PrintFormatProperty property) |
<<extension>> Get the string representation of an input sample. More... | |
String | data_to_string (KeyedString src) |
<<extension>> Get the string representation of an input sample. More... | |
void | deserialize_from_cdr_buffer (KeyedString dst, byte[] buffer, long length) |
<<extension>> Deserializes a sample from a buffer of octets. More... | |
Static Public Member Functions | |
static void | register_type (DomainParticipant participant, String type_name) |
Allows an application to communicate to RTI Connext the existence of the com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString data type. More... | |
static void | unregister_type (DomainParticipant participant, String type_name) |
Allows an application to unregister the com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString data type from RTI Connext. After calling unregister_type, no further communication using this type is possible. More... | |
static String | get_type_name () |
Get the default name for the com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString type. More... | |
<<interface>> Keyed string type support.
|
static |
Allows an application to communicate to RTI Connext the existence of the com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString data type.
By default, The com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString built-in type is automatically registered when a DomainParticipant is created using the type_name returned by com.rti.dds.type.builtin.com.rti.dds.type.builtin.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 com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringTypeSupport with a com.rti.dds.domain.DomainParticipant using different values for the type_name.
If register_type
is called multiple times with the same com.rti.dds.domain.DomainParticipant and type_name
, the second (and subsequent) registrations are ignored by the operation.
participant | <<in>> the com.rti.dds.domain.DomainParticipant to register the data type com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString with. Cannot be null. |
type_name | <<in>> the type name under with the data type com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString is registered with the participant; this type name is used when creating a new com.rti.dds.topic.Topic. (See com.rti.dds.domain.DomainParticipant.create_topic.) The name may not be null or longer than 255 characters. |
One | of the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET or com.rti.dds.infrastructure.RETCODE_OUT_OF_RESOURCES. |
|
static |
Allows an application to unregister the com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString data type from RTI Connext. After calling unregister_type, no further communication using this type is possible.
type_name
is registered with the participant and all com.rti.dds.topic.Topic objects referencing the type have been destroyed. If the type is not registered with the participant, or if any com.rti.dds.topic.Topic is associated with the type, the operation will fail with com.rti.dds.infrastructure.RETCODE_ERROR. participant | <<in>> the com.rti.dds.domain.DomainParticipant to unregister the data type com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString from. Cannot be null. |
type_name | <<in>> the type name under with the data type com.rti.dds.type.builtin.com.rti.dds.type.builtin.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. |
One | of the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_BAD_PARAMETER or com.rti.dds.infrastructure.RETCODE_ERROR |
|
static |
Get the default name for the com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString type.
Can be used for calling com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringTypeSupport.register_type or creating com.rti.dds.topic.Topic.
References KeyedString.copy_from(), ExtensibilityKind.EXTENSIBLE_EXTENSIBILITY, KeyedString.key, and KeyedString.value.
long serialize_to_cdr_buffer | ( | byte [] | buffer, |
long | length, | ||
KeyedString | src | ||
) |
<<extension>> Serializes the input sample into a CDR buffer of octets.
Referenced by KeyedStringTypeSupport.data_to_string().
long serialize_to_cdr_buffer | ( | byte [] | buffer, |
long | length, | ||
KeyedString | src, | ||
short | representation | ||
) |
<<extension>> Serializes the input sample into a buffer of octets.
String data_to_string | ( | KeyedString | src, |
PrintFormatProperty | property | ||
) |
<<extension>> Get the string representation of an input sample.
References DynamicData.from_cdr_buffer(), DynamicData.PROPERTY_DEFAULT, KeyedStringTypeSupport.serialize_to_cdr_buffer(), and DynamicData.to_string().
Referenced by KeyedStringTypeSupport.data_to_string().
String data_to_string | ( | KeyedString | src | ) |
<<extension>> Get the string representation of an input sample.
Use the default values for com.rti.dds.topic.PrintFormatProperty to create the output string.
References KeyedStringTypeSupport.data_to_string(), ExtensibilityKind.EXTENSIBLE_EXTENSIBILITY, KeyedString.key, and KeyedString.value.
void deserialize_from_cdr_buffer | ( | KeyedString | dst, |
byte [] | buffer, | ||
long | length | ||
) |
<<extension>> Deserializes a sample from a buffer of octets.
References KeyedString.key.