S2OPC OPCUA Toolkit
Loading...
Searching...
No Matches
sopc_toolkit_config.h
Go to the documentation of this file.
1/*
2 * Licensed to Systerel under one or more contributor license
3 * agreements. See the NOTICE file distributed with this work
4 * for additional information regarding copyright ownership.
5 * Systerel licenses this file to you under the Apache
6 * License, Version 2.0 (the "License"); you may not use this
7 * file except in compliance with the License. You may obtain
8 * a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
32#ifndef SOPC_TOOLKIT_CONFIG_H_
33#define SOPC_TOOLKIT_CONFIG_H_
34
35#include "sopc_address_space.h"
36#include "sopc_user_app_itf.h"
37
38#include "sopc_builtintypes.h"
40#include "sopc_types.h"
41
56
69
77
90
105
110
120
124typedef uint32_t SOPC_EndpointConfigIdx;
125
138
143
156
164
178
179#endif /* SOPC_TOOLKIT_CONFIG_H_ */
struct _SOPC_AddressSpace SOPC_AddressSpace
Definition sopc_address_space.h:68
enum _SOPC_ReturnStatus SOPC_ReturnStatus
Common enumerations for S2OPC.
SOPC_ReturnStatus SOPC_Toolkit_Initialize(SOPC_ComEvent_Fct *pAppFct)
Initialize the toolkit configuration, libraries and threads.
SOPC_EndpointConfigIdx SOPC_ToolkitServer_AddEndpointConfig(SOPC_Endpoint_Config *config)
Record the given endpoint configuration in given index (SOPC_Toolkit_Initialize required and prior to...
SOPC_ReturnStatus SOPC_ToolkitServer_Configured(void)
Define toolkit configuration as configured and lock its state until toolkit clear operation.
SOPC_ReturnStatus SOPC_ToolkitServer_SetAddressSpaceConfig(SOPC_AddressSpace *addressSpace)
Set the given Address Space for the current toolkit server (SOPC_Toolkit_Initialize required and prio...
SOPC_ReturnStatus SOPC_ToolkitServer_SetAddressSpaceNotifCb(SOPC_AddressSpaceNotif_Fct *pAddSpaceNotifFct)
Set the given Address Space modification notification callback for the current toolkit server (SOPC_T...
uint32_t SOPC_ReverseEndpointConfigIdx
Index type for reverse endpoint configuration, 0 is an invalid index.
Definition sopc_toolkit_config.h:142
uint32_t SOPC_EndpointConfigIdx
Index type for server endpoint configuration, 0 is an invalid index.
Definition sopc_toolkit_config.h:124
SOPC_ReverseEndpointConfigIdx SOPC_ToolkitClient_AddReverseEndpointConfig(const char *reverseEndpointURL)
Record the given client reverse endpoint configuration in returned index (SOPC_Toolkit_Initialize req...
void SOPC_ToolkitClient_ClearAllSCs(void)
Close all Secure Channels established as client and clear associated configurations added by SOPC_Too...
void SOPC_Toolkit_Clear(void)
Clear the stack configuration.
SOPC_Toolkit_Build_Info SOPC_ToolkitConfig_GetBuildInfo(void)
Get Toolkit build information.
uint32_t SOPC_SecureChannelConfigIdx
Index type for client secure channel configuration, 0 is an invalid index.
Definition sopc_toolkit_config.h:109
SOPC_SecureChannelConfigIdx SOPC_ToolkitClient_AddSecureChannelConfig(SOPC_SecureChannel_Config *scConfig)
Record the given secure channel configuration for endpoint connection in returned index (SOPC_Toolkit...
Contains the types to be used by the user application to use the Toolkit.
void SOPC_ComEvent_Fct(SOPC_App_Com_Event event, uint32_t IdOrStatus, void *param, uintptr_t appContext)
Toolkit communication events application callback type.
Definition sopc_user_app_itf.h:471
void SOPC_AddressSpaceNotif_Fct(const SOPC_CallContext *callCtxPtr, SOPC_App_AddSpace_Event event, void *opParam, SOPC_StatusCode opStatus)
Toolkit address space notification events callback type.
Definition sopc_user_app_itf.h:476
Server configuration of a Endpoint connection listener.
Definition sopc_user_app_itf.h:140
Client configuration of a Secure Channel.
Definition sopc_user_app_itf.h:53
Toolkit build information.
Definition sopc_user_app_itf.h:485