sopc_toolkit_async_api.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 SOPC_TOOLKIT_ASYNC_API_H_
#define SOPC_TOOLKIT_ASYNC_API_H_
 
#include <stdbool.h>
#include <stdint.h>
 
#include "sopc_builtintypes.h"
#include "sopc_enums.h"
#include "sopc_toolkit_config.h"
#include "sopc_user_app_itf.h"
 
void SOPC_ToolkitServer_AsyncOpenEndpoint(SOPC_EndpointConfigIdx endpointConfigIdx);
 
void SOPC_ToolkitServer_AsyncCloseEndpoint(SOPC_EndpointConfigIdx endpointConfigIdx);
 
void SOPC_ToolkitServer_AsyncLocalServiceRequest(SOPC_EndpointConfigIdx endpointConfigIdx,
                                                 void* requestStruct,
                                                 uintptr_t requestContext);
 
void SOPC_ToolkitServer_TriggerEvent(const SOPC_NodeId* notifierNodeId,
                                     SOPC_Event* event,
                                     uint32_t optSubscriptionId,
                                     uint32_t optMonitoredItemId);
 
void SOPC_ToolkitServer_AsyncReEvalSecureChannels(bool ownCert);
 
void SOPC_ToolkitServer_AsyncReEvalUserCertSessions(void);
 
typedef struct SOPC_EndpointConnectionCfg
{
    SOPC_ReverseEndpointConfigIdx
        reverseEndpointConfigIdx; /*<< Index of the Reverse Endpoint configuration to listen for server connection
                                       returned by ::SOPC_ToolkitClient_AddReverseEndpointConfig().
                                       It shall be 0 for a classic connection and > 0 for a reverse connection. */
    SOPC_SecureChannelConfigIdx
        secureChannelConfigIdx; /*<< Index of the Secure Channel configuration for endpoint connection
                                     returned by ::SOPC_ToolkitClient_AddSecureChannelConfig().
                                     It shall not be 0. */
} SOPC_EndpointConnectionCfg;
 
SOPC_EndpointConnectionCfg SOPC_EndpointConnectionCfg_CreateClassic(SOPC_SecureChannelConfigIdx secureChannelConfigIdx);
 
SOPC_EndpointConnectionCfg SOPC_EndpointConnectionCfg_CreateReverse(
    SOPC_ReverseEndpointConfigIdx reverseEndpointConfigIdx,
    SOPC_SecureChannelConfigIdx secureChannelConfigIdx);
 
SOPC_ReturnStatus SOPC_ToolkitClient_AsyncActivateSession(SOPC_EndpointConnectionCfg endpointConnectionCfg,
                                                          const char* sessionName,
                                                          uintptr_t sessionContext,
                                                          SOPC_ExtensionObject* userToken,
                                                          void* userTokenCtx);
 
SOPC_ReturnStatus SOPC_ToolkitClient_AsyncActivateSession_Anonymous(SOPC_EndpointConnectionCfg endpointConnectionCfg,
                                                                    const char* sessionName,
                                                                    uintptr_t sessionContext,
                                                                    const char* policyId);
 
SOPC_ReturnStatus SOPC_ToolkitClient_AsyncActivateSession_UsernamePassword(
    SOPC_EndpointConnectionCfg endpointConnectionCfg,
    const char* sessionName,
    uintptr_t sessionContext,
    const char* policyId,
    const char* username,
    const uint8_t* password,
    int32_t length_password);
 
SOPC_ReturnStatus SOPC_ToolkitClient_AsyncActivateSession_Certificate(SOPC_EndpointConnectionCfg endpointConnectionCfg,
                                                                      const char* sessionName,
                                                                      uintptr_t sessionContext,
                                                                      const char* policyId,
                                                                      const SOPC_SerializedCertificate* pCertX509,
                                                                      SOPC_SerializedAsymmetricKey* pKey);
 
void SOPC_ToolkitClient_AsyncSendRequestOnSession(SOPC_SessionId sessionId,
                                                  void* requestStruct,
                                                  uintptr_t requestContext);
 
void SOPC_ToolkitClient_AsyncCloseSession(SOPC_SessionId sessionId);
 
SOPC_ReturnStatus SOPC_ToolkitClient_AsyncSendDiscoveryRequest(SOPC_EndpointConnectionCfg endpointConnectionCfg,
                                                               void* discoveryReqStruct,
                                                               uintptr_t requestContext);
void SOPC_ToolkitClient_AsyncOpenReverseEndpoint(SOPC_ReverseEndpointConfigIdx reverseEndpointConfigIdx);
 
void SOPC_ToolkitClient_AsyncCloseReverseEndpoint(SOPC_ReverseEndpointConfigIdx reverseEndpointConfigIdx);
 
void SOPC_ToolkitClient_AsyncReEvalSecureChannels(bool ownCert);
 
#endif /* SOPC_TOOLKIT_ASYNC_API_H_ */