open62541 1.3.12
Open source implementation of OPC UA
Loading...
Searching...
No Matches
server_pubsub.h File Reference

Go to the source code of this file.

Data Structures

struct  UA_PubSubConnectionConfig
 
struct  UA_PubSubConfiguration
 
struct  UA_PublishedDataItemsTemplateConfig
 
struct  UA_PublishedEventConfig
 
struct  UA_PublishedEventTemplateConfig
 
struct  UA_PublishedDataSetConfig
 
struct  UA_AddPublishedDataSetResult
 
struct  UA_DataSetVariableConfig
 
struct  UA_DataSetFieldConfig
 
struct  UA_DataSetFieldResult
 
struct  UA_PubSub_CallbackLifecycle
 
struct  UA_WriterGroupConfig
 
struct  UA_DataSetWriterConfig
 
struct  UA_FieldTargetVariable
 
struct  UA_TargetVariables
 
struct  UA_PubSubSecurityParameters
 
struct  UA_DataSetReaderConfig
 
struct  UA_ReaderGroupConfig
 

Enumerations

enum  UA_PubSubComponentEnumType
 
enum  UA_PublisherIdType
 
enum  UA_PublishedDataSetType
 
enum  UA_DataSetFieldType
 
enum  UA_PubSubEncodingType
 
enum  UA_PubSubRTLevel
 
enum  UA_SubscribedDataSetEnumType
 
enum  UA_PubSubRtEncoding
 

Functions

UA_StatusCode UA_ServerConfig_addPubSubTransportLayer (UA_ServerConfig *config, UA_PubSubTransportLayer pubsubTransportLayer)
 
UA_StatusCode UA_Server_addPubSubConnection (UA_Server *server, const UA_PubSubConnectionConfig *connectionConfig, UA_NodeId *connectionIdentifier)
 
UA_StatusCode UA_Server_getPubSubConnectionConfig (UA_Server *server, const UA_NodeId connection, UA_PubSubConnectionConfig *config)
 
UA_StatusCode UA_Server_removePubSubConnection (UA_Server *server, const UA_NodeId connection)
 
void UA_PublishedDataSetConfig_clear (UA_PublishedDataSetConfig *pdsConfig)
 
UA_AddPublishedDataSetResult UA_Server_addPublishedDataSet (UA_Server *server, const UA_PublishedDataSetConfig *publishedDataSetConfig, UA_NodeId *pdsIdentifier)
 
UA_StatusCode UA_Server_getPublishedDataSetConfig (UA_Server *server, const UA_NodeId pds, UA_PublishedDataSetConfig *config)
 
UA_StatusCode UA_Server_getPublishedDataSetMetaData (UA_Server *server, const UA_NodeId pds, UA_DataSetMetaDataType *metaData)
 
UA_StatusCode UA_Server_removePublishedDataSet (UA_Server *server, const UA_NodeId pds)
 
void UA_DataSetFieldConfig_clear (UA_DataSetFieldConfig *dataSetFieldConfig)
 
UA_DataSetFieldResult UA_Server_addDataSetField (UA_Server *server, const UA_NodeId publishedDataSet, const UA_DataSetFieldConfig *fieldConfig, UA_NodeId *fieldIdentifier)
 
UA_StatusCode UA_Server_getDataSetFieldConfig (UA_Server *server, const UA_NodeId dsf, UA_DataSetFieldConfig *config)
 
UA_DataSetFieldResult UA_Server_removeDataSetField (UA_Server *server, const UA_NodeId dsf)
 
void UA_WriterGroupConfig_clear (UA_WriterGroupConfig *writerGroupConfig)
 
UA_StatusCode UA_Server_addWriterGroup (UA_Server *server, const UA_NodeId connection, const UA_WriterGroupConfig *writerGroupConfig, UA_NodeId *writerGroupIdentifier)
 
UA_StatusCode UA_Server_getWriterGroupConfig (UA_Server *server, const UA_NodeId writerGroup, UA_WriterGroupConfig *config)
 
UA_StatusCode UA_Server_updateWriterGroupConfig (UA_Server *server, UA_NodeId writerGroupIdentifier, const UA_WriterGroupConfig *config)
 
UA_StatusCode UA_Server_WriterGroup_getState (UA_Server *server, UA_NodeId writerGroupIdentifier, UA_PubSubState *state)
 
UA_StatusCode UA_Server_removeWriterGroup (UA_Server *server, const UA_NodeId writerGroup)
 
