sopc_toolkit_config_internal.h File Reference

Toolkit internal use only: access to the shared configuration of the Toolkit and tools for interaction with user application. More...

#include "sopc_address_space.h"
#include "sopc_event_handler.h"
#include "sopc_toolkit_config.h"
#include "sopc_toolkit_config_constants.h"
#include "sopc_user_app_itf.h"

Go to the source code of this file.

Macros
#define	SOPC_IS_VALID_EP_CONFIGURATION(x)
#define	SOPC_IS_VALID_CLASSIC_EP_CONFIGURATION(x)
#define	SOPC_IS_VALID_REVERSE_EP_CONFIGURATION(x)

Functions
SOPC_Endpoint_Config *	SOPC_ToolkitServer_GetEndpointConfig (uint32_t epConfigIdx)
	Return the endpoint configuration for the given index or null if not defined. (SOPC_ToolkitServer_Configured required)
SOPC_SecureChannelConfigIdx	SOPC_ToolkitServer_AddSecureChannelConfig (SOPC_SecureChannel_Config *scConfig)
	(SERVER SIDE ONLY) Record the given secure channel configuration in returned index (SOPC_Toolkit_Initialize required and prior to SOPC_ToolkitServer_Configured call) Note: the set of indexes of secure channel configuration for client and server are disjoint
bool	SOPC_ToolkitServer_RemoveSecureChannelConfig (uint32_t serverScConfigIdx)
	(SERVER SIDE ONLY) Remove the secure channel configuration for the given server index
SOPC_SecureChannel_Config *	SOPC_ToolkitServer_GetSecureChannelConfig (uint32_t serverScConfigIdx)
	(SERVER SIDE ONLY) Return the secure channel configuration for the given index or null if not defined. (SOPC_ToolkitServer_Configured required) Note: the set of indexes of secure channel configuration for client and server are disjoint
SOPC_SecureChannel_Config *	SOPC_ToolkitClient_GetSecureChannelConfig (uint32_t scConfigIdx)
	(CLIENT SIDE ONLY) Return the secure channel configuration for the given index or null if not defined. Note: the set of indexes of secure channel configuration for client and server are disjoint
const char *	SOPC_ToolkitClient_GetReverseEndpointURL (SOPC_ReverseEndpointConfigIdx reverseEpCfgIdx)
	(CLIENT SIDE ONLY) Return the client endpoint URL for the given reverse endpoint configuration index or null if not defined Note: the set of indexes of (reverse) endpoint configuration indexes for client and server are disjoint

Detailed Description

Toolkit internal use only: access to the shared configuration of the Toolkit and tools for interaction with user application.

Macro Definition Documentation

SOPC_IS_VALID_EP_CONFIGURATION

#define SOPC_IS_VALID_EP_CONFIGURATION

(

x

)

Value:

((x) > 0 && (x) <= 2 * SOPC_MAX_ENDPOINT_DESCRIPTION_CONFIGURATIONS)

SOPC_IS_VALID_CLASSIC_EP_CONFIGURATION

#define SOPC_IS_VALID_CLASSIC_EP_CONFIGURATION

(

x

)

Value:

((x) > 0 && (x) <= SOPC_MAX_ENDPOINT_DESCRIPTION_CONFIGURATIONS)

SOPC_IS_VALID_REVERSE_EP_CONFIGURATION

#define SOPC_IS_VALID_REVERSE_EP_CONFIGURATION

(

x

)

Value:

    ((x) > SOPC_MAX_ENDPOINT_DESCRIPTION_CONFIGURATIONS && (x) <= 2 * SOPC_MAX_ENDPOINT_DESCRIPTION_CONFIGURATIONS)

Function Documentation

SOPC_ToolkitServer_GetEndpointConfig()

SOPC_Endpoint_Config * SOPC_ToolkitServer_GetEndpointConfig

(

uint32_t

epConfigIdx

)

Return the endpoint configuration for the given index or null if not defined. (SOPC_ToolkitServer_Configured required)

Parameters

epConfigIdx

The endpoint configuration index requested

Returns

Endpoint configuration at given index or NULL if index invalid or toolkit is not configured yet

SOPC_ToolkitServer_AddSecureChannelConfig()

SOPC_SecureChannelConfigIdx SOPC_ToolkitServer_AddSecureChannelConfig

(

SOPC_SecureChannel_Config *

scConfig

)

(SERVER SIDE ONLY) Record the given secure channel configuration in returned index (SOPC_Toolkit_Initialize required and prior to SOPC_ToolkitServer_Configured call) Note: the set of indexes of secure channel configuration for client and server are disjoint

Returns

secure channel configuration index if configuration succeeded, 0 if toolkit is not initialized, already configured or otherwise

SOPC_ToolkitServer_RemoveSecureChannelConfig()

bool SOPC_ToolkitServer_RemoveSecureChannelConfig

(

uint32_t

serverScConfigIdx

)

(SERVER SIDE ONLY) Remove the secure channel configuration for the given server index

Note: the set of indexes of secure channel configuration for client and server are disjoint

Parameters

serverScConfigIdx

The secure channel configuration index requested

Returns

true if succeeded, false otherwise

SOPC_ToolkitServer_GetSecureChannelConfig()

SOPC_SecureChannel_Config * SOPC_ToolkitServer_GetSecureChannelConfig

(

uint32_t

serverScConfigIdx

)

(SERVER SIDE ONLY) Return the secure channel configuration for the given index or null if not defined. (SOPC_ToolkitServer_Configured required) Note: the set of indexes of secure channel configuration for client and server are disjoint

Parameters

serverScConfigIdx

The secure channel configuration index requested

Returns

Secure channel configuration at given index or NULL if index invalid or toolkit is not configured yet

SOPC_ToolkitClient_GetSecureChannelConfig()

SOPC_SecureChannel_Config * SOPC_ToolkitClient_GetSecureChannelConfig

(

uint32_t

scConfigIdx

)

(CLIENT SIDE ONLY) Return the secure channel configuration for the given index or null if not defined. Note: the set of indexes of secure channel configuration for client and server are disjoint

Parameters

scConfigIdx

The secure channel configuration index requested

Returns

Secure channel configuration at given index or NULL if index invalid or toolkit is not initialized

SOPC_ToolkitClient_GetReverseEndpointURL()

const char * SOPC_ToolkitClient_GetReverseEndpointURL

(

SOPC_ReverseEndpointConfigIdx

reverseEpCfgIdx

)

(CLIENT SIDE ONLY) Return the client endpoint URL for the given reverse endpoint configuration index or null if not defined Note: the set of indexes of (reverse) endpoint configuration indexes for client and server are disjoint

Parameters

reverseEpCfgIdx

The secure channel configuration index requested

Returns

The client endpointURL of the reverse endpoint or NULL if index invalid or toolkit is not initialized