sopc_network_layer.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 SOPC_NETWORK_LAYER_H_
#define SOPC_NETWORK_LAYER_H_
 
#include <inttypes.h>
#include "sopc_buffer.h"
#include "sopc_dataset_ll_layer.h"
#include "sopc_pub_fixed_buffer.h"
#include "sopc_pubsub_conf.h"
#include "sopc_pubsub_security.h"
#include "sopc_sub_scheduler.h"
#include "sopc_sub_target_variable.h"
 
typedef enum
{
    SOPC_NetworkMessage_Error_Code_None = 0,
    SOPC_NetworkMessage_Error_Code_InvalidParameters,
    SOPC_UADP_NetworkMessage_Error_Write_Buffer_Failed = 0x10000000,
    SOPC_UADP_NetworkMessage_Error_Write_PubId_Failed,
    SOPC_UADP_NetworkMessage_Error_Write_GroupId_Failed,
    SOPC_UADP_NetworkMessage_Error_Write_GroupVersion_Failed,
    SOPC_UADP_NetworkMessage_Error_Write_WriterId_Failed,
    SOPC_UADP_NetworkMessage_Error_Write_TokenId_Failed,
    SOPC_UADP_NetworkMessage_Error_Write_SecuHdr_Failed,
    SOPC_UADP_NetworkMessage_Error_Write_SecuFooter_Failed,
    SOPC_NetworkMessage_Error_Write_Alloc_Failed,
    SOPC_UADP_NetworkMessage_Error_Write_DsmSize_Failed,
    SOPC_UADP_NetworkMessage_Error_Write_DsmPreSize_Failed,
    SOPC_UADP_NetworkMessage_Error_Write_DsmField_Failed,
    SOPC_UADP_NetworkMessage_Error_Write_DsmSeqNum_Failed,
    SOPC_UADP_NetworkMessage_Error_Write_DsmTimestamp_Failed,
    SOPC_UADP_NetworkMessage_Error_Write_EncryptPaylod_Failed,
    SOPC_UADP_NetworkMessage_Error_Write_PayloadFlush_Failed,
    SOPC_UADP_NetworkMessage_Error_Write_Sign_Failed,
    SOPC_UADP_NetworkMessage_Error_Read_Byte_Failed = 0x20000000,
    SOPC_UADP_NetworkMessage_Error_Read_Short_Failed,
    SOPC_UADP_NetworkMessage_Error_Read_Int_Failed,
    SOPC_UADP_NetworkMessage_Error_Read_Alloc_Failed,
    SOPC_UADP_NetworkMessage_Error_Read_Security_Failed,
    SOPC_UADP_NetworkMessage_Error_Read_SecurityConf_Failed,
    SOPC_UADP_NetworkMessage_Error_Read_SecuritySign_Failed,
    SOPC_UADP_NetworkMessage_Error_Read_SecuritySignSize_Failed,
    SOPC_UADP_NetworkMessage_Error_Read_SecurityNonce_Failed,
    SOPC_UADP_NetworkMessage_Error_Read_SecurityDecrypt_Failed,
    SOPC_UADP_NetworkMessage_Error_Read_SecurityNone_Failed,
    SOPC_UADP_NetworkMessage_Error_Read_SeqNum_Failed,
    SOPC_UADP_NetworkMessage_Error_Read_DsmSkip_Failed,
    SOPC_UADP_NetworkMessage_Error_Read_DsmSize_Failed,
    SOPC_UADP_NetworkMessage_Error_Read_DsmSeqNum_Failed,
    SOPC_UADP_NetworkMessage_Error_Read_DsmSeqNumCheck_Failed,
    SOPC_UADP_NetworkMessage_Error_Read_InvalidBit,
    SOPC_UADP_NetworkMessage_Error_Read_DsmFields_Failed,
    SOPC_UADP_NetworkMessage_Error_Read_DsmSizeCheck_Failed,
    SOPC_UADP_NetworkMessage_Error_Read_DsmTimeStamp,
    SOPC_UADP_NetworkMessage_Error_Read_NoMatchingGroup = 0x30000000,
    SOPC_UADP_NetworkMessage_Error_Read_NoMatchingReader,
    SOPC_UADP_NetworkMessage_Error_Read_BadMetaData,
    SOPC_UADP_NetworkMessage_Error_Unsupported_Version = 0x40000000,
    SOPC_UADP_NetworkMessage_Error_Unsupported_Flags1,
    SOPC_UADP_NetworkMessage_Error_Unsupported_Flags2,
    SOPC_UADP_NetworkMessage_Error_Unsupported_PubIdType,
    SOPC_UADP_NetworkMessage_Error_Unsupported_ClassId,
    SOPC_UADP_NetworkMessage_Error_Unsupported_MessageNum,
    SOPC_UADP_NetworkMessage_Error_Unsupported_SeqNum,
    SOPC_UADP_NetworkMessage_Error_Unsupported_Timestamp,
    SOPC_UADP_NetworkMessage_Error_Unsupported_Picoseconds,
    SOPC_UADP_NetworkMessage_Error_Unsupported_SecurityFooterReset,
    SOPC_UADP_NetworkMessage_Error_Unsupported_PromotedFields,
    SOPC_UADP_NetworkMessage_Error_Unsupported_EncodingType,
    SOPC_UADP_NetworkMessage_Error_Unsupported_DsmType,
    SOPC_UADP_NetworkMessage_Error_Unsupported_DsmSeqNum,
    SOPC_UADP_NetworkMessage_Error_Unsupported_DsmPicoseconds,
    SOPC_JSON_NetworkMessage_Error_Generate_Unique_MessageId = 0x50000000,
    SOPC_JSON_NetworkMessage_Error_Generate_Unique_VariantName,
    SOPC_JSON_NetworkMessage_Error_Encode,
    SOPC_JSON_NetworkMessage_Error_DataSetMessage_Encode,
    SOPC_JSON_NetworkMessage_Error_Variant_Encode,
    SOPC_JSON_NetworkMessage_Error_Write_Closing_Structure,
    SOPC_JSON_NetworkMessage_Error_Security_Unsupported,
} SOPC_NetworkMessage_Error_Code;
 
