S2OPC OPCUA Toolkit
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"
39 #include "sopc_common_build_info.h"
40 #include "sopc_types.h"
41 
56 
69 
76 void SOPC_Toolkit_Clear(void);
77 
90 
105 
110 
120 
124 typedef uint32_t SOPC_EndpointConfigIdx;
125 
138 
143 
156 
164 
178 
179 #endif /* SOPC_TOOLKIT_CONFIG_H_ */
SOPC_ReverseEndpointConfigIdx
uint32_t SOPC_ReverseEndpointConfigIdx
Index type for reverse endpoint configuration, 0 is an invalid index.
Definition: sopc_toolkit_config.h:142
SOPC_Endpoint_Config
Server configuration of a Endpoint connection listener.
Definition: sopc_user_app_itf.h:140
sopc_types.h
SOPC_ToolkitClient_AddReverseEndpointConfig
SOPC_ReverseEndpointConfigIdx SOPC_ToolkitClient_AddReverseEndpointConfig(const char *reverseEndpointURL)
Record the given client reverse endpoint configuration in returned index (SOPC_Toolkit_Initialize req...
SOPC_ToolkitServer_AddEndpointConfig
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_ToolkitConfig_GetBuildInfo
SOPC_Toolkit_Build_Info SOPC_ToolkitConfig_GetBuildInfo(void)
Get Toolkit build information.
SOPC_EndpointConfigIdx
uint32_t SOPC_EndpointConfigIdx
Index type for server endpoint configuration, 0 is an invalid index.
Definition: sopc_toolkit_config.h:124
sopc_builtintypes.h
SOPC_SecureChannelConfigIdx
uint32_t SOPC_SecureChannelConfigIdx
Index type for client secure channel configuration, 0 is an invalid index.
Definition: sopc_toolkit_config.h:109
SOPC_ToolkitServer_SetAddressSpaceConfig
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_AddressSpaceNotif_Fct
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
sopc_common_build_info.h
SOPC_Toolkit_Clear
void SOPC_Toolkit_Clear(void)
Clear the stack configuration.
SOPC_ToolkitServer_Configured
SOPC_ReturnStatus SOPC_ToolkitServer_Configured(void)
Define toolkit configuration as configured and lock its state until toolkit clear operation.
SOPC_AddressSpace
struct _SOPC_AddressSpace SOPC_AddressSpace
Definition: sopc_address_space.h:68
sopc_user_app_itf.h
Contains the types to be used by the user application to use the Toolkit.
SOPC_SecureChannel_Config
Client configuration of a Secure Channel.
Definition: sopc_user_app_itf.h:53
SOPC_Toolkit_Build_Info
Toolkit build information.
Definition: sopc_user_app_itf.h:485
SOPC_ToolkitServer_SetAddressSpaceNotifCb
SOPC_ReturnStatus SOPC_ToolkitServer_SetAddressSpaceNotifCb(SOPC_AddressSpaceNotif_Fct *pAddSpaceNotifFct)
Set the given Address Space modification notification callback for the current toolkit server (SOPC_T...
SOPC_ComEvent_Fct
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
sopc_address_space.h
SOPC_Toolkit_Initialize
SOPC_ReturnStatus SOPC_Toolkit_Initialize(SOPC_ComEvent_Fct *pAppFct)
Initialize the toolkit configuration, libraries and threads.
SOPC_ToolkitClient_ClearAllSCs
void SOPC_ToolkitClient_ClearAllSCs(void)
Close all Secure Channels established as client and clear associated configurations added by SOPC_Too...
SOPC_ToolkitClient_AddSecureChannelConfig
SOPC_SecureChannelConfigIdx SOPC_ToolkitClient_AddSecureChannelConfig(SOPC_SecureChannel_Config *scConfig)
Record the given secure channel configuration for endpoint connection in returned index (SOPC_Toolkit...
SOPC_ReturnStatus
SOPC_ReturnStatus
Definition: libs2opc_client.h:64