UA_StatusCode UA_Server_freezeWriterGroupConfiguration (UA_Server *server, const UA_NodeId writerGroup)
 
UA_StatusCode UA_Server_unfreezeWriterGroupConfiguration (UA_Server *server, const UA_NodeId writerGroup)
 
UA_StatusCode UA_Server_setWriterGroupOperational (UA_Server *server, const UA_NodeId writerGroup)
 
UA_StatusCode UA_Server_setWriterGroupDisabled (UA_Server *server, const UA_NodeId writerGroup)
 
void UA_DataSetWriterConfig_clear (UA_DataSetWriterConfig *pdsConfig)
 
UA_StatusCode UA_Server_addDataSetWriter (UA_Server *server, const UA_NodeId writerGroup, const UA_NodeId dataSet, const UA_DataSetWriterConfig *dataSetWriterConfig, UA_NodeId *writerIdentifier)
 
UA_StatusCode UA_Server_getDataSetWriterConfig (UA_Server *server, const UA_NodeId dsw, UA_DataSetWriterConfig *config)
 
UA_StatusCode UA_Server_DataSetWriter_getState (UA_Server *server, UA_NodeId dataSetWriterIdentifier, UA_PubSubState *state)
 
UA_StatusCode UA_Server_removeDataSetWriter (UA_Server *server, const UA_NodeId dsw)
 
UA_StatusCode UA_Server_DataSetReader_createTargetVariables (UA_Server *server, UA_NodeId dataSetReaderIdentifier, size_t targetVariablesSize, const UA_FieldTargetVariable *targetVariables)
 
UA_StatusCode UA_Server_DataSetReader_updateConfig (UA_Server *server, UA_NodeId dataSetReaderIdentifier, UA_NodeId readerGroupIdentifier, const UA_DataSetReaderConfig *config)
 
UA_StatusCode UA_Server_DataSetReader_getConfig (UA_Server *server, UA_NodeId dataSetReaderIdentifier, UA_DataSetReaderConfig *config)
 
UA_StatusCode UA_Server_DataSetReader_getState (UA_Server *server, UA_NodeId dataSetReaderIdentifier, UA_PubSubState *state)
 
void UA_ReaderGroupConfig_clear (UA_ReaderGroupConfig *readerGroupConfig)
 
UA_StatusCode UA_Server_addDataSetReader (UA_Server *server, UA_NodeId readerGroupIdentifier, const UA_DataSetReaderConfig *dataSetReaderConfig, UA_NodeId *readerIdentifier)
 
UA_StatusCode UA_Server_removeDataSetReader (UA_Server *server, UA_NodeId readerIdentifier)
 
UA_StatusCode UA_Server_ReaderGroup_getConfig (UA_Server *server, UA_NodeId readerGroupIdentifier, UA_ReaderGroupConfig *config)
 
UA_StatusCode UA_Server_ReaderGroup_getState (UA_Server *server, UA_NodeId readerGroupIdentifier, UA_PubSubState *state)
 
UA_StatusCode UA_Server_addReaderGroup (UA_Server *server, UA_NodeId connectionIdentifier, const UA_ReaderGroupConfig *readerGroupConfig, UA_NodeId *readerGroupIdentifier)
 
UA_StatusCode UA_Server_removeReaderGroup (UA_Server *server, UA_NodeId groupIdentifier)
 
UA_StatusCode UA_Server_freezeReaderGroupConfiguration (UA_Server *server, const UA_NodeId readerGroupId)
 
UA_StatusCode UA_Server_unfreezeReaderGroupConfiguration (UA_Server *server, const UA_NodeId readerGroupId)
 
UA_StatusCode UA_Server_setReaderGroupOperational (UA_Server *server, const UA_NodeId readerGroupId)
 
UA_StatusCode UA_Server_setReaderGroupDisabled (UA_Server *server, const UA_NodeId readerGroupId)
 

Enumeration Type Documentation

◆ UA_PubSubComponentEnumType

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: Andreas Ebner) Copyright (c) 2019 Kalycito Infotech Private Limited Copyright (c) 2021 Fraunhofer IOSB (Author: Jan Hermes)

Enumerator
UA_PUBSUB_COMPONENT_CONNECTION 
UA_PUBSUB_COMPONENT_WRITERGROUP 
UA_PUBSUB_COMPONENT_DATASETWRITER 
UA_PUBSUB_COMPONENT_READERGROUP 
UA_PUBSUB_COMPONENT_DATASETREADER 

