C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
HistoryManagerCallback Class Referenceabstract

The corresponding callback interface for the HistoryManager. More...

#include <historymanager.h>

Inherited by UaTransactionManager.

Public Member Functions

 HistoryManagerCallback ()
 construction
 
virtual ~HistoryManagerCallback ()
 destruction
 
virtual UaStatus finishHistoryReadData (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, const UaStatus &result, HistoryReadCPUserDataBase *pContinuationPoint, UaDataValues &dataValues, OpcUa_Boolean allowThreadUse=OpcUa_False)=0
 Callback function for a historical read of data. More...
 
virtual UaStatus finishHistoryReadModifiedData (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, const UaStatus &result, HistoryReadCPUserDataBase *pContinuationPoint, UaDataValues &dataValues, UaModificationInfo &modificationInformations, OpcUa_Boolean allowThreadUse=OpcUa_False)=0
 Callback function for a historical read of modified data. More...
 
virtual UaStatus finishHistoryReadEvent (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, const UaStatus &result, HistoryReadCPUserDataBase *pContinuationPoint, UaHistoryEventFieldLists &events, OpcUa_Boolean allowThreadUse=OpcUa_False)=0
 Finishes a historizing ReadEvent. More...
 
virtual UaStatus finishHistoryUpdate (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, const UaStatus &result, UaStatusCodeArray &operationResults, UaDiagnosticInfos &operationDiagnosticInfos, OpcUa_Boolean allowThreadUse=OpcUa_False)=0
 Finishes a historizing Update. More...
 

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.

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
hTransactionHandle for the transaction used by the SDK to identify the transaction in the callbacks. This handle was passed in to the HistoryManager with the beginHistoryTransaction method.
callbackHandleHandle for the node in the callback. This handle was passed in to the HistoryManager with either beginReadRawModified, beginReadProcessed or beginReadAtTime.
resultThe result of the current Operation.
pContinuationPointThe 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.
dataValuesThe requested Values for this operation. The values array will be detached by the SDK.
allowThreadUseIndicates 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
hTransactionHandle for the transaction used by the SDK to identify the transaction in the callbacks. This handle was passed in to the HistoryManager with the beginHistoryTransaction method.
callbackHandleHandle for the node in the callback. This handle was passed in to the HistoryManager with the beginReadEvents method.
resultthe result of the current Operation.
pContinuationPointThe 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.
eventsa list of events that match the read filter. The event array will be detached by the SDK.
allowThreadUseIndicates 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
hTransactionHandle for the transaction used by the SDK to identify the transaction in the callbacks. This handle was passed in to the HistoryManager with the beginHistoryTransaction method.
callbackHandleHandle for the node in the callback. This handle was passed in to the HistoryManager with the beginReadRawModified method.
resultThe result of the current Operation.
pContinuationPointThe 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.
dataValuesThe requested Values for this operation. The values array will be detached by the SDK.
modificationInformationsThe modification information for the requested Values for this operation. The information array will be detached by the SDK.
allowThreadUseIndicates 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
hTransactionHandle for the transaction used by the SDK to identify the transaction in the callbacks. This handle was passed in to the HistoryManager with the beginHistoryTransaction method.
callbackHandleHandle for the node in the callback. This handle was passed in to the HistoryManager with either beginUpdateData, beginUpdateEvents, beginDeleteRawModified, beginDeleteAtTime or beginDeleteEvents.
resultthe result of the current Operation.
operationResultsThe results for the requested updates.
operationDiagnosticInfosThe diagnostic for the requested updates.
allowThreadUseIndicates 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: