Callback class for the DataSetWriter. More...

#include <datasetwritercallback.h>

Public Member Functions
virtual OpcUa_StatusCode	startUpWriter (DataSetWriter *pDataSetWriter)=0
	Callback informing the application about the start up of the DataSetWriter. More...

virtual void	stateChange (DataSetWriter *pDataSetWriter, OpcUa_PubSubState newState)
	Callback informing the application about a state change of the DataSetWriter. More...

virtual OpcUa_StatusCode	shutDownWriter (DataSetWriter *pDataSetWriter)=0
	Callback informing the application about the shut down of the DataSetWriter. More...

virtual OpcUa_StatusCode	writeDataSetMessageFields (DataSetWriter pDataSetWriter, struct ua_encoder_context pEnc, bool &dataSetMessageValid, OpcUa_Byte &dataSetMessageType, OpcUa_UInt16 &status)=0
	Callback for encoding the fields of a new DataSetMessage before sending. More...

Detailed Description

Callback class for the DataSetWriter.

Member Function Documentation

virtual OpcUa_StatusCode PubSubBase::DataSetWriterCallback::shutDownWriter ( DataSetWriter * pDataSetWriter )

pure virtual

Callback informing the application about the shut down of the DataSetWriter.

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

Parameters

[in] pDataSetWriter The affected DataSetWriter

virtual OpcUa_StatusCode PubSubBase::DataSetWriterCallback::startUpWriter ( DataSetWriter * pDataSetWriter )

pure virtual

Callback informing the application about the start up of the DataSetWriter.

Parameters

[in] pDataSetWriter The affected DataSetWriter

void PubSubBase::DataSetWriterCallback::stateChange	(	DataSetWriter *	pDataSetWriter,
		OpcUa_PubSubState	newState
	)

virtual

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

Parameters

[in]	pDataSetWriter	The affected DataSetWriter
[in]	newState	The new state of the affected DataSetWriter

virtual OpcUa_StatusCode PubSubBase::DataSetWriterCallback::writeDataSetMessageFields	(	DataSetWriter *	pDataSetWriter,
		struct ua_encoder_context *	pEnc,
		bool &	dataSetMessageValid,
		OpcUa_Byte &	dataSetMessageType,
		OpcUa_UInt16 &	status
	)

pure virtual

Callback for encoding the fields of a new DataSetMessage before sending.

The application is responsible for writing the field count and the field data. The DataSetMessage header is already filled by the SDK.

The out parameters allow to influence the header in the case of an error or if the message type changes between messages.

Parameters

[in] pDataSetWriter The affected DataSetWriter

[in] pEnc The encoder object used to write the DataSetMessage fields.

[out] dataSetMessageValid Flag indicating if the DataSetMessage is valid

[out]

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 4 indicates if more events are available if the type is Event.

[out] status The overall status of the DataSetMessage

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