Definition at line 23 of file server_pubsub.h.

◆ UA_PublisherIdType

Enumerator
UA_PUBSUB_PUBLISHERID_NUMERIC 
UA_PUBSUB_PUBLISHERID_STRING 

Definition at line 31 of file server_pubsub.h.

◆ UA_PublishedDataSetType

The UA_PUBSUB_DATASET_PUBLISHEDITEMS has currently no additional members and thus no dedicated config structure.

Enumerator
UA_PUBSUB_DATASET_PUBLISHEDITEMS 
UA_PUBSUB_DATASET_PUBLISHEDEVENTS 
UA_PUBSUB_DATASET_PUBLISHEDITEMS_TEMPLATE 
UA_PUBSUB_DATASET_PUBLISHEDEVENTS_TEMPLATE 

Definition at line 135 of file server_pubsub.h.

◆ UA_DataSetFieldType

Enumerator
UA_PUBSUB_DATASETFIELD_VARIABLE 
UA_PUBSUB_DATASETFIELD_EVENT 

Definition at line 227 of file server_pubsub.h.

◆ UA_PubSubEncodingType

Enumerator
UA_PUBSUB_ENCODING_BINARY 
UA_PUBSUB_ENCODING_JSON 
UA_PUBSUB_ENCODING_UADP 

Definition at line 284 of file server_pubsub.h.

◆ UA_PubSubRTLevel

Enumerator
UA_PUBSUB_RT_NONE 
UA_PUBSUB_RT_DIRECT_VALUE_ACCESS 
UA_PUBSUB_RT_FIXED_SIZE 
UA_PUBSUB_RT_DETERMINISTIC 

Definition at line 291 of file server_pubsub.h.

◆ UA_SubscribedDataSetEnumType

SubscribedDataSetDataType Definition.

Enumerator
UA_PUBSUB_SDS_TARGET 
UA_PUBSUB_SDS_MIRROR 

Definition at line 420 of file server_pubsub.h.

◆ UA_PubSubRtEncoding

Enumerator
UA_PUBSUB_RT_UNKNOWN 
UA_PUBSUB_RT_VARIANT 
UA_PUBSUB_RT_DATA_VALUE 
UA_PUBSUB_RT_RAW 

Definition at line 478 of file server_pubsub.h.

Function Documentation

◆ UA_ServerConfig_addPubSubTransportLayer()

UA_StatusCode UA_ServerConfig_addPubSubTransportLayer ( UA_ServerConfig * config,
UA_PubSubTransportLayer pubsubTransportLayer )

◆ UA_Server_addPubSubConnection()

UA_StatusCode UA_Server_addPubSubConnection ( UA_Server * server,
const UA_PubSubConnectionConfig * connectionConfig,
UA_NodeId * connectionIdentifier )

◆ UA_Server_getPubSubConnectionConfig()

UA_StatusCode UA_Server_getPubSubConnectionConfig ( UA_Server * server,
const UA_NodeId connection,
UA_PubSubConnectionConfig * config )

Returns a deep copy of the config.

◆ UA_Server_removePubSubConnection()

UA_StatusCode UA_Server_removePubSubConnection ( UA_Server * server,
const UA_NodeId connection )

Remove Connection, identified by the NodeId.

Deletion of Connection removes all contained WriterGroups and Writers.

◆ UA_PublishedDataSetConfig_clear()

void UA_PublishedDataSetConfig_clear ( UA_PublishedDataSetConfig * pdsConfig)

◆ UA_Server_addPublishedDataSet()

UA_AddPublishedDataSetResult UA_Server_addPublishedDataSet ( UA_Server * server,
const UA_PublishedDataSetConfig * publishedDataSetConfig,
UA_NodeId * pdsIdentifier )

◆ UA_Server_getPublishedDataSetConfig()

UA_StatusCode UA_Server_getPublishedDataSetConfig ( UA_Server * server,
const UA_NodeId pds,
UA_PublishedDataSetConfig * config )

Returns a deep copy of the config.

◆ UA_Server_getPublishedDataSetMetaData()

UA_StatusCode UA_Server_getPublishedDataSetMetaData ( UA_Server * server,
const UA_NodeId pds,
UA_DataSetMetaDataType * metaData )

Returns a deep copy of the DataSetMetaData for an specific PDS.

