toolkit_helpers.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 TOOLKIT_HELPERS_H_
#define TOOLKIT_HELPERS_H_
 
#define MAX_NOTIFICATIONS_PER_REQUEST 1000
 
#include <stdarg.h>
#include <stdbool.h>
 
#include "sopc_key_manager.h"
#include "sopc_types.h"
 
/* The following includes are required to fetch the SOPC_LibSub_Value, SOPC_LibSub_DataTime and logger types */
#include "sopc_builtintypes.h"
#include "sopc_crypto_profiles.h"
#include "sopc_log_manager.h"
#include "sopc_types.h"
#include "sopc_user_app_itf.h"
#define SKIP_S2OPC_DEFINITIONS
#include "libs2opc_client.h"
 
SOPC_ReturnStatus Helpers_NewSCConfigFromLibSubCfg(const char* szServerUrl,
                                                   const char* szServerUri,
                                                   const char* szSecuPolicy,
                                                   OpcUa_MessageSecurityMode msgSecurityMode,
                                                   bool bDisablePKI,
                                                   const char* szPathCertifAuth,
                                                   const char* szPathCertServer,
                                                   const char* szPathCertClient,
                                                   const char* szPathKeyClient,
                                                   const char* szPathCrl,
                                                   uint32_t iScRequestedLifetime,
                                                   const OpcUa_GetEndpointsResponse* expectedEndpoints,
                                                   SOPC_Client_Config* clientAppCfg,
                                                   SOPC_SecureChannel_Config** ppNewCfg);
 
void Helpers_SecureChannel_Config_Free(SOPC_SecureChannel_Config** ppscConfig);
 
SOPC_ReturnStatus Helpers_NewCreateSubscriptionRequest(double fPublishIntervalMs,
                                                       uint32_t iCntMaxKeepAlive,
                                                       uint32_t iCntLifetime,
                                                       void** ppRequest);
SOPC_ReturnStatus Helpers_NewDeleteSubscriptionRequest(uint32_t subscriptionId, void** ppRequest);
 
SOPC_ReturnStatus Helpers_NewPublishRequest(bool bAck, uint32_t iSubId, uint32_t iSeqNum, void** ppRequest);
 
SOPC_ReturnStatus Helpers_NewCreateMonitoredItemsRequest(SOPC_NodeId** lpNid,
                                                         const uint32_t* liAttrId,
                                                         int32_t nElems,
                                                         uint32_t iSubId,
                                                         OpcUa_TimestampsToReturn tsToReturn,
                                                         uint32_t* liCliHndl,
                                                         uint32_t iQueueSize,
                                                         void** ppRequest);
 
SOPC_ReturnStatus Helpers_NewValueFromDataValue(SOPC_DataValue* pVal, SOPC_LibSub_Value** pplsVal);
 
SOPC_LibSub_Timestamp Helpers_OPCTimeToNTP(SOPC_DateTime ts);
 
void Helpers_Log(const SOPC_Log_Level log_level, const char* format, ...);
 
void Helpers_SetLogger(SOPC_LibSub_LogCbk cbk);
 
void Helpers_LoggerStdout(const SOPC_Log_Level log_level, const SOPC_LibSub_CstString text);
 
#endif /* TOOLKIT_HELPERS_H_ */