ua_pubsub.h File Reference

#include <open62541/plugin/pubsub.h>
#include <open62541/server.h>
#include <open62541/server_pubsub.h>
#include "open62541_queue.h"
#include "ua_pubsub_networkmessage.h"

Go to the source code of this file.

Data Structures
struct	UA_PublishedDataSet
struct	UA_PubSubConnection
struct	UA_DataSetWriter
struct	UA_WriterGroup
struct	UA_DataSetField
struct	UA_DataSetReader
struct	UA_ReaderGroup

Typedefs
typedef struct UA_WriterGroup	UA_WriterGroup
typedef struct UA_ReaderGroup	UA_ReaderGroup
typedef struct UA_PublishedDataSet	UA_PublishedDataSet
typedef struct UA_PubSubConnection	UA_PubSubConnection
typedef struct UA_DataSetWriter	UA_DataSetWriter
typedef struct UA_DataSetField	UA_DataSetField
typedef struct UA_DataSetReader	UA_DataSetReader

Functions
UA_StatusCode	UA_PublishedDataSetConfig_copy (const UA_PublishedDataSetConfig *src, UA_PublishedDataSetConfig *dst)
UA_PublishedDataSet *	UA_PublishedDataSet_findPDSbyId (UA_Server *server, UA_NodeId identifier)
void	UA_PublishedDataSet_clear (UA_Server *server, UA_PublishedDataSet *publishedDataSet)
UA_StatusCode	UA_PubSubConnectionConfig_copy (const UA_PubSubConnectionConfig *src, UA_PubSubConnectionConfig *dst)
UA_PubSubConnection *	UA_PubSubConnection_findConnectionbyId (UA_Server *server, UA_NodeId connectionIdentifier)
void	UA_PubSubConnectionConfig_clear (UA_PubSubConnectionConfig *connectionConfig)
void	UA_PubSubConnection_clear (UA_Server *server, UA_PubSubConnection *connection)
UA_StatusCode	UA_PubSubConnection_regist (UA_Server *server, UA_NodeId *connectionIdentifier)
UA_StatusCode	UA_Server_processNetworkMessage (UA_Server *server, UA_PubSubConnection *connection, UA_NetworkMessage *msg)
UA_StatusCode	UA_DataSetWriterConfig_copy (const UA_DataSetWriterConfig *src, UA_DataSetWriterConfig *dst)
UA_DataSetWriter *	UA_DataSetWriter_findDSWbyId (UA_Server *server, UA_NodeId identifier)
UA_StatusCode	UA_DataSetWriter_setPubSubState (UA_Server *server, UA_PubSubState state, UA_DataSetWriter *dataSetWriter)
UA_StatusCode	UA_DataSetWriter_generateDataSetMessage (UA_Server *server, UA_DataSetMessage *dataSetMessage, UA_DataSetWriter *dataSetWriter)
UA_StatusCode	UA_DataSetWriter_remove (UA_Server *server, UA_WriterGroup *linkedWriterGroup, UA_DataSetWriter *dataSetWriter)
UA_StatusCode	UA_WriterGroupConfig_copy (const UA_WriterGroupConfig *src, UA_WriterGroupConfig *dst)
UA_WriterGroup *	UA_WriterGroup_findWGbyId (UA_Server *server, UA_NodeId identifier)
UA_StatusCode	UA_WriterGroup_setPubSubState (UA_Server *server, UA_PubSubState state, UA_WriterGroup *writerGroup)
UA_StatusCode	UA_DataSetFieldConfig_copy (const UA_DataSetFieldConfig *src, UA_DataSetFieldConfig *dst)
UA_DataSetField *	UA_DataSetField_findDSFbyId (UA_Server *server, UA_NodeId identifier)
void	UA_DataSetReader_process (UA_Server *server, UA_ReaderGroup *readerGroup, UA_DataSetReader *dataSetReader, UA_DataSetMessage *dataSetMsg)
UA_StatusCode	UA_DataSetReaderConfig_copy (const UA_DataSetReaderConfig *src, UA_DataSetReaderConfig *dst)
void	UA_DataSetReaderConfig_clear (UA_DataSetReaderConfig *cfg)
UA_StatusCode	UA_TargetVariables_copy (const UA_TargetVariables *src, UA_TargetVariables *dst)
void	UA_TargetVariables_clear (UA_TargetVariables *subscribedDataSetTarget)
UA_StatusCode	UA_FieldTargetVariable_copy (const UA_FieldTargetVariable *src, UA_FieldTargetVariable *dst)
UA_StatusCode	UA_DataSetReader_setPubSubState (UA_Server *server, UA_PubSubState state, UA_DataSetReader *dataSetReader)
UA_StatusCode	UA_DataSetReader_generateNetworkMessage (UA_PubSubConnection *pubSubConnection, UA_DataSetReader *dataSetReader, UA_DataSetMessage *dsm, UA_UInt16 *writerId, UA_Byte dsmCount, UA_NetworkMessage *nm)
UA_StatusCode	UA_DataSetReader_generateDataSetMessage (UA_Server *server, UA_DataSetMessage *dataSetMessage, UA_DataSetReader *dataSetReader)
UA_StatusCode	UA_ReaderGroupConfig_copy (const UA_ReaderGroupConfig *src, UA_ReaderGroupConfig *dst)
UA_ReaderGroup *	UA_ReaderGroup_findRGbyId (UA_Server *server, UA_NodeId identifier)
UA_DataSetReader *	UA_ReaderGroup_findDSRbyId (UA_Server *server, UA_NodeId identifier)
UA_StatusCode	UA_ReaderGroup_setPubSubState (UA_Server *server, UA_PubSubState state, UA_ReaderGroup *readerGroup)
UA_StatusCode	UA_WriterGroup_addPublishCallback (UA_Server *server, UA_WriterGroup *writerGroup)
void	UA_WriterGroup_publishCallback (UA_Server *server, UA_WriterGroup *writerGroup)
UA_StatusCode	UA_ReaderGroup_addSubscribeCallback (UA_Server *server, UA_ReaderGroup *readerGroup)
void	UA_ReaderGroup_removeSubscribeCallback (UA_Server *server, UA_ReaderGroup *readerGroup)
void	UA_ReaderGroup_subscribeCallback (UA_Server *server, UA_ReaderGroup *readerGroup)
UA_StatusCode	decodeNetworkMessage (UA_Server *server, UA_ByteString *buffer, size_t *pos, UA_NetworkMessage *nm, UA_PubSubConnection *connection)
UA_StatusCode	receiveBufferedNetworkMessage (UA_Server *server, UA_ReaderGroup *readerGroup, UA_PubSubConnection *connection)

