UA Server SDK C++ Bundle  1.4.1.271
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IOManagerCallback Class Referenceabstract

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

#include <iomanager.h>

Inherited by CoreTransactions, UaSubscription, and UaTransactionManager.

Public Member Functions

 IOManagerCallback ()
 Construction.
 
virtual ~IOManagerCallback ()
 Destruction.
 
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
 Finished reading of an attribute value of a node. More...
 
virtual UaStatus finishWrite (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, const UaStatus &statusCode, OpcUa_Boolean allowThreadUse=OpcUa_False)=0
 Finished writing of an attribute value of a node. More...
 
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
 Finished start monitoring of an attribute value of a node. More...
 
virtual UaStatus finishModifyMonitoring (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, OpcUa_Double revisedSamplingInterval, const UaStatus &statusCode)=0
 Finished modify monitoring of an attribute value of a node. More...
 
virtual UaStatus finishStopMonitoring (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, const UaStatus &statusCode)=0
 Finished stop monitoring of an attribute value of a node. More...
 

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.

Member Function Documentation

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
hTransactionHandle 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.
callbackHandleHandle for the node in the callback. This handle was passed in to the IOManager with the beginModifyMonitoring method.
revisedSamplingIntervalThe corresponding revised sampling interval for the requested sampling interval in beginModifyMonitoring.
statusCodeResult of the ModifyMonitoring operation. Optional diagnostig information requested by the client in the parameter ServiceContext::returnDiagnostics of IOManager::beginTransaction can be provided through UaStatus::setDiagnosticInfo().
Returns
Error code

Implemented in UaSubscription, and UaTransactionManager.

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
hTransactionHandle 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.
callbackHandleHandle for the node in the callback. This handle was passed in to the IOManager with the beginRead method.
dataValueContains the value, timestamps and result code for the Read operation.
detachValueIndicates if the method can detach the value from the wrapper class.
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.
pDiagnosticInfoOptional 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::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
hTransactionHandle 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.
callbackHandleHandle for the node in the callback. This handle was passed in to the IOManager with the beginStartMonitoring method.
hIOVariableThe handle of the item in the IOManager created with beginStartMonitoring. The handle is used by the SDK in beginModifyMonitoring and beginStopMonitoring to adress the item in the IOManager.
revisedSamplingIntervalThe corresponding revised sampling interval for the requested sampling interval in beginStartMonitoring.
initialDataValueAvailableIndicates if the initial value parameter is valid.
initialDataValueContains the value, timestamps and result code for the initial value.
statusCodeResult of the StartMonitoring operation. Optional diagnostig information requested by the client in the parameter ServiceContext::returnDiagnostics of IOManager::beginTransaction can be provided through UaStatus::setDiagnosticInfo().
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
hTransactionHandle 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.
callbackHandleHandle for the node in the callback. This handle was passed in to the IOManager with the beginStopMonitoring method.
statusCodeResult of the StopMonitoring operation. Optional diagnostig information requested by the client in the parameter ServiceContext::returnDiagnostics of IOManager::beginTransaction can be provided through UaStatus::setDiagnosticInfo().
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
hTransactionHandle 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.
callbackHandleHandle for the node in the callback. This handle was passed in to the IOManager with the beginWrite method.
statusCodeResult of the Write operation. Optional diagnostig information requested by the client in the parameter ServiceContext::returnDiagnostics of IOManager::beginTransaction can be provided through UaStatus::setDiagnosticInfo().
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 UaSubscription, and UaTransactionManager.


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