typedef struct SOPC_UADP_Network_Message
{
    SOPC_Dataset_LL_NetworkMessage* nm;
} SOPC_UADP_NetworkMessage;
 
typedef bool SOPC_UADP_IsWriterSequenceNumberNewer_Func(const SOPC_Conf_PublisherId* pubId,
                                                        const uint16_t groupId,
                                                        const uint16_t writerId,
                                                        const uint16_t receivedSN);
 
typedef void SOPC_UADP_UpdateTimeout_Func(const SOPC_Conf_PublisherId* pubId,
                                          const uint16_t groupId,
                                          const uint16_t writerId);
 
bool SOPC_Is_UInt16_Sequence_Number_Newer(uint16_t received, uint16_t processed);
 
SOPC_NetworkMessage_Error_Code SOPC_JSON_NetworkMessage_Encode(SOPC_Dataset_LL_NetworkMessage* message,
                                                               SOPC_PubSub_SecurityType* security,
                                                               SOPC_Buffer** buffer);
 
SOPC_NetworkMessage_Error_Code SOPC_UADP_NetworkMessage_Encode_Buffers(SOPC_Dataset_LL_NetworkMessage* nm,
                                                                       SOPC_PubSub_SecurityType* security,
                                                                       SOPC_Buffer** buffer_header,
                                                                       SOPC_Buffer** buffer_payload);
 
SOPC_NetworkMessage_Error_Code SOPC_UADP_NetworkMessage_BuildFinalMessage(SOPC_PubSub_SecurityType* security,
                                                                          SOPC_Buffer* buffer_header,
                                                                          SOPC_Buffer** buffer_payload);
 
SOPC_Buffer* SOPC_UADP_NetworkMessage_Get_PreencodedBuffer(SOPC_Dataset_LL_NetworkMessage* nm,
                                                           SOPC_PubSub_SecurityType* security);
 
typedef const SOPC_ReaderGroup* SOPC_UADP_NetworkMessage_GetReaderGroup(const SOPC_PubSubConnection* connection,
                                                                        const SOPC_UADP_Configuration* uadp_conf,
                                                                        const SOPC_Dataset_LL_PublisherId* pubid,
                                                                        const uint32_t groupVersion,
                                                                        const uint32_t groupId);
 
typedef const SOPC_DataSetReader* SOPC_UADP_NetworkMessage_GetReader(const SOPC_ReaderGroup* group,
                                                                     const SOPC_UADP_Configuration* uadp_conf,
                                                                     const uint16_t dataSetWriterId);
 
typedef SOPC_ReturnStatus SOPC_UADP_NetworkMessage_SetDsm(SOPC_Dataset_LL_DataSetMessage* dsm,
                                                          SOPC_SubTargetVariableConfig* targetConfig,
                                                          const SOPC_DataSetReader* reader,
                                                          SOPC_TargetVariableCtx* targetVariable);
 
typedef SOPC_TargetVariableCtx* SOPC_UADP_GetTargetVariable_Func(const SOPC_Conf_PublisherId* pubId,
                                                                 const uint16_t groupId,
                                                                 const uint16_t writerId);
 
typedef struct
{
    SOPC_UADP_NetworkMessage_GetReaderGroup* pGetGroup_Func;
    SOPC_UADP_NetworkMessage_GetReader* pGetReader_Func;
    SOPC_UADP_NetworkMessage_SetDsm* pSetDsm_Func;
} SOPC_UADP_NetworkMessage_Reader_Callbacks;
 
typedef struct
{
    SOPC_UADP_NetworkMessage_Reader_Callbacks callbacks;
    SOPC_UADP_GetSecurity_Func* pGetSecurity_Func;
    SOPC_UADP_IsWriterSequenceNumberNewer_Func* checkDataSetMessageSN_Func;
    SOPC_SubTargetVariableConfig* targetConfig;
    SOPC_UADP_UpdateTimeout_Func* updateTimeout_Func;
    SOPC_UADP_GetTargetVariable_Func* targetVariable_Func;
} SOPC_UADP_NetworkMessage_Reader_Configuration;
 
SOPC_NetworkMessage_Error_Code SOPC_UADP_NetworkMessage_Decode(
    SOPC_Buffer* buffer,
    const SOPC_UADP_NetworkMessage_Reader_Configuration* reader_config,
    const SOPC_PubSubConnection* connection,
    SOPC_UADP_NetworkMessage** uadp_nm);
 
void SOPC_UADP_NetworkMessage_Delete(SOPC_UADP_NetworkMessage* uadp_nm);
 
#endif /* SOPC_NETWORK_LAYER_H_ */