Lightweight Security API

Lightweight Security Plugin API. More...

Data Structures
struct	DDS_PskServiceFactoryProperty
	Property used to register the Lightweight Security Plugin. More...

Macros
#define	DDS_PskServiceFactoryProperty_INITIALIZER
	Constant to initialize a DDS_PskServiceFactoryProperty.

Functions
struct RT_ComponentFactoryI *	DDS_PskServiceFactory_get_interface (void)
	Get the interface to the factory for the DDS PSK (pre-shared key) plugin.
DDSPSKDllExport DDS_Boolean	DDS_PskLibrary_register (RT_Registry_T *registry, struct DDS_PskServiceFactoryProperty *property)
	Register the DDS PSK plugin library with the registry using the provided property.
DDSPSKDllExport DDS_Boolean	DDS_PskLibrary_unregister (RT_Registry_T *registry, const char *service_name)
	Unregister the DDS PSK plugin library.

Variables
DDSPSKDllExport const char *const	DDS_PSK_DEFAULT_PLUGIN_NAME
	Default name used for the Lightweight Security Plugin.

Detailed Description

Lightweight Security Plugin API.

<<eXtension>> <<cert>> This module provides the security solution defined by the DDS Security Specification PSK (Pre-shared Key) Builtin Plugin.

Macro Definition Documentation

DDS_PskServiceFactoryProperty_INITIALIZER

#define DDS_PskServiceFactoryProperty_INITIALIZER

Value:

{\
    RT_ComponentFactoryProperty_INITIALIZER,\
    NULL,\
    NULL,\
    NULL\
}

Constant to initialize a DDS_PskServiceFactoryProperty.

Function Documentation

DDS_PskServiceFactory_get_interface()

struct RT_ComponentFactoryI * DDS_PskServiceFactory_get_interface

(

void

)

Get the interface to the factory for the DDS PSK (pre-shared key) plugin.

To be used when directly registering the factory with RT_Registry.

Returns

Pointer to DDS PSK factory interface.

DDS_PskLibrary_register()

DDSPSKDllExport DDS_Boolean DDS_PskLibrary_register	(	RT_Registry_T *	registry,
		struct DDS_PskServiceFactoryProperty *	property )

Register the DDS PSK plugin library with the registry using the provided property.

This function must be called before creating a DomainParticipant, in order to register the plugin.

Parameters

[in]	registry	The registry where this plugin is registered.
[in]	property	The DDS_PskServiceFactoryProperty used to configure the plugin.

Returns

DDS_BOOLEAN_TRUE on success and DDS_BOOLEAN_FALSE on failure.

Note

The property provided here must be valid until the DomainParticipants that use this plugin have been created.

DDS_PskLibrary_unregister()

DDSPSKDllExport DDS_Boolean DDS_PskLibrary_unregister	(	RT_Registry_T *	registry,
		const char *	service_name )

Unregister the DDS PSK plugin library.

Parameters

[in]	registry	The registry where this plugin is registered.
[in]	service_name	The name under which the plugin was registered.

Returns

DDS_BOOLEAN_TRUE on success and DDS_BOOLEAN_FALSE on failure.

Note

If NULL is provided, the default name DDS_PSK_DEFAULT_PLUGIN_NAME is used.

Variable Documentation

DDS_PSK_DEFAULT_PLUGIN_NAME

DDSPSKDllExport const char* const DDS_PSK_DEFAULT_PLUGIN_NAME

extern

Default name used for the Lightweight Security Plugin.