◆ UA_Server_removePublishedDataSet()

UA_StatusCode UA_Server_removePublishedDataSet ( UA_Server * server,
const UA_NodeId pds )

Remove PublishedDataSet, identified by the NodeId.

Deletion of PDS removes all contained and linked PDS Fields. Connected WriterGroups will be also removed.

◆ UA_DataSetFieldConfig_clear()

void UA_DataSetFieldConfig_clear ( UA_DataSetFieldConfig * dataSetFieldConfig)

◆ UA_Server_addDataSetField()

UA_DataSetFieldResult UA_Server_addDataSetField ( UA_Server * server,
const UA_NodeId publishedDataSet,
const UA_DataSetFieldConfig * fieldConfig,
UA_NodeId * fieldIdentifier )

◆ UA_Server_getDataSetFieldConfig()

UA_StatusCode UA_Server_getDataSetFieldConfig ( UA_Server * server,
const UA_NodeId dsf,
UA_DataSetFieldConfig * config )

Returns a deep copy of the config.

◆ UA_Server_removeDataSetField()

UA_DataSetFieldResult UA_Server_removeDataSetField ( UA_Server * server,
const UA_NodeId dsf )

◆ UA_WriterGroupConfig_clear()

void UA_WriterGroupConfig_clear ( UA_WriterGroupConfig * writerGroupConfig)

◆ UA_Server_addWriterGroup()

UA_StatusCode UA_Server_addWriterGroup ( UA_Server * server,
const UA_NodeId connection,
const UA_WriterGroupConfig * writerGroupConfig,
UA_NodeId * writerGroupIdentifier )

Add a new WriterGroup to an existing Connection.

◆ UA_Server_getWriterGroupConfig()

UA_StatusCode UA_Server_getWriterGroupConfig ( UA_Server * server,
const UA_NodeId writerGroup,
UA_WriterGroupConfig * config )

Returns a deep copy of the config.

◆ UA_Server_updateWriterGroupConfig()

UA_StatusCode UA_Server_updateWriterGroupConfig ( UA_Server * server,
UA_NodeId writerGroupIdentifier,
const UA_WriterGroupConfig * config )

◆ UA_Server_WriterGroup_getState()

UA_StatusCode UA_Server_WriterGroup_getState ( UA_Server * server,
UA_NodeId writerGroupIdentifier,
UA_PubSubState * state )

Get state of WriterGroup.

◆ UA_Server_removeWriterGroup()

UA_StatusCode UA_Server_removeWriterGroup ( UA_Server * server,
const UA_NodeId writerGroup )

◆ UA_Server_freezeWriterGroupConfiguration()

UA_StatusCode UA_Server_freezeWriterGroupConfiguration ( UA_Server * server,
const UA_NodeId writerGroup )

◆ UA_Server_unfreezeWriterGroupConfiguration()

UA_StatusCode UA_Server_unfreezeWriterGroupConfiguration ( UA_Server * server,
const UA_NodeId writerGroup )

◆ UA_Server_setWriterGroupOperational()

UA_StatusCode UA_Server_setWriterGroupOperational ( UA_Server * server,
const UA_NodeId writerGroup )

◆ UA_Server_setWriterGroupDisabled()

UA_StatusCode UA_Server_setWriterGroupDisabled ( UA_Server * server,
const UA_NodeId writerGroup )

◆ UA_DataSetWriterConfig_clear()

void UA_DataSetWriterConfig_clear ( UA_DataSetWriterConfig * pdsConfig)

◆ UA_Server_addDataSetWriter()

UA_StatusCode UA_Server_addDataSetWriter ( UA_Server * server,
const UA_NodeId writerGroup,
const UA_NodeId dataSet,
const UA_DataSetWriterConfig * dataSetWriterConfig,
UA_NodeId * writerIdentifier )

Add a new DataSetWriter to an existing WriterGroup.

The DataSetWriter must be coupled with a PublishedDataSet on creation.

Part 14, 7.1.5.2.1 defines: The link between the PublishedDataSet and DataSetWriter shall be created when an instance of the DataSetWriterType is created.

◆ UA_Server_getDataSetWriterConfig()

UA_StatusCode UA_Server_getDataSetWriterConfig ( UA_Server * server,
const UA_NodeId dsw,
UA_DataSetWriterConfig * config )

Returns a deep copy of the config.

◆ UA_Server_DataSetWriter_getState()

