#include <historymanager.h>

Inheritance diagram for HistoryManagerCallback:

Public Member Functions
	HistoryManagerCallback ()
virtual	~HistoryManagerCallback ()
virtual UaStatus	finishHistoryReadData (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, const UaStatus &result, HistoryReadCPUserDataBase *pContinuationPoint, UaDataValues &dataValues, OpcUa_Boolean allowThreadUse=OpcUa_False)=0
virtual UaStatus	finishHistoryReadModifiedData (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, const UaStatus &result, HistoryReadCPUserDataBase *pContinuationPoint, UaDataValues &dataValues, UaModificationInfo &modificationInformations, OpcUa_Boolean allowThreadUse=OpcUa_False)=0
virtual UaStatus	finishHistoryReadEvent (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, const UaStatus &result, HistoryReadCPUserDataBase *pContinuationPoint, UaHistoryEventFieldLists &events, OpcUa_Boolean allowThreadUse=OpcUa_False)=0
virtual UaStatus	finishHistoryUpdate (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, const UaStatus &result, UaStatusCodeArray &operationResults, UaDiagnosticInfos &operationDiagnosticInfos, OpcUa_Boolean allowThreadUse=OpcUa_False)=0

Detailed Description

The corresponding callback interface for the HistoryManager. This callback interface provides all corresponding callback methods for the begin methods in the HistoryManager interface.
!!!!!
This interface may change after release 1.0 of the UA Server SDK since the corresponding OPC UA Specificaiton is not finally released
!!!!!

Constructor & Destructor Documentation

HistoryManagerCallback::HistoryManagerCallback ( ) [inline]

construction

virtual HistoryManagerCallback::~HistoryManagerCallback ( ) [inline, virtual]

destruction

Member Function Documentation

virtual UaStatus HistoryManagerCallback::finishHistoryReadData	(	OpcUa_UInt32	hTransaction,
		OpcUa_UInt32	callbackHandle,
		const UaStatus &	result,
		HistoryReadCPUserDataBase *	pContinuationPoint,
		UaDataValues &	dataValues,
		OpcUa_Boolean	allowThreadUse = `OpcUa_False`
	)		`[pure virtual]`

Callback function for a historical read of data.

Parameters:

hTransaction	Handle for the transaction used by the SDK to identify the transaction in the callbacks. This handle was passed in to the IOManager with the beginTransaction method.
callbackHandle	Handle for the node in the callback. This handle was passed in to the IOManager with the beginStopMonitoring method.
result	The result of the current Operation.
pContinuationPoint	The continuation point data if not all results can be returned in one Read call. Implementers of this interface can store the continuation point data in a derived class.
dataValues	The requested Values for this operation. The values array will be detached by the SDK.
allowThreadUse	Indicates if the calling thread can be used by the SDK to send the response to the client. This can happen if this method is the called for the last node in the transaction. True: The thread calling this method can be used to send the response and may block False: The SDK is using a worker thread to send the response to the client.

Returns:: Error code

Implemented in UaTransactionManager.

virtual UaStatus HistoryManagerCallback::finishHistoryReadEvent	(	OpcUa_UInt32	hTransaction,
		OpcUa_UInt32	callbackHandle,
		const UaStatus &	result,
		HistoryReadCPUserDataBase *	pContinuationPoint,
		UaHistoryEventFieldLists &	events,
		OpcUa_Boolean	allowThreadUse = `OpcUa_False`
	)		`[pure virtual]`

Finishes a historizing ReadEvent.

Parameters:

hTransaction	Handle for the transaction used by the SDK to identify the transaction in the callbacks. This handle was passed in to the IOManager with the beginTransaction method.
callbackHandle	Handle for the node in the callback. This handle was passed in to the IOManager with the beginStopMonitoring method.
result	the result of the current Operation.
pContinuationPoint	The continuation point data if not all results can be returned in one Read call. Implementers of this interface can store the continuation point data in a derived class.
events	a list of events that match the read filter. The event array will be detached by the SDK.
allowThreadUse	Indicates if the calling thread can be used by the SDK to send the response to the client. This can happen if this method is the called for the last node in the transaction. True: The thread calling this method can be used to send the response and may block False: The SDK is using a worker thread to send the response to the client.

Returns:: Error code

Implemented in UaTransactionManager.

virtual UaStatus HistoryManagerCallback::finishHistoryReadModifiedData	(	OpcUa_UInt32	hTransaction,
		OpcUa_UInt32	callbackHandle,
		const UaStatus &	result,
		HistoryReadCPUserDataBase *	pContinuationPoint,
		UaDataValues &	dataValues,
		UaModificationInfo &	modificationInformations,
		OpcUa_Boolean	allowThreadUse = `OpcUa_False`
	)		`[pure virtual]`

Callback function for a historical read of modified data.

Parameters:

hTransaction	Handle for the transaction used by the SDK to identify the transaction in the callbacks. This handle was passed in to the IOManager with the beginTransaction method.
callbackHandle	Handle for the node in the callback. This handle was passed in to the IOManager with the beginStopMonitoring method.
result	The result of the current Operation.
pContinuationPoint	The continuation point data if not all results can be returned in one Read call. Implementers of this interface can store the continuation point data in a derived class.
dataValues	The requested Values for this operation. The values array will be detached by the SDK.
modificationInformations	The modification information for the requested Values for this operation. The information array will be detached by the SDK.
allowThreadUse	Indicates if the calling thread can be used by the SDK to send the response to the client. This can happen if this method is the called for the last node in the transaction. True: The thread calling this method can be used to send the response and may block False: The SDK is using a worker thread to send the response to the client.

Returns:: Error code

Implemented in UaTransactionManager.

virtual UaStatus HistoryManagerCallback::finishHistoryUpdate	(	OpcUa_UInt32	hTransaction,
		OpcUa_UInt32	callbackHandle,
		const UaStatus &	result,
		UaStatusCodeArray &	operationResults,
		UaDiagnosticInfos &	operationDiagnosticInfos,
		OpcUa_Boolean	allowThreadUse = `OpcUa_False`
	)		`[pure virtual]`

Finishes a historizing Update.

Parameters:

hTransaction	Handle for the transaction used by the SDK to identify the transaction in the callbacks. This handle was passed in to the IOManager with the beginTransaction method.
callbackHandle	Handle for the node in the callback. This handle was passed in to the IOManager with the beginStopMonitoring method.
result	the result of the current Operation.
operationResults	The results for the requested updates.
operationDiagnosticInfos	The diagnsotic for the requested updates.
allowThreadUse	Indicates if the calling thread can be used by the SDK to send the response to the client. This can happen if this method is the called for the last node in the transaction. True: The thread calling this method can be used to send the response and may block False: The SDK is using a worker thread to send the response to the client.

Returns:: Error code

Implemented in UaTransactionManager.

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

/home/buildbot/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/historymanager.h

HistoryManagerCallback Class Reference [Core Module Interfaces]

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

HistoryManagerCallback Class Reference
[Core Module Interfaces]