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.KeyedBytes data type. | |
static void | unregister_type (DomainParticipant participant, String type_name) |
Allows an application to unregister the com.rti.dds.type.builtin.KeyedBytes data type from RTI Connext. After calling unregister_type, no further communication using this type is possible. | |
static String | get_type_name () |
Get the default name for the com.rti.dds.type.builtin.KeyedBytes type. |
static void register_type | ( | DomainParticipant | participant, | |
String | type_name | |||
) | [static] |
Allows an application to communicate to RTI Connext the existence of the com.rti.dds.type.builtin.KeyedBytes data type.
By default, The com.rti.dds.type.builtin.KeyedBytes built-in type is automatically registered when a DomainParticipant is created using the type_name returned by com.rti.dds.type.builtin.KeyedBytesTypeSupport.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.KeyedBytesTypeSupport 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.Bytes with. Cannot be null. | |
type_name | <<in>> the type name under with the data type com.rti.dds.type.builtin.KeyedBytes 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, RETCODE_PRECONDITION_NOT_MET or RETCODE_OUT_OF_RESOURCES. |
static void unregister_type | ( | DomainParticipant | participant, | |
String | type_name | |||
) | [static] |
Allows an application to unregister the com.rti.dds.type.builtin.KeyedBytes 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 RETCODE_ERROR. participant | <<in>> the com.rti.dds.domain.DomainParticipant to unregister the data type com.rti.dds.type.builtin.KeyedBytes from. Cannot be null. | |
type_name | <<in>> the type name under with the data type com.rti.dds.type.builtin.KeyedBytes 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, RETCODE_BAD_PARAMETER or RETCODE_ERROR |
static String get_type_name | ( | ) | [static] |
Get the default name for the com.rti.dds.type.builtin.KeyedBytes type.
Can be used for calling com.rti.dds.type.builtin.KeyedBytesTypeSupport.register_type or creating com.rti.dds.topic.Topic.