UA_StatusCode UA_Server_DataSetWriter_getState ( UA_Server * server,
UA_NodeId dataSetWriterIdentifier,
UA_PubSubState * state )

Get state of DataSetWriter.

◆ UA_Server_removeDataSetWriter()

UA_StatusCode UA_Server_removeDataSetWriter ( UA_Server * server,
const UA_NodeId dsw )

◆ UA_Server_DataSetReader_createTargetVariables()

UA_StatusCode UA_Server_DataSetReader_createTargetVariables ( UA_Server * server,
UA_NodeId dataSetReaderIdentifier,
size_t targetVariablesSize,
const UA_FieldTargetVariable * targetVariables )

Return Status Code after creating TargetVariables in Subscriber AddressSpace.

◆ UA_Server_DataSetReader_updateConfig()

UA_StatusCode UA_Server_DataSetReader_updateConfig ( UA_Server * server,
UA_NodeId dataSetReaderIdentifier,
UA_NodeId readerGroupIdentifier,
const UA_DataSetReaderConfig * config )

Update configuration to the dataSetReader.

◆ UA_Server_DataSetReader_getConfig()

UA_StatusCode UA_Server_DataSetReader_getConfig ( UA_Server * server,
UA_NodeId dataSetReaderIdentifier,
UA_DataSetReaderConfig * config )

Get configuration of the dataSetReader.

◆ UA_Server_DataSetReader_getState()

UA_StatusCode UA_Server_DataSetReader_getState ( UA_Server * server,
UA_NodeId dataSetReaderIdentifier,
UA_PubSubState * state )

Get state of DataSetReader.

◆ UA_ReaderGroupConfig_clear()

void UA_ReaderGroupConfig_clear ( UA_ReaderGroupConfig * readerGroupConfig)

◆ UA_Server_addDataSetReader()

UA_StatusCode UA_Server_addDataSetReader ( UA_Server * server,
UA_NodeId readerGroupIdentifier,
const UA_DataSetReaderConfig * dataSetReaderConfig,
UA_NodeId * readerIdentifier )

Add DataSetReader to the ReaderGroup.

◆ UA_Server_removeDataSetReader()

UA_StatusCode UA_Server_removeDataSetReader ( UA_Server * server,
UA_NodeId readerIdentifier )

Remove DataSetReader from ReaderGroup.

◆ UA_Server_ReaderGroup_getConfig()

UA_StatusCode UA_Server_ReaderGroup_getConfig ( UA_Server * server,
UA_NodeId readerGroupIdentifier,
UA_ReaderGroupConfig * config )

To Do: Update Configuration of ReaderGroup UA_StatusCode UA_Server_ReaderGroup_updateConfig(UA_Server *server, UA_NodeId readerGroupIdentifier, const UA_ReaderGroupConfig *config);.

Get configuraiton of ReaderGroup

◆ UA_Server_ReaderGroup_getState()

UA_StatusCode UA_Server_ReaderGroup_getState ( UA_Server * server,
UA_NodeId readerGroupIdentifier,
UA_PubSubState * state )

Get state of ReaderGroup.

◆ UA_Server_addReaderGroup()

UA_StatusCode UA_Server_addReaderGroup ( UA_Server * server,
UA_NodeId connectionIdentifier,
const UA_ReaderGroupConfig * readerGroupConfig,
UA_NodeId * readerGroupIdentifier )

Add ReaderGroup to the created connection.

◆ UA_Server_removeReaderGroup()

UA_StatusCode UA_Server_removeReaderGroup ( UA_Server * server,
UA_NodeId groupIdentifier )

Remove ReaderGroup from connection.

◆ UA_Server_freezeReaderGroupConfiguration()

UA_StatusCode UA_Server_freezeReaderGroupConfiguration ( UA_Server * server,
const UA_NodeId readerGroupId )

◆ UA_Server_unfreezeReaderGroupConfiguration()

UA_StatusCode UA_Server_unfreezeReaderGroupConfiguration ( UA_Server * server,
const UA_NodeId readerGroupId )

◆ UA_Server_setReaderGroupOperational()

UA_StatusCode UA_Server_setReaderGroupOperational ( UA_Server * server,
const UA_NodeId readerGroupId )

◆ UA_Server_setReaderGroupDisabled()

UA_StatusCode UA_Server_setReaderGroupDisabled ( UA_Server * server,
const UA_NodeId readerGroupId )