dds_c_type.h File Reference

DDS type module. More...

#include "cdr/cdr_cdr_type.h"
#include "cdr/cdr_stream.h"
#include "cdr/cdr_encapsulation.h"
#include "reda/reda_buffer.h"
#include "rtps/rtps_rtps.h"
#include "dds_c/dds_c_dll.h"
#include "dds_c/dds_c_infrastructure.h"

Go to the source code of this file.

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 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 RTI_BOOL(*	NDDS_PluginHelper_OnParticipantAttachedFunc )(struct NDDS_Type_Plugin *plugin, void *param)
	Prototype of helper function for NDDS_Type_Plugin providing a callback to be notified when a participant starts making use of a NDDS_Type_Plugin.
typedef RTI_BOOL(*	NDDS_PluginHelper_OnParticipantDetachedFunc )(struct NDDS_Type_Plugin *plugin, void *param)
	Prototype of helper function for NDDS_Type_Plugin providing a callback to be notified when a participant stops making use of a NDDS_Type_Plugin.
typedef RTI_BOOL(*	NDDS_PluginHelper_OnEndpointAttachedFunc )(struct NDDS_Type_Plugin *plugin, void *param)
	Prototype of helper function for NDDS_Type_Plugin providing a callback to be notified when a new local endpoint starts making use of a NDDS_Type_Plugin.
typedef RTI_BOOL(*	NDDS_PluginHelper_OnEndpointDetachedFunc )(struct NDDS_Type_Plugin *plugin, void *param)
	Prototype of helper function for NDDS_Type_Plugin providing a callback to be notified when a new local endpoint stops making use of a 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

DDS type module.

---

Typedef Documentation

typedef RTI_BOOL(* NDDS_PluginHelper_OnParticipantAttachedFunc)(struct NDDS_Type_Plugin *plugin, void *param)

Prototype of helper function for NDDS_Type_Plugin providing a callback to be notified when a participant starts making use of a NDDS_Type_Plugin.

typedef RTI_BOOL(* NDDS_PluginHelper_OnParticipantDetachedFunc)(struct NDDS_Type_Plugin *plugin, void *param)

Prototype of helper function for NDDS_Type_Plugin providing a callback to be notified when a participant stops making use of a NDDS_Type_Plugin.

typedef RTI_BOOL(* NDDS_PluginHelper_OnEndpointAttachedFunc)(struct NDDS_Type_Plugin *plugin, void *param)

Prototype of helper function for NDDS_Type_Plugin providing a callback to be notified when a new local endpoint starts making use of a NDDS_Type_Plugin.

typedef RTI_BOOL(* NDDS_PluginHelper_OnEndpointDetachedFunc)(struct NDDS_Type_Plugin *plugin, void *param)

Prototype of helper function for NDDS_Type_Plugin providing a callback to be notified when a new local endpoint stops making use of a NDDS_Type_Plugin.