C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
PubSubBase::PubSubControlCallback Class Referenceabstract

Class PubSubControlCallback. More...

#include <pubsubcontrolcallback.h>

Inherited by PubSubManagerPrivate.

Public Member Functions

virtual void newConnection (PubSubConnection *pConnection)=0
 Callback to inform other modules about creation of new PubSubConnection. More...
 
virtual void newWriterGroup (WriterGroup *pGroup, bool &timingHandledByApplication)=0
 Callback to inform other modules about creation of new WriterGroup. More...
 
virtual void newDataSetWriter (DataSetWriter *pDataSetWriter, bool &messageEncodedByApplication)=0
 Callback to inform other modules about creation of new DataSetWriter The application can handle the encoding of the DataSetMessage by setting the messageEncodedByApplication to true. More...
 
virtual void newReaderGroup (PubSubBase::ReaderGroup *pReaderGroup)
 Callback to inform application about creation of new reader group. More...
 
virtual void newDataSetReader (DataSetReader *pReader, bool &messageDecodedByApplication)=0
 Callback to inform other modules about creation of new DataSetReader The application can handle the decoding of the DataSetMessage by setting the messageHandledByApplication to true. More...
 
virtual void pubSubObjectStateChange (PubSubObject *pPubSubObject, 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 (PubSubObject *pPubSubObject, PubSubObject::PubSubObjectType pubSubObjectType)=0
 Callback to inform application about the deletion of a PubSub object. More...
 

Detailed Description

Member Function Documentation

virtual void PubSubBase::PubSubControlCallback::newConnection ( PubSubConnection pConnection)
pure virtual

Callback to inform other modules about creation of new PubSubConnection.

Parameters
[in]pConnectionThe connection management object.
virtual void PubSubBase::PubSubControlCallback::newDataSetReader ( DataSetReader pReader,
bool &  messageDecodedByApplication 
)
pure virtual

Callback to inform other modules about creation of new DataSetReader The application can handle the decoding of the DataSetMessage by setting the messageHandledByApplication to true.

Parameters
[in]pReaderThe DataSetReader management object.
[out]messageDecodedByApplicationFlag used to indicate that the application is responsible for decoding the fields of the DataSetMessage (true) or decoding should be done by the PubSub stack (false). In the case of true, the encoding is started with a callback to the application.
virtual void PubSubBase::PubSubControlCallback::newDataSetWriter ( DataSetWriter pDataSetWriter,
bool &  messageEncodedByApplication 
)
pure virtual

Callback to inform other modules about creation of new DataSetWriter The application can handle the encoding of the DataSetMessage by setting the messageEncodedByApplication to true.

Parameters
[in]pDataSetWriterThe DataSetWriter management object.
[out]messageEncodedByApplicationFlag used to indicate that the application is responsible for encoding the fields of the DataSetMessage (true) or encoding should be done by the PubSub stack (false). In the case of true, the encoding is started with a callback to the application.
void PubSubBase::PubSubControlCallback::newReaderGroup ( PubSubBase::ReaderGroup pReaderGroup)
virtual

Callback to inform application about creation of new reader group.

Parameters
[in]pReaderGroupThe reader group management object.
virtual void PubSubBase::PubSubControlCallback::newWriterGroup ( WriterGroup pGroup,
bool &  timingHandledByApplication 
)
pure virtual

Callback to inform other modules about creation of new WriterGroup.

Parameters
[in]pGroupThe writer group management object.
[out]timingHandledByApplicationFlag used to indicate that the application is responsible for handling of cyclic sampling and publishing.
void PubSubBase::PubSubControlCallback::pubSubObjectConfigChange ( PubSubBase::PubSubObject pPubSubObject,
PubSubBase::PubSubObject::PubSubObjectType  pubSubObjectType 
)
virtual

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

Parameters
[in]pPubSubObjectThe affected PubSub object
[in]pubSubObjectTypeThe type of the affected PubSub object
virtual void PubSubBase::PubSubControlCallback::pubSubObjectRemoved ( PubSubObject pPubSubObject,
PubSubObject::PubSubObjectType  pubSubObjectType 
)
pure virtual

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

Parameters
[in]pPubSubObjectThe affected PubSub object
[in]pubSubObjectTypeThe type of the affected PubSub object
void PubSubBase::PubSubControlCallback::pubSubObjectStateChange ( PubSubObject pPubSubObject,
PubSubObject::PubSubObjectType  pubSubObjectType,
OpcUa_PubSubState  newState 
)
virtual

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

Parameters
[in]pPubSubObjectThe affected PubSub object
[in]pubSubObjectTypeThe type of the affected PubSub object
[in]newStateThe new state of the affected PubSub object

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