Typedef Documentation

UA_WriterGroup

typedef struct UA_WriterGroup UA_WriterGroup

Definition at line 29 of file ua_pubsub.h.

UA_ReaderGroup

typedef struct UA_ReaderGroup UA_ReaderGroup

Definition at line 32 of file ua_pubsub.h.

UA_PublishedDataSet

typedef struct UA_PublishedDataSet UA_PublishedDataSet

PublishedDataSet

UA_PubSubConnection

typedef struct UA_PubSubConnection UA_PubSubConnection

Connection

UA_DataSetWriter

typedef struct UA_DataSetWriter UA_DataSetWriter

DataSetWriter

UA_DataSetField

typedef struct UA_DataSetField UA_DataSetField

DataSetField

UA_DataSetReader

typedef struct UA_DataSetReader UA_DataSetReader

DataSetReader

DataSetReader Type definition

Function Documentation

UA_PublishedDataSetConfig_copy()

UA_StatusCode UA_PublishedDataSetConfig_copy	(	const UA_PublishedDataSetConfig *	src,
		UA_PublishedDataSetConfig *	dst
	)

UA_PublishedDataSet_findPDSbyId()

UA_PublishedDataSet * UA_PublishedDataSet_findPDSbyId	(	UA_Server *	server,
		UA_NodeId	identifier
	)

UA_PublishedDataSet_clear()

void UA_PublishedDataSet_clear	(	UA_Server *	server,
		UA_PublishedDataSet *	publishedDataSet
	)

UA_PubSubConnectionConfig_copy()

