libs2opc_client.h

Go to the documentation of this file.

/*
 * Licensed to Systerel under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Systerel licenses this file to you under the Apache
 * License, Version 2.0 (the "License"); you may not use this
 * file except in compliance with the License. You may obtain
 * a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#ifndef LIBS2OPC_CLIENT_H_
#define LIBS2OPC_CLIENT_H_
/*
  Notes:
  This header is designed so as to make it possible to generate automatically an Ada specification package (.ads)
    for any application that would have to link the staticC  library S2OPC_CLIENT.
  The Generation of .ADS file can be done using the following command:
     g++ -c -std=gnu++11 -fdump-ada-spec -C libs2opc_client.h
  gcc also works but loses parameter names in function prototypes, that is why the g++ and 'extern "C"' are used.
*/
 
#include <stdint.h>
 
/*
 =================
 TYPES DEFINITION
 ================= */
 
/* S2OPC types: define them except when SKIP_S2OPC_DEFINITIONS is defined.
 * To use the LibSub with other parts of the S2OPC Toolkit, you shall define SKIP_S2OPC_DEFINITIONS
 * and includes the following files before including this header:
 *  sopc_builtintypes.h
 *  sopc_user_app_itf.h
 */
#ifndef SKIP_S2OPC_DEFINITIONS
 
/*
  Data value quality
  TBD? Masks for BAD and UNCERTAIN quality?
  Taken from sop "sopc_builtintypes.h" */
typedef uint32_t SOPC_StatusCode;
 
/* Result, taken from "sopc_enums.h" */
typedef enum SOPC_ReturnStatus
{
    SOPC_STATUS_OK = 0,
    SOPC_STATUS_NOK = 1,
    SOPC_STATUS_INVALID_PARAMETERS = 2,
    SOPC_STATUS_INVALID_STATE = 3,
    SOPC_STATUS_ENCODING_ERROR = 4,
    SOPC_STATUS_WOULD_BLOCK = 5,
    SOPC_STATUS_TIMEOUT = 6,
    SOPC_STATUS_OUT_OF_MEMORY = 7,
    SOPC_STATUS_CLOSED = 8,
    SOPC_STATUS_NOT_SUPPORTED = 9
} SOPC_ReturnStatus;
 
/* Log levels, taken from "sopc_user_app_itf.h" */
typedef enum
{
    SOPC_LOG_LEVEL_ERROR = 0,
    SOPC_LOG_LEVEL_WARNING = 1,
    SOPC_LOG_LEVEL_INFO = 2,
    SOPC_LOG_LEVEL_DEBUG = 3
} SOPC_Log_Level;
 
/* SecurityMode, directly compatible with the encoded OPC-UA type,
 * taken from "sopc_types.h" */
typedef enum
{
    OpcUa_MessageSecurityMode_Invalid = 0,
    OpcUa_MessageSecurityMode_None = 1,
    OpcUa_MessageSecurityMode_Sign = 2,
    OpcUa_MessageSecurityMode_SignAndEncrypt = 3
} OpcUa_MessageSecurityMode;
 
/* Security policies, taken from "sopc_crypto_profiles.h" */
#define SOPC_SecurityPolicy_None_URI "http://opcfoundation.org/UA/SecurityPolicy#None"
#define SOPC_SecurityPolicy_Basic256_URI "http://opcfoundation.org/UA/SecurityPolicy#Basic256"
#define SOPC_SecurityPolicy_Basic256Sha256_URI "http://opcfoundation.org/UA/SecurityPolicy#Basic256Sha256"
#define SOPC_SecurityPolicy_Aes128Sha256RsaOaep_URI "http://opcfoundation.org/UA/SecurityPolicy#Aes128_Sha256_RsaOaep"
#define SOPC_SecurityPolicy_Aes256Sha256RsaPss_URI "http://opcfoundation.org/UA/SecurityPolicy#Aes256_Sha256_RsaPss"
 
