PubSubBase::DataSetReaderCallback Class Reference

Callback class for the DataSetReader. More...

#include <datasetreadercallback.h>

Inherited by PubSubServer::DataSetDispatcher.

Public Member Functions
virtual OpcUa_StatusCode	startUpReader (PubSubBase::DataSetReader *pDataSetReader)=0
	Callback informing the application about the start up of the PubSub module in the server SDK. More...
virtual void	stateChange (DataSetReader *pDataSetReader, OpcUa_PubSubState newState)
	Callback informing the application about a state change of the DataSetReader. More...
virtual OpcUa_StatusCode	shutDownReader (PubSubBase::DataSetReader *pDataSetReader)=0
	Callback informing the application about the shut down of the PubSub module in the server SDK. More...
virtual OpcUa_StatusCode	newMessageReceived (PubSubBase::DataSetReader *pDataSetReader, struct ua_decoder_context *pDec, OpcUa_Byte dataSetMessageType, OpcUa_UInt16 status, ua_datetime timestamp)=0
	Callback informing about a new message received for a DataSetReader. More...
virtual void	newDataInQueue (PubSubBase::DataSetReader *pDataSetReader, OpcUa_UInt16 status, ua_datetime timestamp)
	Callback informing about new data in the queue. More...

Detailed Description

Callback class for the DataSetReader.

Member Function Documentation

void PubSubBase::DataSetReaderCallback::newDataInQueue ( PubSubBase::DataSetReader *  pDataSetReader, OpcUa_UInt16  status, ua_datetime  timestamp  )

virtual

Callback informing about new data in the queue.

This callback is used if the application takes the values from a value queue filled by the PubSubstack when a received message is decoded by the PubSub stack

The method should not block

Parameters

[in]	pDataSetReader	The affected DataSetReader
[in]	status	The overall status of the DataSetMessage
[in]	timestamp	The timestamp of the DataSetMessage.

Reimplemented in PubSubServer::DataSetDispatcher.

virtual OpcUa_StatusCode PubSubBase::DataSetReaderCallback::newMessageReceived ( PubSubBase::DataSetReader *  pDataSetReader, struct ua_decoder_context *  pDec, OpcUa_Byte  dataSetMessageType, OpcUa_UInt16  status, ua_datetime  timestamp  )

pure virtual

Callback informing about a new message received for a DataSetReader.

This callback ist used if the application decodes the received message.

The method should not block

Parameters

[in]	pDataSetReader	The affected DataSetReader
[in]	pDec	The decoder object used to read the DataSetMessage fields.
[in]	dataSetMessageType	Bit mask indicating the type of the written DataSetMessage. The bit range 0-3 indicates the DataSetMessage type listed in the following table Bit Values Description 0000 Data Key Frame 0001 Data Delta Frame 0010 Event 0011 Keep Alive
[in]	status	The overall status of the DataSetMessage
[in]	timestamp	The timestamp of the DataSetMessage

Implemented in PubSubServer::DataSetDispatcher.

virtual OpcUa_StatusCode PubSubBase::DataSetReaderCallback::shutDownReader ( PubSubBase::DataSetReader *  pDataSetReader )

pure virtual

Callback informing the application about the shut down of the PubSub module in the server SDK.

The application is not allowed to call any methods on the PubSubModule if this method call is returned.

Parameters

[in]

pDataSetReader

The affected DataSetReader

Implemented in PubSubServer::DataSetDispatcher.

virtual OpcUa_StatusCode PubSubBase::DataSetReaderCallback::startUpReader ( PubSubBase::DataSetReader *  pDataSetReader )

pure virtual

Callback informing the application about the start up of the PubSub module in the server SDK.

Parameters

[in]

pDataSetReader

The affected DataSetReader

Implemented in PubSubServer::DataSetDispatcher.

void PubSubBase::DataSetReaderCallback::stateChange ( DataSetReader *  pDataSetReader, OpcUa_PubSubState  newState  )

virtual

Callback informing the application about a state change of the DataSetReader.

Parameters

[in]	pDataSetReader	The affected DataSetReader
[in]	newState	The new state of the affected DataSetReader

---

The documentation for this class was generated from the following files:

• D:/work/uasdkcpp/src/uabase/pubsubbasecpp/datasetreadercallback.h
• D:/work/uasdkcpp/src/uabase/pubsubbasecpp/datasetreader.cpp