DDSKeyedStringTypeSupport Class Reference
[KeyedString Built-in Type]

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

Inheritance diagram for DDSKeyedStringTypeSupport:

List of all members.

Static Public Member Functions
static DDS_ReturnCode_t	register_type (DDSDomainParticipant *participant, const char *type_name="DDS::KeyedString")
	Allows an application to communicate to RTI Connext the existence of the DDS_KeyedString data type.
static DDS_ReturnCode_t	unregister_type (DDSDomainParticipant *participant, const char *type_name="DDS::KeyedString")
	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.
static const char *	get_type_name ()
	Get the default name for the DDS_KeyedString type.
static void	print_data (const DDS_KeyedString *a_data)
	<<eXtension>> Print value of data type to standard out.

---

Detailed Description

<<interface>> Keyed string type support.

---

Member Function Documentation

static DDS_ReturnCode_t DDSKeyedStringTypeSupport::register_type	(	DDSDomainParticipant *	participant,
		const char *	type_name = "DDS::KeyedString"
	)			[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 DDSKeyedStringTypeSupport::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 DDSKeyedStringTypeSupport 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:

	participant	<<in>> the DDSDomainParticipant to register the data type DDS_KeyedString with. Cannot be NULL.
	type_name	<<in>> the type name under with the data type DDS_KeyedString is registered with the participant; this type name is used when creating a new DDSTopic. (See DDSDomainParticipant::create_topic.) The name may not be NULL or longer than 255 characters.

Returns:

One of the Standard Return Codes, DDS_RETCODE_PRECONDITION_NOT_MET or DDS_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:

DDSDomainParticipant::create_topic

static DDS_ReturnCode_t DDSKeyedStringTypeSupport::unregister_type	(	DDSDomainParticipant *	participant,
		const char *	type_name = "DDS::KeyedString"
	)			[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 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_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.

Returns:

One of the Standard Return Codes, DDS_RETCODE_BAD_PARAMETER or DDS_RETCODE_ERROR

MT Safety:

SAFE.

See also:

DDSKeyedStringTypeSupport::register_type

static const char* DDSKeyedStringTypeSupport::get_type_name

(

)

[static]

Get the default name for the DDS_KeyedString type.

Can be used for calling DDSKeyedStringTypeSupport::register_type or creating DDSTopic.

Returns:

default name for the DDS_KeyedString type.

See also:

DDSKeyedStringTypeSupport::register_type

DDSDomainParticipant::create_topic

static void DDSKeyedStringTypeSupport::print_data

(

const DDS_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:

a_data

<<in>> DDS_KeyedString to be printed.