UA_StatusCode UA_PubSubConnectionConfig_copy	(	const UA_PubSubConnectionConfig *	src,
		UA_PubSubConnectionConfig *	dst
	)

UA_PubSubConnection_findConnectionbyId()

UA_PubSubConnection * UA_PubSubConnection_findConnectionbyId	(	UA_Server *	server,
		UA_NodeId	connectionIdentifier
	)

UA_PubSubConnectionConfig_clear()

void UA_PubSubConnectionConfig_clear

(

UA_PubSubConnectionConfig *

connectionConfig

)

UA_PubSubConnection_clear()

void UA_PubSubConnection_clear	(	UA_Server *	server,
		UA_PubSubConnection *	connection
	)

UA_PubSubConnection_regist()

UA_StatusCode UA_PubSubConnection_regist	(	UA_Server *	server,
		UA_NodeId *	connectionIdentifier
	)

Register channel for given connectionIdentifier.

UA_Server_processNetworkMessage()

UA_StatusCode UA_Server_processNetworkMessage	(	UA_Server *	server,
		UA_PubSubConnection *	connection,
		UA_NetworkMessage *	msg
	)

Process Network Message for a ReaderGroup.

But we the ReaderGroup needs to be identified first.

UA_DataSetWriterConfig_copy()

UA_StatusCode UA_DataSetWriterConfig_copy	(	const UA_DataSetWriterConfig *	src,
		UA_DataSetWriterConfig *	dst
	)

UA_DataSetWriter_findDSWbyId()

UA_DataSetWriter * UA_DataSetWriter_findDSWbyId	(	UA_Server *	server,
		UA_NodeId	identifier
	)

UA_DataSetWriter_setPubSubState()

UA_StatusCode UA_DataSetWriter_setPubSubState	(	UA_Server *	server,
		UA_PubSubState	state,
		UA_DataSetWriter *	dataSetWriter
	)

UA_DataSetWriter_generateDataSetMessage()

UA_StatusCode UA_DataSetWriter_generateDataSetMessage	(	UA_Server *	server,
		UA_DataSetMessage *	dataSetMessage,
		UA_DataSetWriter *	dataSetWriter
	)

UA_DataSetWriter_remove()

UA_StatusCode UA_DataSetWriter_remove	(	UA_Server *	server,
		UA_WriterGroup *	linkedWriterGroup,
		UA_DataSetWriter *	dataSetWriter
	)

UA_WriterGroupConfig_copy()

UA_StatusCode UA_WriterGroupConfig_copy	(	const UA_WriterGroupConfig *	src,
		UA_WriterGroupConfig *	dst
	)

UA_WriterGroup_findWGbyId()

UA_WriterGroup * UA_WriterGroup_findWGbyId	(	UA_Server *	server,
		UA_NodeId	identifier
	)

UA_WriterGroup_setPubSubState()

UA_StatusCode UA_WriterGroup_setPubSubState	(	UA_Server *	server,
		UA_PubSubState	state,
		UA_WriterGroup *	writerGroup
	)

UA_DataSetFieldConfig_copy()

UA_StatusCode UA_DataSetFieldConfig_copy	(	const UA_DataSetFieldConfig *	src,
		UA_DataSetFieldConfig *	dst
	)

UA_DataSetField_findDSFbyId()

UA_DataSetField * UA_DataSetField_findDSFbyId	(	UA_Server *	server,
		UA_NodeId	identifier
	)

UA_DataSetReader_process()

void UA_DataSetReader_process	(	UA_Server *	server,
		UA_ReaderGroup *	readerGroup,
		UA_DataSetReader *	dataSetReader,
		UA_DataSetMessage *	dataSetMsg
	)

Process Network Message using DataSetReader.

UA_DataSetReaderConfig_copy()

UA_StatusCode UA_DataSetReaderConfig_copy	(	const UA_DataSetReaderConfig *	src,
		UA_DataSetReaderConfig *	dst
	)

Copy the configuration of DataSetReader.

UA_DataSetReaderConfig_clear()

void UA_DataSetReaderConfig_clear

(

UA_DataSetReaderConfig *

cfg

)

