open62541 1.4.15
Open source implementation of OPC UA
Loading...
Searching...
No Matches
Data Structures | Macros | Enumerations | Functions
ua_pubsub_networkmessage.h File Reference
#include <open62541/types.h>
#include <open62541/types_generated.h>
#include <open62541/plugin/securitypolicy.h>
#include <open62541/server_pubsub.h>

Go to the source code of this file.

Data Structures

struct  UA_DataSetPayloadHeader
 
struct  UA_DataSetMessageHeader
 
struct  UA_DataSetMessage_DataKeyFrameData
 
struct  UA_DataSetMessage_DeltaFrameField
 
struct  UA_DataSetMessage_DataDeltaFrameData
 
struct  UA_DataSetMessage
 
struct  UA_DataSetPayload
 
struct  UA_NetworkMessageGroupHeader
 
struct  UA_NetworkMessageSecurityHeader
 
struct  UA_NetworkMessage
 
struct  UA_NetworkMessageOffset
 
struct  UA_NetworkMessageOffsetBuffer
 

Macros

#define UA_NETWORKMESSAGE_MAX_NONCE_LENGTH   16
 

Enumerations

enum  UA_FieldEncoding
 
enum  UA_DataSetMessageType
 
enum  UA_NetworkMessageType
 
enum  UA_NetworkMessageOffsetType
 

Functions

void UA_NetworkMessageOffsetBuffer_clear (UA_NetworkMessageOffsetBuffer *nmob)
 
UA_StatusCode UA_NetworkMessage_updateBufferedMessage (UA_NetworkMessageOffsetBuffer *buffer)
 
UA_StatusCode UA_NetworkMessage_updateBufferedNwMessage (UA_NetworkMessageOffsetBuffer *buffer, const UA_ByteString *src, size_t *bufferPosition)
 
UA_StatusCode UA_DataSetMessageHeader_encodeBinary (const UA_DataSetMessageHeader *src, UA_Byte **bufPos, const UA_Byte *bufEnd)
 
UA_StatusCode UA_DataSetMessageHeader_decodeBinary (const UA_ByteString *src, size_t *offset, UA_DataSetMessageHeader *dst)
 
UA_StatusCode UA_DataSetMessage_encodeBinary (const UA_DataSetMessage *src, UA_Byte **bufPos, const UA_Byte *bufEnd)
 
UA_StatusCode UA_DataSetMessage_decodeBinary (const UA_ByteString *src, size_t *offset, UA_DataSetMessage *dst, UA_UInt16 dsmSize, const UA_DataTypeArray *customTypes, UA_DataSetMetaDataType *dsm)
 
size_t UA_DataSetMessage_calcSizeBinary (UA_DataSetMessage *p, UA_NetworkMessageOffsetBuffer *offsetBuffer, size_t currentOffset)
 
void UA_DataSetMessage_clear (UA_DataSetMessage *p)
 
UA_StatusCode UA_NetworkMessage_encodeBinary (const UA_NetworkMessage *src, UA_Byte **bufPos, const UA_Byte *bufEnd, UA_Byte **dataToEncryptStart)
 
UA_StatusCode UA_NetworkMessage_encodeHeaders (const UA_NetworkMessage *src, UA_Byte **bufPos, const UA_Byte *bufEnd)
 
UA_StatusCode UA_NetworkMessage_encodePayload (const UA_NetworkMessage *src, UA_Byte **bufPos, const UA_Byte *bufEnd)
 
UA_StatusCode UA_NetworkMessage_encodeFooters (const UA_NetworkMessage *src, UA_Byte **bufPos, const UA_Byte *bufEnd)
 
UA_StatusCode UA_NetworkMessage_decodeHeaders (const UA_ByteString *src, size_t *offset, UA_NetworkMessage *dst)
 
UA_StatusCode UA_NetworkMessage_decodePayload (const UA_ByteString *src, size_t *offset, UA_NetworkMessage *dst, const UA_DataTypeArray *customTypes, UA_DataSetMetaDataType *dsm)
 
UA_StatusCode UA_NetworkMessage_decodeFooters (const UA_ByteString *src, size_t *offset, UA_NetworkMessage *dst)
 
UA_StatusCode UA_NetworkMessage_decodeBinary (const UA_ByteString *src, size_t *offset, UA_NetworkMessage *dst, const UA_DataTypeArray *customTypes)
 
