IOManagerCallback Class Reference
[Core Module Interfaces]

#include <iomanager.h>

Inheritance diagram for IOManagerCallback:

List of all members.


Public Member Functions

 IOManagerCallback ()
virtual ~IOManagerCallback ()
virtual UaStatus finishRead (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, UaDataValue &dataValue, OpcUa_Boolean detachValue=OpcUa_False, OpcUa_Boolean allowThreadUse=OpcUa_False, UaDiagnosticInfo *pDiagnosticInfo=NULL)=0
virtual UaStatus finishWrite (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, const UaStatus &statusCode, OpcUa_Boolean allowThreadUse=OpcUa_False)=0
virtual UaStatus finishStartMonitoring (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, OpcUa_UInt32 hIOVariable, OpcUa_Double revisedSamplingInterval, OpcUa_Boolean initialDataValueAvailable, const UaDataValue &initialDataValue, const UaStatus &statusCode)=0
virtual UaStatus finishModifyMonitoring (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, OpcUa_Double revisedSamplingInterval, const UaStatus &statusCode)=0
virtual UaStatus finishStopMonitoring (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, const UaStatus &statusCode)=0

Detailed Description

The corresponding callback interface for the IOManager. This callback interface provides all corresponding callback methods for the begin methods in the IOManager interface.

Constructor & Destructor Documentation

IOManagerCallback::IOManagerCallback (  )  [inline]

Construction

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

Destruction


Member Function Documentation

virtual UaStatus IOManagerCallback::finishRead ( OpcUa_UInt32  hTransaction,
OpcUa_UInt32  callbackHandle,
UaDataValue dataValue,
OpcUa_Boolean  detachValue = OpcUa_False,
OpcUa_Boolean  allowThreadUse = OpcUa_False,
UaDiagnosticInfo pDiagnosticInfo = NULL 
) [pure virtual]

Finished reading of an attribute value of a node. The method is called to finish a read call for an attribute value of a node. The read is started with the beginRead method of the interface IOManager.

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 beginRead method.
dataValue Contains the value, timestamps and result code for the Read operation.
detachValue Indicates if the method can detach the value from the wrapper class.
allowThreadUse Indicates if the calling thread can be used to send the response if this is the callback for the last node in the transaction.
pDiagnosticInfo Optional diagnostig information requested by the client in the parameter ServiceContext::returnDiagnostics of IOManager::beginTransaction
Returns:
Error code

Implemented in UaSubscription, and UaTransactionManager.

virtual UaStatus IOManagerCallback::finishWrite ( OpcUa_UInt32  hTransaction,
OpcUa_UInt32  callbackHandle,
const UaStatus statusCode,
OpcUa_Boolean  allowThreadUse = OpcUa_False 
) [pure virtual]

Finished writing of an attribute value of a node. The method is called to finish a write call for an attribute value of a node. The write is started with the beginWrite method of the interface IOManager.

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 beginWrite method.
statusCode Result of the Write operation.
allowThreadUse Indicates if the calling thread can be used to send the response if this is the callback for the last node in the transaction.
Returns:
Error code

Implemented in UaSubscription, and UaTransactionManager.

virtual UaStatus IOManagerCallback::finishStartMonitoring ( OpcUa_UInt32  hTransaction,
OpcUa_UInt32  callbackHandle,
OpcUa_UInt32  hIOVariable,
OpcUa_Double  revisedSamplingInterval,
OpcUa_Boolean  initialDataValueAvailable,
const UaDataValue initialDataValue,
const UaStatus statusCode 
) [pure virtual]

Finished start monitoring of an attribute value of a node. The method is called to finish the starting of the sampling for a monitored item. The sampling is started with the beginStartMonitoring method of the interface IOManager.

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 beginStartMonitoring method.
hIOVariable The handle of the variable in the IOManager created with beginStartMonitoring.
revisedSamplingInterval The corresponding revised sampling interval for the requested sampling interval in beginStartMonitoring.
initialDataValueAvailable Indicates if the initial value parameter is valid.
initialDataValue Contains the value, timestamps and result code for the initial value.
statusCode Result of the StartMonitoring operation.
Returns:
Error code

Implemented in UaSubscription, and UaTransactionManager.

virtual UaStatus IOManagerCallback::finishModifyMonitoring ( OpcUa_UInt32  hTransaction,
OpcUa_UInt32  callbackHandle,
OpcUa_Double  revisedSamplingInterval,
const UaStatus statusCode 
) [pure virtual]

Finished modify monitoring of an attribute value of a node. The method is called to finish the modifying of the sampling attributes for a monitored item. The modifying is started with the beginModifyMonitoring method of the interface IOManager.

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 beginModifyMonitoring method.
revisedSamplingInterval The corresponding revised sampling interval for the requested sampling interval in beginModifyMonitoring.
statusCode Result of the ModifyMonitoring operation.
Returns:
Error code

Implemented in UaSubscription, and UaTransactionManager.

virtual UaStatus IOManagerCallback::finishStopMonitoring ( OpcUa_UInt32  hTransaction,
OpcUa_UInt32  callbackHandle,
const UaStatus statusCode 
) [pure virtual]

Finished stop monitoring of an attribute value of a node. The method is called to finish the stopping of the sampling for a monitored item. The stopping is started with the beginStopMonitoring method of the interface IOManager.

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.
statusCode Result of the StopMonitoring operation.
Returns:
Error code

Implemented in UaSubscription, and UaTransactionManager.


The documentation for this class was generated from the following file:
  • src/uaserver/uaservercpp/coremodule/iomanager.h