typedef enum
{
    SOPC_USER_POLICY_ID_ANONYMOUS = 0,
    SOPC_USER_POLICY_ID_USERNAME = 1
} SOPC_UserPolicyId;
 
void SOPC_Sleep(unsigned int milliseconds);
#endif
 
/* C String type */
typedef char* SOPC_LibSub_String;
 
/* C Const String type */
typedef const char* SOPC_LibSub_CstString;
 
/* Connnection configuration identifier */
typedef uint32_t SOPC_LibSub_ConfigurationId;
 
/* Connection identifier */
typedef uint32_t SOPC_LibSub_ConnectionId;
 
/* Data identifier (used for subscription change notification) */
typedef uint32_t SOPC_LibSub_DataId;
 
/* Timestamp (NTP Format) */
typedef uint64_t SOPC_LibSub_Timestamp;
 
/* Data value type */
typedef enum
{
    SOPC_LibSub_DataType_bool = 1,
    SOPC_LibSub_DataType_integer = 2,
    SOPC_LibSub_DataType_string = 3,
    SOPC_LibSub_DataType_bytestring = 4,
    SOPC_LibSub_DataType_other = 5
} SOPC_LibSub_DataType;
 
typedef struct
{
    SOPC_LibSub_DataType type;
    SOPC_StatusCode quality;
    void* value;
    int32_t length;
    SOPC_LibSub_Timestamp source_timestamp;
    SOPC_LibSub_Timestamp server_timestamp;
    void* raw_value;
} SOPC_LibSub_Value;
 
typedef uint32_t SOPC_LibSub_AttributeId;
 
#define SOPC_LibSub_AttributeId_NodeId 1
#define SOPC_LibSub_AttributeId_NodeClass 2
#define SOPC_LibSub_AttributeId_BrowseName 3
#define SOPC_LibSub_AttributeId_DisplayName 4
#define SOPC_LibSub_AttributeId_Description 5
#define SOPC_LibSub_AttributeId_WriteMask 6
#define SOPC_LibSub_AttributeId_UserWriteMask 7
#define SOPC_LibSub_AttributeId_IsAbstract 8
#define SOPC_LibSub_AttributeId_Symmetric 9
#define SOPC_LibSub_AttributeId_InverseName 10
#define SOPC_LibSub_AttributeId_ContainsNoLoops 11
#define SOPC_LibSub_AttributeId_EventNotifier 12
#define SOPC_LibSub_AttributeId_Value 13
#define SOPC_LibSub_AttributeId_DataType 14
#define SOPC_LibSub_AttributeId_ValueRank 15
#define SOPC_LibSub_AttributeId_ArrayDimensions 16
#define SOPC_LibSub_AttributeId_AccessLevel 17
#define SOPC_LibSub_AttributeId_UserAccessLevel 18
#define SOPC_LibSub_AttributeId_MinimumSamplingInterval 19
#define SOPC_LibSub_AttributeId_Historizing 20
#define SOPC_LibSub_AttributeId_Executable 21
#define SOPC_LibSub_AttributeId_UserExecutable 22
 
typedef enum SOPC_LibSub_ApplicativeEvent
{
    SOPC_LibSub_ApplicativeEvent_SendFailed,
    SOPC_LibSub_ApplicativeEvent_Response
} SOPC_LibSub_ApplicativeEvent;
 
typedef void SOPC_LibSub_LogCbk(const SOPC_Log_Level log_level, SOPC_LibSub_CstString text);
 
typedef void SOPC_LibSub_DisconnectCbk(const SOPC_LibSub_ConnectionId c_id);
 
typedef void SOPC_LibSub_DataChangeCbk(const SOPC_LibSub_ConnectionId c_id,
                                       const SOPC_LibSub_DataId d_id,
                                       const SOPC_LibSub_Value* value);
 
