SOPC_Client_Config Struct Reference

OPC UA client configuration structure. More...

#include <sopc_user_app_itf.h>

Data Fields
OpcUa_ApplicationDescription	clientDescription
bool	freeCstringsFlag
char **	clientLocaleIds
bool	isConfigFromPathsNeeded
SOPC_Client_ConfigFromPaths *	configFromPaths
SOPC_KeyCertPair *	clientKeyCertPair
SOPC_PKIProvider *	clientPKI
uint16_t	nbSecureConnections
SOPC_SecureConnection_Config *	secureConnections [SOPC_MAX_CLIENT_SECURE_CONNECTIONS_CONFIG]
uint16_t	nbReverseEndpointURLs
char *	reverseEndpointURLs [SOPC_MAX_CLIENT_SECURE_CONNECTIONS_CONFIG]

Detailed Description

OPC UA client configuration structure.

Field Documentation

clientDescription

OpcUa_ApplicationDescription SOPC_Client_Config::clientDescription

Application description of the client.

Warning

: The ApplicationURI is automatically extracted from certificate when the client certificate is used. If no certificate used or URI extraction failed, the ApplicationURI of clientDescription is used.

freeCstringsFlag

bool SOPC_Client_Config::freeCstringsFlag

A flag to indicate if the following C strings contained in the client configuration shall be freed

clientLocaleIds

char** SOPC_Client_Config::clientLocaleIds

An array of locale ids preferred by the client terminated by a NULL pointer. It might be NULL if there are no preferred locale ids. The array of locale ids indicates priority order for localized strings. The first LocaleId in the array has the highest priority.

isConfigFromPathsNeeded

bool SOPC_Client_Config::isConfigFromPathsNeeded

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

configFromPaths

SOPC_Client_ConfigFromPaths* SOPC_Client_Config::configFromPaths

The paths configuration to use for PKI and client certificate and key if if isConfigFromPathsNeeded is true. NULL otherwise. (used to configure clientCertificate, clientKey and clientPKI)

clientKeyCertPair

SOPC_KeyCertPair* SOPC_Client_Config::clientKeyCertPair

Key and certificate might be set from paths or bytes arrays

clientPKI

SOPC_PKIProvider* SOPC_Client_Config::clientPKI

PKI might be set from paths or bytes arrays

nbSecureConnections

uint16_t SOPC_Client_Config::nbSecureConnections

Number of secure connections defined by the client

secureConnections

SOPC_SecureConnection_Config* SOPC_Client_Config::secureConnections[SOPC_MAX_CLIENT_SECURE_CONNECTIONS_CONFIG]

Secure connection configuration array. Indexes [0;nbSecureConnections[ shall contain non-null configuration.

nbReverseEndpointURLs

uint16_t SOPC_Client_Config::nbReverseEndpointURLs

reverseEndpointURLs

char* SOPC_Client_Config::reverseEndpointURLs[SOPC_MAX_CLIENT_SECURE_CONNECTIONS_CONFIG]

Reverse endpoint URLs array. Maximum 1 per secure connection config.

---

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

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