RTI Connext Java API  Version 5.1.0
KeyedStringTypeSupport Class Reference

<<interface>> Keyed string type support. More...

Inheritance diagram for KeyedStringTypeSupport:
TypeSupport

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.
 
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.
 
static String get_type_name ()
 Get the default name for the com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString type.
 

Detailed Description

<<interface>> Keyed string type support.

Member Function Documentation

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.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.

Parameters
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.
Exceptions
Oneof the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_PRECONDITION_NOT_MET or com.rti.dds.infrastructure.RETCODE_OUT_OF_RESOURCES.
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
com.rti.dds.domain.DomainParticipant.create_topic
static void unregister_type ( DomainParticipant  participant,
String  type_name 
)
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.

Precondition
The com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString type with 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.
Postcondition
All information about the type is removed from RTI Connext. No further communication using this type is possible.
Parameters
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.
Exceptions
Oneof the Standard Return Codes, com.rti.dds.infrastructure.RETCODE_BAD_PARAMETER or com.rti.dds.infrastructure.RETCODE_ERROR
MT Safety:
SAFE.
See Also
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringTypeSupport.register_type
static String get_type_name ( )
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.

Returns
default name for the com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString type.
See Also
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringTypeSupport.register_type
com.rti.dds.domain.DomainParticipant.create_topic

RTI Connext Java API Version 5.1.0 Copyright © Mon Feb 3 2014 Real-Time Innovations, Inc