User-Defined Types

entity and associated elements More...

Data Structures
struct	NDDS_Type_PluginVersion
	Data type used to keep track of versioning information about a NDDS_Type_Plugin. More...
struct	NDDS_Type_Plugin
	<<interface>> Plugin for type routines. More...

Typedefs
typedef struct DDS_BuiltinTopicKey_t	DDS_InstanceId_t
	The data structure by which RTI Connext Micro identifies keys in user data types.RTI Connext Micro propagates and differentiates between instances of keyed types using DDS_InstanceId_t . Before a sample of a keyed type can be written, its key must be translated into one of these.
typedef struct NDDS_Type_PluginVersion	NDDS_Type_PluginVersion
	Data type used to keep track of versioning information about a NDDS_Type_Plugin.
typedef RTI_UINT32(*	NDDS_Type_GetSerializedSizeFunc )(struct NDDS_Type_Plugin *plugin, RTI_UINT32 current_alignment, void *param)
	Prototype of the function to determine the size of a data sample in serialized form.
typedef RTI_BOOL(*	NDDS_Type_CreateSampleFunc )(struct NDDS_Type_Plugin *plugin, void **sample, void *param)
	Prototype of the data sample creation function.
typedef RTI_BOOL(*	NDDS_Type_DeleteSampleFunc )(struct NDDS_Type_Plugin *plugin, void *sample, void *param)
	Prototype of the data sample delete function.
typedef RTI_BOOL(*	NDDS_Type_CopySampleFunc )(struct NDDS_Type_Plugin *plugin, void *dst, const void *src, void *param)
	Prototype of the data sample copy function.
typedef RTI_BOOL(*	NDDS_Type_GetSampleFunc )(struct NDDS_Type_Plugin *plugin, void **sample, void *param)
	Prototype of the function to loan a sample from a NDDS_Type_Plugin.
typedef RTI_BOOL(*	NDDS_Type_ReturnSampleFunc )(struct NDDS_Type_Plugin *plugin, void *sample, void *param)
	Prototype of the function to return a loaned data sample to the NDDS_Type_Plugin.
typedef RTI_BOOL(*	NDDS_Type_GetStreamBufferFunc )(struct NDDS_Type_Plugin *plugin, struct REDA_Buffer **stream_buffer, void *param)
	Prototype of the function to loan a stream buffer from the NDDS_Type_Plugin.
typedef RTI_BOOL(*	NDDS_Type_ReturnStreamBufferFunc )(struct NDDS_Type_Plugin *plugin, struct REDA_Buffer *stream_buffer, void *param)
	Prototype of the function to return a loaned stream buffer to the NDDS_Type_Plugin.
typedef NDDS_TypePluginKeyKind(*	NDDS_PluginHelper_GetKeyKindFunc )(struct NDDS_Type_Plugin *plugin, void *param)
	Prototype of the keyed data check function.
typedef RTI_BOOL(*	NDDS_PluginHelper_InstanceToKeyHashFunc )(struct NDDS_Type_Plugin *plugin, struct CDR_Stream_t *stream, DDS_KeyHash_t *keyHash, const void *instance, void *param)
	Prototype of the function for converting an instance of data into a 16-byte key hash.
typedef void *(*	NDDS_PluginHelper_CreateTypedDataWriterFunc )(void *writer)
	Prototype of the function for creating a language-specific wrapper for a DDS_DataWriter created by the C core layer.
typedef void(*	NDDS_PluginHelper_DeleteTypedDataWriterFunc )(void *wrapper)
	Prototype of the function for deleting a language-specific wrapper of a DDS_DataReader created by the C core layer.
typedef void *(*	NDDS_PluginHelper_CreateTypedDataReaderFunc )(void *reader)
	Prototype of the function for creating a language-specific wrapper for a DDS_DataReader created by the C core layer.
typedef void(*	NDDS_PluginHelper_DeleteTypedDataReaderFunc )(void *wrapper)
	Prototype of the function for deleting a language-specific wrapper of a DDS_DataReader created by the C core layer.

Enumerations
enum	NDDS_TypePluginKeyKind {   NDDS_TYPEPLUGIN_NO_KEY ,   NDDS_TYPEPLUGIN_USER_KEY }
	Type key kind: either keyed or unkeyed.This type defines whether a user data type is keyed or unkeyed. More...

Functions
RTI_BOOL	PluginHelper_get_sample (struct NDDS_Type_Plugin *plugin, void **sample, void *param)
	Function to retrieve a loaned data-sample from a NDDS_Type_Plugin.