UA_StatusCode UA_NetworkMessageHeader_decodeBinary (const UA_ByteString *src, size_t *offset, UA_NetworkMessage *dst)
 
size_t UA_NetworkMessage_calcSizeBinary (UA_NetworkMessage *p, UA_NetworkMessageOffsetBuffer *offsetBuffer)
 
void UA_NetworkMessage_clear (UA_NetworkMessage *p)
 

Macro Definition Documentation

◆ UA_NETWORKMESSAGE_MAX_NONCE_LENGTH

#define UA_NETWORKMESSAGE_MAX_NONCE_LENGTH   16

This Source Code Form is subject to the terms of the Mozilla Public License, v.

2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

Copyright (c) 2017 - 2018 Fraunhofer IOSB (Author: Tino Bischoff) Copyright (c) 2017-2019 Fraunhofer IOSB (Author: Andreas Ebner)

Definition at line 21 of file ua_pubsub_networkmessage.h.

Enumeration Type Documentation

◆ UA_DataSetMessageType

enum UA_DataSetMessageType

DataSetMessage Type.

Enumerator
UA_DATASETMESSAGE_DATAKEYFRAME 
UA_DATASETMESSAGE_DATADELTAFRAME 
UA_DATASETMESSAGE_EVENT 
UA_DATASETMESSAGE_KEEPALIVE 

Definition at line 38 of file ua_pubsub_networkmessage.h.

◆ UA_FieldEncoding

enum UA_FieldEncoding

FieldEncoding Enum

Enumerator
UA_FIELDENCODING_VARIANT 
UA_FIELDENCODING_RAWDATA 
UA_FIELDENCODING_DATAVALUE 
UA_FIELDENCODING_UNKNOWN 

Definition at line 30 of file ua_pubsub_networkmessage.h.

◆ UA_NetworkMessageOffsetType

enum UA_NetworkMessageOffsetType

Network Message Offsets

Offsets for buffered messages in the PubSub fast path.

Enumerator
UA_PUBSUB_OFFSETTYPE_DATASETMESSAGE_SEQUENCENUMBER 
UA_PUBSUB_OFFSETTYPE_NETWORKMESSAGE_SEQUENCENUMBER 
UA_PUBSUB_OFFSETTYPE_NETWORKMESSAGE_FIELDENCDODING 
UA_PUBSUB_OFFSETTYPE_TIMESTAMP_PICOSECONDS 
UA_PUBSUB_OFFSETTYPE_TIMESTAMP 
UA_PUBSUB_OFFSETTYPE_TIMESTAMP_NOW 
UA_PUBSUB_OFFSETTYPE_PAYLOAD_DATAVALUE 
UA_PUBSUB_OFFSETTYPE_PAYLOAD_DATAVALUE_EXTERNAL 
UA_PUBSUB_OFFSETTYPE_PAYLOAD_VARIANT 
UA_PUBSUB_OFFSETTYPE_PAYLOAD_VARIANT_EXTERNAL 
UA_PUBSUB_OFFSETTYPE_PAYLOAD_RAW 
UA_PUBSUB_OFFSETTYPE_PAYLOAD_RAW_EXTERNAL 
UA_PUBSUB_OFFSETTYPE_PUBLISHERID 
UA_PUBSUB_OFFSETTYPE_WRITERGROUPID 
UA_PUBSUB_OFFSETTYPE_DATASETWRITERID 

Definition at line 174 of file ua_pubsub_networkmessage.h.

◆ UA_NetworkMessageType

enum UA_NetworkMessageType
Enumerator
UA_NETWORKMESSAGE_DATASET 
UA_NETWORKMESSAGE_DISCOVERY_REQUEST 
UA_NETWORKMESSAGE_DISCOVERY_RESPONSE 

Definition at line 100 of file ua_pubsub_networkmessage.h.

Function Documentation

◆ UA_DataSetMessage_calcSizeBinary()

size_t UA_DataSetMessage_calcSizeBinary ( UA_DataSetMessage *  p,
UA_NetworkMessageOffsetBuffer *  offsetBuffer,
size_t  currentOffset 
)

◆ UA_DataSetMessage_clear()

void UA_DataSetMessage_clear ( UA_DataSetMessage *  p)

◆ UA_DataSetMessage_decodeBinary()

UA_StatusCode UA_DataSetMessage_decodeBinary ( const UA_ByteString *  src,
size_t *  offset,
UA_DataSetMessage *  dst,
UA_UInt16  dsmSize,
const UA_DataTypeArray *  customTypes,
UA_DataSetMetaDataType *  dsm 
)

