Callback class for the PubSub module in the server SDK. More...

#include <pubsubserverapplicationcallback.h>

Public Member Functions
virtual void	startUpPubSub ()=0
	Callback informing the application about the start up of the PubSub module in the server SDK.

virtual void	beforeShutDownPubSub ()
	Optional callback informing the application about the start of the shut down of the PubSub module in the server SDK.

virtual void	shutDownPubSub ()=0
	Callback informing the application about the shut down of the PubSub module in the server SDK. More...

virtual void	newConnection (PubSubBase::PubSubConnection *pConnection)=0
	Callback to inform application about creation of new PubSubConnection. More...

virtual void	newWriterGroup (PubSubBase::WriterGroup *pWriterGroup, bool &groupHandledByApplication)=0
	Callback to inform application about creation of new writer group. More...

virtual void	newDataSetWriter (PubSubBase::DataSetWriter *pDataSetWriter, bool &messageEncodedByApplication)=0
	Callback to inform application about creation of new DataSetWriter. More...

virtual void	newReaderGroup (PubSubBase::ReaderGroup *pReaderGroup)
	Callback to inform application about creation of new reader group. More...

virtual void	newDataSetReader (PubSubBase::DataSetReader *pDataSetReader, bool &messageDecodedByApplication)=0
	Callback to inform application about creation of new DataSetReader. More...

virtual void	pubSubObjectStateChange (PubSubBase::PubSubObject *pPubSubObject, PubSubBase::PubSubObject::PubSubObjectType pubSubObjectType, OpcUa_PubSubState newState)
	Callback to inform application about a state change of a PubSub object. More...

virtual void	pubSubObjectConfigChange (PubSubBase::PubSubObject *pPubSubObject, PubSubBase::PubSubObject::PubSubObjectType pubSubObjectType)
	Callback to inform application about a configuration change of a PubSub object. More...

virtual void	pubSubObjectRemoved (PubSubBase::PubSubObject *pPubSubObject, PubSubBase::PubSubObject::PubSubObjectType pubSubObjectType)=0
	Callback to inform application about the deletion of a PubSub object. More...

Detailed Description

Callback class for the PubSub module in the server SDK.

Member Function Documentation

virtual void PubSubServerApplicationCallback::newConnection ( PubSubBase::PubSubConnection * pConnection )

pure virtual

Callback to inform application about creation of new PubSubConnection.

The application can provide an own network backend by setting the PubSubNetworkBackendInterface on the PubSubConnection object.

Parameters

[in] pConnection The connection management object.

virtual void PubSubServerApplicationCallback::newDataSetReader	(	PubSubBase::DataSetReader *	pDataSetReader,
		bool &	messageDecodedByApplication
	)

pure virtual

Callback to inform application about creation of new DataSetReader.

The application can handle the processing of the DataSetMessage decoding by setting the messageHandledByApplication to true. In this case the application must set the DataSetReaderCallback to receive the message encoding callbacks.

Parameters

[in]	pDataSetReader	The DataSetReader management object.
[out]	messageDecodedByApplication	Flag used to indicate that the application is responsible for decoding the the fields of the DataSetMessage (true) or decoding should be done by SDK (false). In the case of true, the decoding is started with newMessageReceived.

virtual void PubSubServerApplicationCallback::newDataSetWriter	(	PubSubBase::DataSetWriter *	pDataSetWriter,
		bool &	messageEncodedByApplication
	)

pure virtual

Callback to inform application about creation of new DataSetWriter.

The application can handle the processing of the DataSetMessage encoding by setting the messageHandledByApplication to true. In this case the application must set the DataSetWriterCallback to receive the message encoding callbacks.

Parameters

[in]	pDataSetWriter	The DataSetWriter management object.
[out]	messageEncodedByApplication	Flag used to indicate that the application is responsible for encoding the the fields of the DataSetMessage (true) or encoding should be done by SDK (false). In the case of true, the encoding is started with writeDataSetMessageFields.

void PubSubServerApplicationCallback::newReaderGroup ( PubSubBase::ReaderGroup * pReaderGroup )

virtual

Callback to inform application about creation of new reader group.

Parameters

[in] pReaderGroup The reader group management object.

virtual void PubSubServerApplicationCallback::newWriterGroup	(	PubSubBase::WriterGroup *	pWriterGroup,
		bool &	groupHandledByApplication
	)

pure virtual

Callback to inform application about creation of new writer group.

The application can handle the processing of the group by setting the groupHandledByApplication to true.

Parameters

[in]	pWriterGroup	The writer group management object.
[out]	groupHandledByApplication	Flag used to indicate that the application is responsible for group processing (true) or handling should be done by SDK (false). The PubSubWriterGroup provides methods for sampling (creating the NetworkMessage) and publishing that can be called by the application for the timing.

void PubSubServerApplicationCallback::pubSubObjectConfigChange	(	PubSubBase::PubSubObject *	pPubSubObject,
		PubSubBase::PubSubObject::PubSubObjectType	pubSubObjectType
	)

virtual

Callback to inform application about a configuration change of a PubSub object.

Parameters

[in]	pPubSubObject	The affected PubSub object
[in]	pubSubObjectType	The type of the affected PubSub object

virtual void PubSubServerApplicationCallback::pubSubObjectRemoved	(	PubSubBase::PubSubObject *	pPubSubObject,
		PubSubBase::PubSubObject::PubSubObjectType	pubSubObjectType
	)

pure virtual

Callback to inform application about the deletion of a PubSub object.

Parameters

[in]	pPubSubObject	The affected PubSub object
[in]	pubSubObjectType	The type of the affected PubSub object

void PubSubServerApplicationCallback::pubSubObjectStateChange	(	PubSubBase::PubSubObject *	pPubSubObject,
		PubSubBase::PubSubObject::PubSubObjectType	pubSubObjectType,
		OpcUa_PubSubState	newState
	)

virtual

Callback to inform application about a state change of a PubSub object.

Parameters

[in]	pPubSubObject	The affected PubSub object
[in]	pubSubObjectType	The type of the affected PubSub object
[in]	newState	The new state of the affected PubSub object

virtual void PubSubServerApplicationCallback::shutDownPubSub ( )

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.

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

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

Public Member Functions

Detailed Description

Member Function Documentation