S2OPC OPCUA Toolkit
Loading...
Searching...
No Matches
sopc_toolkit_config_internal.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
27#ifndef SOPC_TOOLKIT_CONFIG_INTERNAL_H_
28#define SOPC_TOOLKIT_CONFIG_INTERNAL_H_
29
30#include "sopc_address_space.h"
31#include "sopc_event_handler.h"
32#include "sopc_toolkit_config.h"
34#include "sopc_user_app_itf.h"
35
36// Macro used to check EP configuration index validity depending on classic / reverse type
37#define SOPC_IS_VALID_EP_CONFIGURATION(x) ((x) > 0 && (x) <= 2 * SOPC_MAX_ENDPOINT_DESCRIPTION_CONFIGURATIONS)
38#define SOPC_IS_VALID_CLASSIC_EP_CONFIGURATION(x) ((x) > 0 && (x) <= SOPC_MAX_ENDPOINT_DESCRIPTION_CONFIGURATIONS)
39#define SOPC_IS_VALID_REVERSE_EP_CONFIGURATION(x) \
40 ((x) > SOPC_MAX_ENDPOINT_DESCRIPTION_CONFIGURATIONS && (x) <= 2 * SOPC_MAX_ENDPOINT_DESCRIPTION_CONFIGURATIONS)
41
52
63
73bool SOPC_ToolkitServer_RemoveSecureChannelConfig(uint32_t serverScConfigIdx);
74
86
97
108
109#endif /* SOPC_TOOLKIT_CONFIG_INTERNAL_H_ */
This module shall be used to initialize, configure and clear/terminate the toolkit execution.
uint32_t SOPC_ReverseEndpointConfigIdx
Index type for reverse endpoint configuration, 0 is an invalid index.
Definition sopc_toolkit_config.h:142
uint32_t SOPC_SecureChannelConfigIdx
Index type for client secure channel configuration, 0 is an invalid index.
Definition sopc_toolkit_config.h:109
Contains the configuration constants used by the Tookit. Those constants could be modified for specif...
SOPC_SecureChannel_Config * SOPC_ToolkitServer_GetSecureChannelConfig(uint32_t serverScConfigIdx)
(SERVER SIDE ONLY) Return the secure channel configuration for the given index or null if not defined...
SOPC_SecureChannel_Config * SOPC_ToolkitClient_GetSecureChannelConfig(uint32_t scConfigIdx)
(CLIENT SIDE ONLY) Return the secure channel configuration for the given index or null if not defined...
const char * SOPC_ToolkitClient_GetReverseEndpointURL(SOPC_ReverseEndpointConfigIdx reverseEpCfgIdx)
(CLIENT SIDE ONLY) Return the client endpoint URL for the given reverse endpoint configuration index ...
SOPC_Endpoint_Config * SOPC_ToolkitServer_GetEndpointConfig(uint32_t epConfigIdx)
Return the endpoint configuration for the given index or null if not defined. (SOPC_ToolkitServer_Con...
bool SOPC_ToolkitServer_RemoveSecureChannelConfig(uint32_t serverScConfigIdx)
(SERVER SIDE ONLY) Remove the secure channel configuration for the given server index
SOPC_SecureChannelConfigIdx SOPC_ToolkitServer_AddSecureChannelConfig(SOPC_SecureChannel_Config *scConfig)
(SERVER SIDE ONLY) Record the given secure channel configuration in returned index (SOPC_Toolkit_Init...
Contains the types to be used by the user application to use the Toolkit.
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