RTI_BOOL	PluginHelper_return_sample (struct NDDS_Type_Plugin *plugin, void *sample, void *param)
	Function to return a loaned data sample to a NDDS_Type_Plugin.
RTI_BOOL	PluginHelper_get_buffer (struct NDDS_Type_Plugin *plugin, struct REDA_Buffer **stream_buffer, void *param)
	Function to retrieve a loaned buffer from a NDDS_Type_Plugin.
RTI_BOOL	PluginHelper_return_buffer (struct NDDS_Type_Plugin *plugin, struct REDA_Buffer *stream_buffer, void *param)
	Function to return a loaned stream buffer to a NDDS_Type_Plugin.
RTI_BOOL	PluginHelper_on_participant_attached (struct NDDS_Type_Plugin *plugin, void *param)
	Callback function notifying that a new participant was attached to a NDDS_Type_Plugin.
RTI_BOOL	PluginHelper_on_participant_detached (struct NDDS_Type_Plugin *plugin, void *param)
	Callback function notifying that a participant was detached from a NDDS_Type_Plugin.
RTI_BOOL	PluginHelper_on_endpoint_attached (struct NDDS_Type_Plugin *plugin, void *param)
	Callback function notifying that a new endpoint was attached to a NDDS_Type_Plugin.
RTI_BOOL	PluginHelper_on_endpoint_detached (struct NDDS_Type_Plugin *plugin, void *param)
	Callback function notifying that an endpoint was detached from a NDDS_Type_Plugin.
RTI_BOOL	PluginHelper_instance_to_keyhash (struct NDDS_Type_Plugin *plugin, struct CDR_Stream_t *stream, DDS_KeyHash_t *keyHash, const void *instance, void *param)
	Function to use a NDDS_Type_Plugin to create a 16-byte keyhash from an instance of data.
NDDS_TypePluginKeyKind	PluginHelper_get_key_kind (struct NDDS_Type_Plugin *plugin, void *param)
	Function to determine the type of key used by a NDDS_Type_Plugin's data type.

---

Detailed Description

entity and associated elements

---

Typedef Documentation

typedef struct DDS_BuiltinTopicKey_t DDS_InstanceId_t

The data structure by which RTI Connext Micro identifies keys in user data types.RTI Connext Micro propagates and differentiates between instances of keyed types using DDS_InstanceId_t . Before a sample of a keyed type can be written, its key must be translated into one of these.

Users who do not edit the code generated by rtiddsgen do not need to deal with this type.

This type is structurally identical to the key type of the built-in topic types. A one-to-one mapping must exist from the key fields of a user data sample to the values of this type's fields.

See also:

DDS_BuiltinTopicKey_t

typedef struct NDDS_Type_PluginVersion NDDS_Type_PluginVersion

Data type used to keep track of versioning information about a NDDS_Type_Plugin.

typedef RTI_UINT32(* NDDS_Type_GetSerializedSizeFunc)(struct NDDS_Type_Plugin *plugin, RTI_UINT32 current_alignment, void *param)

Prototype of the function to determine the size of a data sample in serialized form.

typedef RTI_BOOL(* NDDS_Type_CreateSampleFunc)(struct NDDS_Type_Plugin *plugin, void **sample, void *param)

Prototype of the data sample creation function.

typedef RTI_BOOL(* NDDS_Type_DeleteSampleFunc)(struct NDDS_Type_Plugin *plugin, void *sample, void *param)

Prototype of the data sample delete function.

typedef RTI_BOOL(* NDDS_Type_CopySampleFunc)(struct NDDS_Type_Plugin *plugin, void *dst, const void *src, void *param)

Prototype of the data sample copy function.

typedef RTI_BOOL(* NDDS_Type_GetSampleFunc)(struct NDDS_Type_Plugin *plugin, void **sample, void *param)

Prototype of the function to loan a sample from a NDDS_Type_Plugin.

typedef RTI_BOOL(* NDDS_Type_ReturnSampleFunc)(struct NDDS_Type_Plugin *plugin, void *sample, void *param)

Prototype of the function to return a loaned data sample to the NDDS_Type_Plugin.

typedef RTI_BOOL(* NDDS_Type_GetStreamBufferFunc)(struct NDDS_Type_Plugin *plugin, struct REDA_Buffer **stream_buffer, void *param)

Prototype of the function to loan a stream buffer from the NDDS_Type_Plugin.

