S2OPC OPCUA Toolkit
|
High level interface to configure an OPC UA client and/or server. More...
#include <stdbool.h>
#include "sopc_common.h"
#include "sopc_encodeabletype.h"
#include "sopc_types.h"
#include "sopc_user_app_itf.h"
Go to the source code of this file.
Enumerations | |
enum | SOPC_SecurityPolicy_URI { SOPC_SecurityPolicy_None , SOPC_SecurityPolicy_Basic256 , SOPC_SecurityPolicy_Basic256Sha256 , SOPC_SecurityPolicy_Aes128Sha256RsaOaep , SOPC_SecurityPolicy_Aes256Sha256RsaPss } |
Enumerated values authorized for use with SOPC_EndpointConfig_AddSecurityConfig or SOPC_ClientConfigHelper_CreateSecureConnection. Values are limited to the security policies supported by client/server. More... | |
Functions | |
SOPC_ReturnStatus | SOPC_CommonHelper_Initialize (SOPC_Log_Configuration *optLogConfig) |
Initializes the S2OPC Client/Server frontend library (start threads, initialize configuration, etc.) and define a custom log configuration. Call to SOPC_CommonHelper_Initialize is required before any other operation. | |
void | SOPC_CommonHelper_Clear (void) |
Clears the S2OPC Client/Server frontend library (stop threads, clear common configuration, etc.) Call to SOPC_CommonHelper_Clear shall be done after any Client/Server wrapper Clear operations. | |
SOPC_Toolkit_Build_Info | SOPC_CommonHelper_GetBuildInfo (void) |
Retrieves the S2OPC Client/Server frontend library build info (version, date, etc.). Shortcut to SOPC_ToolkitConfig_GetBuildInfo. | |
SOPC_S2OPC_Config * | SOPC_CommonHelper_GetConfiguration (void) |
Retrieves the S2OPC Client/Server configuration. It should be called after call to SOPC_CommonHelper_Initialize and before call to SOPC_CommonHelper_Clear. | |
bool | SOPC_CommonHelper_GetInitialized (void) |
Retrieves the S2OPC Client/Server frontend "initialized" state. | |
const char * | SOPC_SecurityPolicyUriToCstring (SOPC_SecurityPolicy_URI secuUri) |
Returns the C string matching the security policy URI enum value. | |
High level interface to configure an OPC UA client and/or server.
Enumerated values authorized for use with SOPC_EndpointConfig_AddSecurityConfig or SOPC_ClientConfigHelper_CreateSecureConnection. Values are limited to the security policies supported by client/server.
Enumerator | |
---|---|
SOPC_SecurityPolicy_None | |
SOPC_SecurityPolicy_Basic256 | |
SOPC_SecurityPolicy_Basic256Sha256 | |
SOPC_SecurityPolicy_Aes128Sha256RsaOaep | http://opcfoundation.org/UA/SecurityPolicy#Aes128_Sha256_RsaOaep |
SOPC_SecurityPolicy_Aes256Sha256RsaPss | http://opcfoundation.org/UA/SecurityPolicy#Aes256_Sha256_RsaPss |
SOPC_ReturnStatus SOPC_CommonHelper_Initialize | ( | SOPC_Log_Configuration * | optLogConfig | ) |
Initializes the S2OPC Client/Server frontend library (start threads, initialize configuration, etc.) and define a custom log configuration. Call to SOPC_CommonHelper_Initialize is required before any other operation.
optLogConfig | the custom log configuration or NULL to keep default configuration |
void SOPC_CommonHelper_Clear | ( | void | ) |
Clears the S2OPC Client/Server frontend library (stop threads, clear common configuration, etc.) Call to SOPC_CommonHelper_Clear shall be done after any Client/Server wrapper Clear operations.
SOPC_Toolkit_Build_Info SOPC_CommonHelper_GetBuildInfo | ( | void | ) |
Retrieves the S2OPC Client/Server frontend library build info (version, date, etc.). Shortcut to SOPC_ToolkitConfig_GetBuildInfo.
SOPC_S2OPC_Config * SOPC_CommonHelper_GetConfiguration | ( | void | ) |
Retrieves the S2OPC Client/Server configuration. It should be called after call to SOPC_CommonHelper_Initialize and before call to SOPC_CommonHelper_Clear.
bool SOPC_CommonHelper_GetInitialized | ( | void | ) |
Retrieves the S2OPC Client/Server frontend "initialized" state.
const char * SOPC_SecurityPolicyUriToCstring | ( | SOPC_SecurityPolicy_URI | secuUri | ) |
Returns the C string matching the security policy URI enum value.
secuUri | The security policy URI enum value |