Clear the configuration of a DataSetReader.

UA_TargetVariables_copy()

UA_StatusCode UA_TargetVariables_copy	(	const UA_TargetVariables *	src,
		UA_TargetVariables *	dst
	)

Copy the configuration of Target Variables.

UA_TargetVariables_clear()

void UA_TargetVariables_clear

(

UA_TargetVariables *

subscribedDataSetTarget

)

Clear the Target Variables configuration.

UA_FieldTargetVariable_copy()

UA_StatusCode UA_FieldTargetVariable_copy	(	const UA_FieldTargetVariable *	src,
		UA_FieldTargetVariable *	dst
	)

Copy the configuration of Field Target Variables.

UA_DataSetReader_setPubSubState()

UA_StatusCode UA_DataSetReader_setPubSubState	(	UA_Server *	server,
		UA_PubSubState	state,
		UA_DataSetReader *	dataSetReader
	)

UA_DataSetReader_generateNetworkMessage()

UA_StatusCode UA_DataSetReader_generateNetworkMessage	(	UA_PubSubConnection *	pubSubConnection,
		UA_DataSetReader *	dataSetReader,
		UA_DataSetMessage *	dsm,
		UA_UInt16 *	writerId,
		UA_Byte	dsmCount,
		UA_NetworkMessage *	nm
	)

UA_DataSetReader_generateDataSetMessage()

UA_StatusCode UA_DataSetReader_generateDataSetMessage	(	UA_Server *	server,
		UA_DataSetMessage *	dataSetMessage,
		UA_DataSetReader *	dataSetReader
	)

UA_ReaderGroupConfig_copy()

UA_StatusCode UA_ReaderGroupConfig_copy	(	const UA_ReaderGroupConfig *	src,
		UA_ReaderGroupConfig *	dst
	)

UA_ReaderGroup_findRGbyId()

UA_ReaderGroup * UA_ReaderGroup_findRGbyId	(	UA_Server *	server,
		UA_NodeId	identifier
	)

Prototypes for internal util functions - some functions maybe removed later (currently moved from public to internal)

UA_ReaderGroup_findDSRbyId()

UA_DataSetReader * UA_ReaderGroup_findDSRbyId	(	UA_Server *	server,
		UA_NodeId	identifier
	)

UA_ReaderGroup_setPubSubState()

UA_StatusCode UA_ReaderGroup_setPubSubState	(	UA_Server *	server,
		UA_PubSubState	state,
		UA_ReaderGroup *	readerGroup
	)

UA_WriterGroup_addPublishCallback()

UA_StatusCode UA_WriterGroup_addPublishCallback	(	UA_Server *	server,
		UA_WriterGroup *	writerGroup
	)

PublishValues handling

UA_WriterGroup_publishCallback()

void UA_WriterGroup_publishCallback	(	UA_Server *	server,
		UA_WriterGroup *	writerGroup
	)

UA_ReaderGroup_addSubscribeCallback()

UA_StatusCode UA_ReaderGroup_addSubscribeCallback	(	UA_Server *	server,
		UA_ReaderGroup *	readerGroup
	)

SubscribeValues handling

UA_ReaderGroup_removeSubscribeCallback()

void UA_ReaderGroup_removeSubscribeCallback	(	UA_Server *	server,
		UA_ReaderGroup *	readerGroup
	)

UA_ReaderGroup_subscribeCallback()

void UA_ReaderGroup_subscribeCallback	(	UA_Server *	server,
		UA_ReaderGroup *	readerGroup
	)

decodeNetworkMessage()

UA_StatusCode decodeNetworkMessage	(	UA_Server *	server,
		UA_ByteString *	buffer,
		size_t *	pos,
		UA_NetworkMessage *	nm,
		UA_PubSubConnection *	connection
	)

Reading Message handling

Takes a value (and not a pointer) to the buffer. The original buffer is const. Internally we may adjust the length during decryption.

receiveBufferedNetworkMessage()

UA_StatusCode receiveBufferedNetworkMessage	(	UA_Server *	server,
		UA_ReaderGroup *	readerGroup,
		UA_PubSubConnection *	connection
	)