util_b2c.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 UTIL_B2C_H_
#define UTIL_B2C_H_
 
#include <stdbool.h>
 
#include "b2c.h"
#include "constants.h"
#include "constants_statuscodes_bs.h"
 
#include "address_space_impl.h"
#include "opcua_statuscodes.h"
#include "sopc_assert.h"
#include "sopc_encodeabletype.h"
#include "sopc_types.h"
#include "sopc_user_manager.h"
 
void util_message__get_encodeable_type(const constants__t_msg_type_i message__msg_type,
                                       SOPC_EncodeableType** reqEncType,
                                       SOPC_EncodeableType** respEncType,
                                       t_bool* isRequest);
 
void util_message__get_message_type(SOPC_EncodeableType* encType, constants__t_msg_type_i* message__msg_type);
 
void util_message__copy_resp_header_into_msg(const constants__t_msg_header_i header, const constants__t_msg_i msg);
 
void util_status_code__B_to_C(constants_statuscodes_bs__t_StatusCode_i bstatus, SOPC_StatusCode* status);
 
void util_status_code__C_to_B(SOPC_StatusCode status, constants_statuscodes_bs__t_StatusCode_i* bstatus);
 
SOPC_ReturnStatus util_status_code__B_to_return_status_C(constants_statuscodes_bs__t_StatusCode_i bstatus);
 
constants_statuscodes_bs__t_StatusCode_i util_return_status__C_to_status_code_B(SOPC_ReturnStatus status);
 
bool util_channel__SecurityPolicy_C_to_B(const char* uri, constants__t_SecurityPolicy* secpol);
 
const char* util_channel__SecurityPolicy_B_to_C(constants__t_SecurityPolicy secpol);
 
constants__t_BrowseDirection_i util_BrowseDirection__C_to_B(OpcUa_BrowseDirection cdir);
 
OpcUa_BrowseDirection util_BrowseDirection__B_to_C(constants__t_BrowseDirection_i bdir);
 
/* Returns true or false upon failure (c_NodeClass_indet or invalid cncl) */
bool util_NodeClass__B_to_C(constants__t_NodeClass_i bncl, OpcUa_NodeClass* cncl);
 
/* Returns true or false upon failure (invalid bncl) */
bool util_NodeClass__C_to_B(OpcUa_NodeClass cncl, constants__t_NodeClass_i* bncl);
 
/* Returns true or false upon failure (c_TimestampsToReturn_indet or invalid pcttr) */
bool util_TimestampsToReturn__B_to_C(constants__t_TimestampsToReturn_i bttr, OpcUa_TimestampsToReturn* pcttr);
 
/* Returns B enum value corresponding to C enum value of timestamps to return */
constants__t_TimestampsToReturn_i util_TimestampsToReturn__C_to_B(OpcUa_TimestampsToReturn cttr);
 
/* Returns a "valid" enum value in constants__t_AttributeId_i, indet value is used if not recognised integer */
constants__t_AttributeId_i util_AttributeId__C_to_B(uint32_t caid);
 
/* Raise exception upon failure (invalid B operation type or invalid pointer) */
void util_operation_type__B_to_C(constants__t_operation_type_i boptype, SOPC_UserAuthorization_OperationType* pcoptype);
 
/* Fill empty allocated and initialized variant dest with the given IndexRange of the source variant src */
constants_statuscodes_bs__t_StatusCode_i util_read_value_indexed_helper(SOPC_Variant* dst,
                                                                        const SOPC_Variant* src,
                                                                        const SOPC_NumericRange* range);
 
/* Fill empty allocated and initialized variant dest with the given IndexRange (as String) of the source variant src */
constants_statuscodes_bs__t_StatusCode_i util_read_value_string_indexed(SOPC_Variant* dst,
                                                                        const SOPC_Variant* src,
                                                                        const SOPC_String* range_str);
 
void util_NodeId_borrowReference_or_indet__C_to_B(constants__t_NodeId_i* bnodeId, SOPC_NodeId* nodeId);
 
/* Normalizes the returned value to be either 'true' or 'false' since those are tested in code translated from B model
 */
t_bool util_SOPC_Boolean_to_B(const SOPC_Boolean b);
 
/* Returns true if the security mode enumerated value is included in the security mode masks */
bool util_SecuModeEnumIncludedInSecuModeMasks(OpcUa_MessageSecurityMode msgSecurityMode, uint16_t securityModes);
 
#endif /* UTIL_B2C_H */