typedef void SOPC_LibSub_EventCbk(SOPC_LibSub_ConnectionId c_id,
                                  SOPC_LibSub_ApplicativeEvent event,
                                  SOPC_StatusCode status,
                                  const void* response,
                                  uintptr_t responseContext);
// TODO: the const constraint on response should be released since it is not necessary and by-passed
 
/*
 =====================
 STRUCTURES DEFINITION
 ===================== */
 
typedef struct
{
    SOPC_LibSub_LogCbk* host_log_callback;
    SOPC_LibSub_DisconnectCbk* disconnect_callback;
    struct
    {
        SOPC_Log_Level level;
        const char* log_path;
        uint32_t maxBytes;
        uint16_t maxFiles;
    } toolkit_logger;
} SOPC_LibSub_StaticCfg;
 
typedef struct
{
    uint32_t reverse_config_idx;
 
    SOPC_LibSub_CstString server_uri;
    SOPC_LibSub_CstString server_url;
    SOPC_LibSub_CstString security_policy;
    OpcUa_MessageSecurityMode security_mode;
    uint8_t disable_certificate_verification;
    SOPC_LibSub_CstString path_cert_auth;
    SOPC_LibSub_CstString path_crl;
    SOPC_LibSub_CstString path_cert_srv;
    SOPC_LibSub_CstString path_cert_cli;
    SOPC_LibSub_CstString path_key_cli;
    SOPC_LibSub_CstString policyId;
    SOPC_LibSub_CstString username;
    SOPC_LibSub_CstString password;
    SOPC_LibSub_CstString path_cert_x509_token;
    SOPC_LibSub_CstString path_key_x509_token;
    bool key_x509_token_encrypted;
    int64_t publish_period_ms;
    uint32_t n_max_keepalive;
    uint32_t n_max_lifetime;
    SOPC_LibSub_DataChangeCbk* data_change_callback;
    int64_t timeout_ms;
    uint32_t sc_lifetime;
    uint16_t token_target;
    SOPC_LibSub_EventCbk* generic_response_callback;
    const void* expected_endpoints;
} SOPC_LibSub_ConnectionCfg;
 
/*
 ===================
 SERVICES DEFINITION
 =================== */
 
SOPC_LibSub_CstString SOPC_LibSub_GetVersion(void);
 
SOPC_ReturnStatus SOPC_LibSub_Initialize(const SOPC_LibSub_StaticCfg* pCfg);
 
void SOPC_LibSub_Clear(void);
 
SOPC_ReturnStatus SOPC_LibSub_ConfigureConnection(const SOPC_LibSub_ConnectionCfg* pCfg,
                                                  SOPC_LibSub_ConfigurationId* pCfgId);
 
SOPC_ReturnStatus SOPC_LibSub_Configured(void);
 
SOPC_ReturnStatus SOPC_LibSub_Connect(const SOPC_LibSub_ConfigurationId cfgId, SOPC_LibSub_ConnectionId* pCliId);
 
SOPC_ReturnStatus SOPC_LibSub_AddToSubscription(const SOPC_LibSub_ConnectionId cliId,
                                                const SOPC_LibSub_CstString* lszNodeId,
                                                const SOPC_LibSub_AttributeId* lattrId,
                                                int32_t nElements,
                                                SOPC_LibSub_DataId* lDataId);
 
SOPC_ReturnStatus SOPC_LibSub_AsyncSendRequestOnSession(SOPC_LibSub_ConnectionId cliId,
                                                        void* requestStruct,
                                                        uintptr_t requestContext);
SOPC_ReturnStatus SOPC_LibSub_Disconnect(const SOPC_LibSub_ConnectionId cliId);
 
/*--------------------------------
    TBC??
    - delete_subscription
    - delete_from_subscription
--------------------------------*/
 
void Helpers_Log(const SOPC_Log_Level log_level, const char* format, ...);
 
void Helpers_LoggerStdout(const SOPC_Log_Level log_level, const SOPC_LibSub_CstString text);
 
#endif /* LIBS2OPC_CLIENT_H_ */