◆ UA_DataSetMessage_encodeBinary()

UA_StatusCode UA_DataSetMessage_encodeBinary ( const UA_DataSetMessage *  src,
UA_Byte **  bufPos,
const UA_Byte *  bufEnd 
)

◆ UA_DataSetMessageHeader_decodeBinary()

UA_StatusCode UA_DataSetMessageHeader_decodeBinary ( const UA_ByteString *  src,
size_t *  offset,
UA_DataSetMessageHeader *  dst 
)

◆ UA_DataSetMessageHeader_encodeBinary()

UA_StatusCode UA_DataSetMessageHeader_encodeBinary ( const UA_DataSetMessageHeader *  src,
UA_Byte **  bufPos,
const UA_Byte *  bufEnd 
)

◆ UA_NetworkMessage_calcSizeBinary()

size_t UA_NetworkMessage_calcSizeBinary ( UA_NetworkMessage *  p,
UA_NetworkMessageOffsetBuffer *  offsetBuffer 
)

Also stores the offset if offsetBuffer != NULL.

◆ UA_NetworkMessage_clear()

void UA_NetworkMessage_clear ( UA_NetworkMessage *  p)

◆ UA_NetworkMessage_decodeBinary()

UA_StatusCode UA_NetworkMessage_decodeBinary ( const UA_ByteString *  src,
size_t *  offset,
UA_NetworkMessage *  dst,
const UA_DataTypeArray *  customTypes 
)

◆ UA_NetworkMessage_decodeFooters()

UA_StatusCode UA_NetworkMessage_decodeFooters ( const UA_ByteString *  src,
size_t *  offset,
UA_NetworkMessage *  dst 
)

◆ UA_NetworkMessage_decodeHeaders()

UA_StatusCode UA_NetworkMessage_decodeHeaders ( const UA_ByteString *  src,
size_t *  offset,
UA_NetworkMessage *  dst 
)

◆ UA_NetworkMessage_decodePayload()

UA_StatusCode UA_NetworkMessage_decodePayload ( const UA_ByteString *  src,
size_t *  offset,
UA_NetworkMessage *  dst,
const UA_DataTypeArray *  customTypes,
UA_DataSetMetaDataType *  dsm 
)

◆ UA_NetworkMessage_encodeBinary()

UA_StatusCode UA_NetworkMessage_encodeBinary ( const UA_NetworkMessage *  src,
UA_Byte **  bufPos,
const UA_Byte *  bufEnd,
UA_Byte **  dataToEncryptStart 
)

If dataToEncryptStart not-NULL, then it will be set to the start-position of the payload in the buffer.

◆ UA_NetworkMessage_encodeFooters()

UA_StatusCode UA_NetworkMessage_encodeFooters ( const UA_NetworkMessage *  src,
UA_Byte **  bufPos,
const UA_Byte *  bufEnd 
)

◆ UA_NetworkMessage_encodeHeaders()

UA_StatusCode UA_NetworkMessage_encodeHeaders ( const UA_NetworkMessage *  src,
UA_Byte **  bufPos,
const UA_Byte *  bufEnd 
)

◆ UA_NetworkMessage_encodePayload()

UA_StatusCode UA_NetworkMessage_encodePayload ( const UA_NetworkMessage *  src,
UA_Byte **  bufPos,
const UA_Byte *  bufEnd 
)

◆ UA_NetworkMessage_updateBufferedMessage()

UA_StatusCode UA_NetworkMessage_updateBufferedMessage ( UA_NetworkMessageOffsetBuffer *  buffer)

◆ UA_NetworkMessage_updateBufferedNwMessage()

UA_StatusCode UA_NetworkMessage_updateBufferedNwMessage ( UA_NetworkMessageOffsetBuffer *  buffer,
const UA_ByteString *  src,
size_t *  bufferPosition 
)

◆ UA_NetworkMessageHeader_decodeBinary()

UA_StatusCode UA_NetworkMessageHeader_decodeBinary ( const UA_ByteString *  src,
size_t *  offset,
UA_NetworkMessage *  dst 
)

◆ UA_NetworkMessageOffsetBuffer_clear()

void UA_NetworkMessageOffsetBuffer_clear ( UA_NetworkMessageOffsetBuffer *  nmob)
Generated by doxygen 1.9.8