typedef RTI_BOOL(* NDDS_Type_ReturnStreamBufferFunc)(struct NDDS_Type_Plugin *plugin, struct REDA_Buffer *stream_buffer, void *param)

Prototype of the function to return a loaned stream buffer to the NDDS_Type_Plugin.

typedef NDDS_TypePluginKeyKind(* NDDS_PluginHelper_GetKeyKindFunc)(struct NDDS_Type_Plugin *plugin, void *param)

Prototype of the keyed data check function.

typedef RTI_BOOL(* NDDS_PluginHelper_InstanceToKeyHashFunc)(struct NDDS_Type_Plugin *plugin, struct CDR_Stream_t *stream, DDS_KeyHash_t *keyHash, const void *instance, void *param)

Prototype of the function for converting an instance of data into a 16-byte key hash.

typedef void*(* NDDS_PluginHelper_CreateTypedDataWriterFunc)(void *writer)

Prototype of the function for creating a language-specific wrapper for a DDS_DataWriter created by the C core layer.

typedef void(* NDDS_PluginHelper_DeleteTypedDataWriterFunc)(void *wrapper)

Prototype of the function for deleting a language-specific wrapper of a DDS_DataReader created by the C core layer.

typedef void*(* NDDS_PluginHelper_CreateTypedDataReaderFunc)(void *reader)

Prototype of the function for creating a language-specific wrapper for a DDS_DataReader created by the C core layer.

typedef void(* NDDS_PluginHelper_DeleteTypedDataReaderFunc)(void *wrapper)

Prototype of the function for deleting a language-specific wrapper of a DDS_DataReader created by the C core layer.

---

Enumeration Type Documentation

enum NDDS_TypePluginKeyKind

Type key kind: either keyed or unkeyed.This type defines whether a user data type is keyed or unkeyed.

Enumerator:

NDDS_TYPEPLUGIN_NO_KEY	Data is not keyed.
NDDS_TYPEPLUGIN_USER_KEY	Data is keyed.

---

Function Documentation

RTI_BOOL PluginHelper_get_sample	(	struct NDDS_Type_Plugin *	plugin,
		void **	sample,
		void *	param
	)

Function to retrieve a loaned data-sample from a NDDS_Type_Plugin.

RTI_BOOL PluginHelper_return_sample	(	struct NDDS_Type_Plugin *	plugin,
		void *	sample,
		void *	param
	)

Function to return a loaned data sample to a NDDS_Type_Plugin.

RTI_BOOL PluginHelper_get_buffer	(	struct NDDS_Type_Plugin *	plugin,
		struct REDA_Buffer **	stream_buffer,
		void *	param
	)

Function to retrieve a loaned buffer from a NDDS_Type_Plugin.

RTI_BOOL PluginHelper_return_buffer	(	struct NDDS_Type_Plugin *	plugin,
		struct REDA_Buffer *	stream_buffer,
		void *	param
	)

Function to return a loaned stream buffer to a NDDS_Type_Plugin.

RTI_BOOL PluginHelper_on_participant_attached	(	struct NDDS_Type_Plugin *	plugin,
		void *	param
	)

Callback function notifying that a new participant was attached to a NDDS_Type_Plugin.

RTI_BOOL PluginHelper_on_participant_detached	(	struct NDDS_Type_Plugin *	plugin,
		void *	param
	)

Callback function notifying that a participant was detached from a NDDS_Type_Plugin.

RTI_BOOL PluginHelper_on_endpoint_attached	(	struct NDDS_Type_Plugin *	plugin,
		void *	param
	)

Callback function notifying that a new endpoint was attached to a NDDS_Type_Plugin.

RTI_BOOL PluginHelper_on_endpoint_detached	(	struct NDDS_Type_Plugin *	plugin,
		void *	param
	)

Callback function notifying that an endpoint was detached from a NDDS_Type_Plugin.

RTI_BOOL PluginHelper_instance_to_keyhash	(	struct NDDS_Type_Plugin *	plugin,
		struct CDR_Stream_t *	stream,
		DDS_KeyHash_t *	keyHash,
		const void *	instance,
		void *	param
	)

Function to use a NDDS_Type_Plugin to create a 16-byte keyhash from an instance of data.

NDDS_TypePluginKeyKind PluginHelper_get_key_kind	(	struct NDDS_Type_Plugin *	plugin,
		void *	param
	)

Function to determine the type of key used by a NDDS_Type_Plugin's data type.