S2OPC OPCUA Toolkit
Loading...
Searching...
No Matches
session_mgr.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
20/******************************************************************************
21
22 File Name : session_mgr.h
23
24 Date : 12/11/2024 17:42:42
25
26 C Translator Version : tradc Java V1.2 (06/02/2022)
27
28******************************************************************************/
29
30#ifndef _session_mgr_h
31#define _session_mgr_h
32
33/*--------------------------
34 Added by the Translator
35 --------------------------*/
36#include "b2c.h"
37
38/*-----------------
39 IMPORTS Clause
40 -----------------*/
41#include "session_core.h"
42#include "session_mgr_it.h"
44
45/*--------------
46 SEES Clause
47 --------------*/
49#include "channel_mgr.h"
50#include "constants.h"
52#include "message_in_bs.h"
53#include "message_out_bs.h"
54#include "request_handle_bs.h"
55
56/*------------------------
57 INITIALISATION Clause
58 ------------------------*/
60
61/*-------------------------------
62 PROMOTES and EXTENDS Clauses
63 -------------------------------*/
64#define session_mgr__allocate_x509_token_from_user session_core__allocate_x509_token_from_user
65#define session_mgr__client_secure_channel_lost_session_sm session_core__client_secure_channel_lost_session_sm
66#define session_mgr__deallocate_x509_token session_core__deallocate_x509_token
67#define session_mgr__find_channel_to_close session_core__find_channel_to_close
68#define session_mgr__get_local_user session_core__get_local_user
69#define session_mgr__get_server_session_preferred_locales session_core__get_server_session_preferred_locales
70#define session_mgr__get_session_user_server session_core__get_session_user_server
71#define session_mgr__getall_valid_session_channel session_core__getall_valid_session_channel
72#define session_mgr__is_valid_session session_core__is_valid_session
73#define session_mgr__is_valid_user_x509_authentication session_core__is_valid_user_x509_authentication
74#define session_mgr__server_secure_channel_lost_session_sm session_core__server_secure_channel_lost_session_sm
75#define session_mgr__session_has_user_server session_core__session_has_user_server
76
77/*--------------------------
78 LOCAL_OPERATIONS Clause
79 --------------------------*/
81 const constants__t_channel_config_idx_i session_mgr__channel_config_idx);
83 const constants__t_session_i session_mgr__session,
84 const constants_statuscodes_bs__t_StatusCode_i session_mgr__sc_reason);
86 const t_bool session_mgr__cond,
87 const constants__t_session_i session_mgr__session,
88 const constants_statuscodes_bs__t_StatusCode_i session_mgr__sc_reason);
90 const constants__t_channel_config_idx_i session_mgr__channel_config_idx);
92 const constants__t_channel_i session_mgr__channel,
93 const constants__t_client_request_handle_i session_mgr__req_handle,
94 t_bool * const session_mgr__bres,
95 constants__t_session_i * const session_mgr__session);
97 const constants__t_session_i session_mgr__p_session,
98 constants__t_endpoint_config_idx_i * const session_mgr__endpoint_config_idx);
99
100/*--------------------
101 OPERATIONS Clause
102 --------------------*/
104 const constants__t_channel_config_idx_i session_mgr__channel_config_idx,
105 const constants__t_channel_i session_mgr__channel,
106 const constants__t_user_token_i session_mgr__p_user_token,
107 const constants__t_session_application_context_i session_mgr__app_context,
108 t_bool * const session_mgr__bres);
110 const constants__t_channel_config_idx_i session_mgr__channel_config_idx,
111 const constants__t_user_token_i session_mgr__p_user_token,
112 const constants__t_session_application_context_i session_mgr__app_context,
113 t_bool * const session_mgr__bres);
115 const constants__t_channel_config_idx_i session_mgr__channel_config_idx,
116 const constants__t_channel_i session_mgr__channel);
118 const constants__t_session_i session_mgr__session,
119 const constants_statuscodes_bs__t_StatusCode_i session_mgr__sc_reason);
121 const constants__t_session_i session_mgr__session,
122 const constants__t_client_request_handle_i session_mgr__req_handle,
123 const constants__t_msg_i session_mgr__close_req_msg,
124 constants_statuscodes_bs__t_StatusCode_i * const session_mgr__ret,
125 constants__t_channel_i * const session_mgr__channel,
126 constants__t_session_token_i * const session_mgr__session_token);
128 const constants__t_channel_config_idx_i session_mgr__channel_config_idx);
130 const constants__t_session_i session_mgr__session,
131 const constants__t_channel_i session_mgr__channel,
132 const constants__t_client_request_handle_i session_mgr__req_handle,
133 const constants__t_msg_i session_mgr__create_req_msg,
134 t_bool * const session_mgr__bret);
136 const constants__t_channel_i session_mgr__channel,
137 const constants__t_client_request_handle_i session_mgr__req_handle,
138 const constants__t_msg_type_i session_mgr__resp_typ,
139 const constants__t_msg_header_i session_mgr__resp_header,
140 const constants__t_msg_i session_mgr__resp_msg,
141 constants__t_session_i * const session_mgr__session);
143 const constants__t_session_i session_mgr__session,
144 const constants__t_client_request_handle_i session_mgr__req_handle,
145 const constants__t_channel_i session_mgr__channel,
146 const constants__t_msg_i session_mgr__activate_req_msg,
147 constants_statuscodes_bs__t_StatusCode_i * const session_mgr__ret,
148 constants__t_session_token_i * const session_mgr__session_token);
150 const constants__t_session_i session_mgr__session,
151 const constants__t_client_request_handle_i session_mgr__req_handle,
152 const constants__t_user_token_i session_mgr__p_user_token,
153 const constants__t_msg_i session_mgr__activate_req_msg,
154 constants_statuscodes_bs__t_StatusCode_i * const session_mgr__ret,
155 constants__t_channel_i * const session_mgr__channel,
156 constants__t_session_token_i * const session_mgr__session_token);
158 const constants__t_session_i session_mgr__session,
159 const constants__t_client_request_handle_i session_mgr__req_handle,
160 constants_statuscodes_bs__t_StatusCode_i * const session_mgr__ret,
161 constants__t_channel_i * const session_mgr__channel,
162 constants__t_session_token_i * const session_mgr__session_token);
164 const constants__t_channel_i session_mgr__channel,
165 const constants__t_client_request_handle_i session_mgr__req_handle,
166 t_bool * const session_mgr__bres);
168 const constants__t_channel_i session_mgr__channel,
169 const constants__t_client_request_handle_i session_mgr__req_handle,
170 t_bool * const session_mgr__bres,
171 constants__t_session_i * const session_mgr__session);
173 const constants__t_session_i session_mgr__session,
174 const constants_statuscodes_bs__t_StatusCode_i session_mgr__sc_reason);
177 const constants__t_session_i session_mgr__session);
179 const constants__t_channel_i session_mgr__channel,
180 const constants__t_session_token_i session_mgr__session_token,
181 const constants__t_msg_i session_mgr__req_msg,
182 const constants__t_msg_type_i session_mgr__req_typ,
183 const constants__t_msg_i session_mgr__resp_msg,
184 constants__t_session_i * const session_mgr__session,
185 constants_statuscodes_bs__t_StatusCode_i * const session_mgr__service_ret,
186 t_bool * const session_mgr__security_failed);
188 const constants__t_session_i session_mgr__session,
189 t_bool * const session_mgr__is_valid_res,
190 constants_statuscodes_bs__t_StatusCode_i * const session_mgr__status_code_err,
191 constants__t_channel_i * const session_mgr__channel);
193 const constants__t_channel_i session_mgr__channel,
194 const constants__t_session_token_i session_mgr__session_token,
195 t_bool * const session_mgr__is_valid_res,
196 constants__t_session_i * const session_mgr__session,
197 constants_statuscodes_bs__t_StatusCode_i * const session_mgr__status_code_err);
199 const constants__t_session_i session_mgr__p_session,
200 constants__t_endpoint_config_idx_i * const session_mgr__endpoint_config_idx);
202
203#endif
bool t_bool
Definition b2c.h:28
#define constants__t_endpoint_config_idx_i
Definition constants.h:94
#define constants__t_client_request_handle_i
Definition constants.h:93
#define constants__t_msg_header_i
Definition constants.h:103
#define constants__t_session_i
Definition constants.h:116
#define constants__t_msg_i
Definition constants.h:104
#define constants__t_session_application_context_i
Definition constants.h:115
#define constants__t_user_token_i
Definition constants.h:123
#define constants__t_session_token_i
Definition constants.h:117
#define constants__t_channel_config_idx_i
Definition constants.h:90
#define constants__t_channel_i
Definition constants.h:91
constants__t_msg_type_i
Definition constants.h:223
constants_statuscodes_bs__t_StatusCode_i
Definition constants_statuscodes_bs.h:46
void session_mgr__server_validate_async_session_service_resp(const constants__t_session_i session_mgr__session, t_bool *const session_mgr__is_valid_res, constants_statuscodes_bs__t_StatusCode_i *const session_mgr__status_code_err, constants__t_channel_i *const session_mgr__channel)
void session_mgr__local_session_get_endpoint_config(const constants__t_session_i session_mgr__p_session, constants__t_endpoint_config_idx_i *const session_mgr__endpoint_config_idx)
void session_mgr__local_client_close_session(const constants__t_session_i session_mgr__session, const constants_statuscodes_bs__t_StatusCode_i session_mgr__sc_reason)
void session_mgr__client_close_sessions_on_final_connection_failure(const constants__t_channel_config_idx_i session_mgr__channel_config_idx)
void session_mgr__session_mgr_UNINITIALISATION(void)
void session_mgr__session_get_endpoint_config(const constants__t_session_i session_mgr__p_session, constants__t_endpoint_config_idx_i *const session_mgr__endpoint_config_idx)
void session_mgr__local_client_close_session_if_needed(const t_bool session_mgr__cond, const constants__t_session_i session_mgr__session, const constants_statuscodes_bs__t_StatusCode_i session_mgr__sc_reason)
void session_mgr__client_async_activate_new_session_with_channel(const constants__t_channel_config_idx_i session_mgr__channel_config_idx, const constants__t_channel_i session_mgr__channel, const constants__t_user_token_i session_mgr__p_user_token, const constants__t_session_application_context_i session_mgr__app_context, t_bool *const session_mgr__bres)
void session_mgr__local_client_validate_and_drop_session_req_session_handle(const constants__t_channel_i session_mgr__channel, const constants__t_client_request_handle_i session_mgr__req_handle, t_bool *const session_mgr__bres, constants__t_session_i *const session_mgr__session)
void session_mgr__client_validate_session_service_req(const constants__t_session_i session_mgr__session, const constants__t_client_request_handle_i session_mgr__req_handle, constants_statuscodes_bs__t_StatusCode_i *const session_mgr__ret, constants__t_channel_i *const session_mgr__channel, constants__t_session_token_i *const session_mgr__session_token)
void session_mgr__server_receive_session_req(const constants__t_channel_i session_mgr__channel, const constants__t_session_token_i session_mgr__session_token, const constants__t_msg_i session_mgr__req_msg, const constants__t_msg_type_i session_mgr__req_typ, const constants__t_msg_i session_mgr__resp_msg, constants__t_session_i *const session_mgr__session, constants_statuscodes_bs__t_StatusCode_i *const session_mgr__service_ret, t_bool *const session_mgr__security_failed)
void session_mgr__client_channel_connected_event_session(const constants__t_channel_config_idx_i session_mgr__channel_config_idx, const constants__t_channel_i session_mgr__channel)
void session_mgr__client_validate_session_service_resp(const constants__t_channel_i session_mgr__channel, const constants__t_client_request_handle_i session_mgr__req_handle, t_bool *const session_mgr__bres, constants__t_session_i *const session_mgr__session)
void session_mgr__client_receive_session_resp(const constants__t_channel_i session_mgr__channel, const constants__t_client_request_handle_i session_mgr__req_handle, const constants__t_msg_type_i session_mgr__resp_typ, const constants__t_msg_header_i session_mgr__resp_header, const constants__t_msg_i session_mgr__resp_msg, constants__t_session_i *const session_mgr__session)
void session_mgr__client_validate_session_service_req_failed(const constants__t_channel_i session_mgr__channel, const constants__t_client_request_handle_i session_mgr__req_handle, t_bool *const session_mgr__bres)
void session_mgr__client_close_session_req(const constants__t_session_i session_mgr__session, const constants__t_client_request_handle_i session_mgr__req_handle, const constants__t_msg_i session_mgr__close_req_msg, constants_statuscodes_bs__t_StatusCode_i *const session_mgr__ret, constants__t_channel_i *const session_mgr__channel, constants__t_session_token_i *const session_mgr__session_token)
void session_mgr__client_sc_activate_session_req(const constants__t_session_i session_mgr__session, const constants__t_client_request_handle_i session_mgr__req_handle, const constants__t_channel_i session_mgr__channel, const constants__t_msg_i session_mgr__activate_req_msg, constants_statuscodes_bs__t_StatusCode_i *const session_mgr__ret, constants__t_session_token_i *const session_mgr__session_token)
void session_mgr__server_close_session(const constants__t_session_i session_mgr__session, const constants_statuscodes_bs__t_StatusCode_i session_mgr__sc_reason)
void session_mgr__client_close_session(const constants__t_session_i session_mgr__session, const constants_statuscodes_bs__t_StatusCode_i session_mgr__sc_reason)
void session_mgr__client_create_session_req(const constants__t_session_i session_mgr__session, const constants__t_channel_i session_mgr__channel, const constants__t_client_request_handle_i session_mgr__req_handle, const constants__t_msg_i session_mgr__create_req_msg, t_bool *const session_mgr__bret)
void session_mgr__server_evaluate_all_session_user_cert(void)
void session_mgr__local_client_close_sessions_on_SC_final_connection_failure(const constants__t_channel_config_idx_i session_mgr__channel_config_idx)
void session_mgr__client_async_activate_new_session_without_channel(const constants__t_channel_config_idx_i session_mgr__channel_config_idx, const constants__t_user_token_i session_mgr__p_user_token, const constants__t_session_application_context_i session_mgr__app_context, t_bool *const session_mgr__bres)
void session_mgr__client_user_activate_session_req(const constants__t_session_i session_mgr__session, const constants__t_client_request_handle_i session_mgr__req_handle, const constants__t_user_token_i session_mgr__p_user_token, const constants__t_msg_i session_mgr__activate_req_msg, constants_statuscodes_bs__t_StatusCode_i *const session_mgr__ret, constants__t_channel_i *const session_mgr__channel, constants__t_session_token_i *const session_mgr__session_token)
void session_mgr__local_client_activate_sessions_on_SC_connection(const constants__t_channel_config_idx_i session_mgr__channel_config_idx)
void session_mgr__server_validate_session_service_req(const constants__t_channel_i session_mgr__channel, const constants__t_session_token_i session_mgr__session_token, t_bool *const session_mgr__is_valid_res, constants__t_session_i *const session_mgr__session, constants_statuscodes_bs__t_StatusCode_i *const session_mgr__status_code_err)
void session_mgr__server_evaluate_session_timeout(const constants__t_session_i session_mgr__session)
void session_mgr__INITIALISATION(void)