Callback class for the PubSub data collector. More...

#include <pubsubserverapplicationcallback.h>

Public Member Functions
virtual bool	handleDataSetDispatcher (PubSubBase::DataSetReader pDataSetReader, PubSubReceiveQueueAccess pReceiveQueueAccess, const UaWriteValues &nodesToWrite, OpcUa_Handle &dispatcherHandle)=0
	Callback informing the application about the start of the dispatcher. More...

virtual void	newDataInQueue (PubSubBase::DataSetReader *pDataSetReader, OpcUa_Handle dispatcherHandle)=0
	Callback informing the application that a new DataSetMessage was received. More...

virtual void	receiveTimeout (PubSubBase::DataSetReader *pDataSetReader, OpcUa_Handle dispatcherHandle)=0
	Callback informing the application that the receive timeout was reached. More...

virtual void	stopDataSetDispatcher (PubSubBase::DataSetReader *pDataSetReader, OpcUa_Handle dispatcherHandle)=0
	Callback informing the application that the dispatcher is stopped. More...

Detailed Description

Callback class for the PubSub data collector.

Member Function Documentation

virtual bool PubSubDataSetDispatcherCallback::handleDataSetDispatcher	(	PubSubBase::DataSetReader *	pDataSetReader,
		PubSubReceiveQueueAccess *	pReceiveQueueAccess,
		const UaWriteValues &	nodesToWrite,
		OpcUa_Handle &	dispatcherHandle
	)

pure virtual

Callback informing the application about the start of the dispatcher.

Returns true if the received data for this dispatcher is processed by the application. In this case the newDataInQueue callback is called each time a DataSetMessage was received.

Returns false if the dispatcher is not handled by the application

Parameters

[in]	pDataSetReader	The affected DataSetReader
[in]	pReceiveQueueAccess	The interface to access the dispatcher receive queue.
[in]	nodesToWrite	The node settings for the nodes to write. The index is used in PubSubReceiveQueueAccess::getValueFromQueue
[out]	dispatcherHandle	Handle assigned by the dispatcher handler for the dispatcher / DataSetReader

virtual void PubSubDataSetDispatcherCallback::newDataInQueue	(	PubSubBase::DataSetReader *	pDataSetReader,
		OpcUa_Handle	dispatcherHandle
	)

pure virtual

Callback informing the application that a new DataSetMessage was received.

After this callback the new data can be accessed with PubSubReceiveQueueAccess::getValueFromQueue().

The callback should not block. Blocking this call blocks the network handler.

Parameters

[in]	pDataSetReader	The affected DataSetReader
[in]	dispatcherHandle	Handle assigned by the dispatcher handler for the dispatcher / DataSetReader

virtual void PubSubDataSetDispatcherCallback::receiveTimeout	(	PubSubBase::DataSetReader *	pDataSetReader,
		OpcUa_Handle	dispatcherHandle
	)

pure virtual

Callback informing the application that the receive timeout was reached.

Parameters

[in]	pDataSetReader	The affected DataSetReader
[in]	dispatcherHandle	Handle assigned by the dispatcher handler for the dispatcher / DataSetReader

virtual void PubSubDataSetDispatcherCallback::stopDataSetDispatcher	(	PubSubBase::DataSetReader *	pDataSetReader,
		OpcUa_Handle	dispatcherHandle
	)

pure virtual

Callback informing the application that the dispatcher is stopped.

Parameters

[in]	pDataSetReader	The affected DataSetReader
[in]	dispatcherHandle	Handle assigned by the dispatcher handler for the dispatcher / DataSetReader

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

C:/work/uasdkcpp/src/uaserver/uaservercpp/pubsubmodule/pubsubserverapplicationcallback.h

Public Member Functions

Detailed Description

Member Function Documentation