S2OPC OPCUA Toolkit: SOPC_SecureConnection

Structure representing a secure connection configuration (secure channel + session) which allow to establish a connection to a server. More...

#include <sopc_user_app_itf.h>

Data Fields
const char *	userDefinedId

SOPC_SecureChannel_Config	scConfig

const char *	reverseURL

bool	isServerCertFromPathNeeded

char *	serverCertPath

SOPC_KeyCertPairUpdateCb *	serverCertUpdateCb

uintptr_t	serverCertUpdateParam

SOPC_Session_Config	sessionConfig

uint16_t	secureConnectionIdx

uint32_t	reverseEndpointConfigIdx

uint32_t	secureChannelConfigIdx

bool	finalized

Detailed Description

Structure representing a secure connection configuration (secure channel + session) which allow to establish a connection to a server.

Field Documentation

◆ userDefinedId

const char* SOPC_SecureConnection_Config::userDefinedId

◆ scConfig

SOPC_SecureChannel_Config SOPC_SecureConnection_Config::scConfig

◆ reverseURL

const char* SOPC_SecureConnection_Config::reverseURL

◆ isServerCertFromPathNeeded

bool SOPC_SecureConnection_Config::isServerCertFromPathNeeded

True if the following field shall be treated to configure the client

◆ serverCertPath

char* SOPC_SecureConnection_Config::serverCertPath

Path to the server certificate if isServerCertFromPathNeeded true, NULL otherwise (scConfig.peerAppCert shall be instantiated by applicative code)

◆ serverCertUpdateCb

SOPC_KeyCertPairUpdateCb* SOPC_SecureConnection_Config::serverCertUpdateCb

This callback shall be set in case the server certificate held by scConfig.peerAppCert needs to be updated at runtime.

◆ serverCertUpdateParam

uintptr_t SOPC_SecureConnection_Config::serverCertUpdateParam

The parameter to provide to serverCertUpdateCb callback

◆ sessionConfig

SOPC_Session_Config SOPC_SecureConnection_Config::sessionConfig

Session activation data

◆ secureConnectionIdx

uint16_t SOPC_SecureConnection_Config::secureConnectionIdx

Index into SOPC_Client_Config secureConnections array

◆ reverseEndpointConfigIdx

uint32_t SOPC_SecureConnection_Config::reverseEndpointConfigIdx

(Optional) Index of the Reverse Endpoint configuration to listen for server connection returned by SOPC_ToolkitClient_AddReverseEndpointConfig(). If not applicable it shall be 0.

◆ secureChannelConfigIdx

uint32_t SOPC_SecureConnection_Config::secureChannelConfigIdx

Index of the Secure Channel configuration for endpoint connection returned by SOPC_ToolkitClient_AddSecureChannelConfig(). It shall not be 0.

◆ finalized

bool SOPC_SecureConnection_Config::finalized

The documentation for this struct was generated from the following file:

/builds/systerel/S2OPC/src/ClientServer/api_toolkit/sopc_user_app_itf.h

Data Fields