Callback class for the PubSub module in the server SDK.
More...
#include <pubsubserverapplicationcallback.h>
Callback class for the PubSub module in the server SDK.
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. |
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. |
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 |
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 |
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