UaTransactionManager Class Reference

Implements the UA node manager. Derived from HistoryManagerCallback, and IOManagerCallback. It is not possible to create plane copies of this class. It is not possible to use the default constructor. More...

#include <uatransactionmanager.h>

Inheritance diagram for UaTransactionManager:

Inheritance graph
[legend]
Collaboration diagram for UaTransactionManager:

Collaboration graph
[legend]

List of all members.


Public Member Functions

 UaTransactionManager (ServerManager *pServerManager)
 ~UaTransactionManager ()
UaStatus startUp ()
UaStatus shutDown ()
UaStatus finishRead (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, UaDataValue &dataValue, OpcUa_Boolean detachValue=OpcUa_False, OpcUa_Boolean allowThreadUse=OpcUa_False, UaDiagnosticInfo *pDiagnosticInfo=NULL)
UaStatus finishWrite (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, const UaStatus &statusCode, OpcUa_Boolean allowThreadUse=OpcUa_False)
UaStatus finishStartMonitoring (OpcUa_UInt32, OpcUa_UInt32, OpcUa_UInt32, OpcUa_Double, OpcUa_Boolean, const UaDataValue &, const UaStatus &)
UaStatus finishModifyMonitoring (OpcUa_UInt32, OpcUa_UInt32, OpcUa_Double, const UaStatus &)
UaStatus finishStopMonitoring (OpcUa_UInt32, OpcUa_UInt32, const UaStatus &)
UaStatus finishHistoryReadData (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, const UaStatus &result, HistoryReadCPUserDataBase *pContinuationPoint, UaDataValues &dataValues, OpcUa_Boolean allowThreadUse=OpcUa_False)
UaStatus finishHistoryReadEvent (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, const UaStatus &result, HistoryReadCPUserDataBase *pContinuationPoint, UaHistoryEventFieldLists &events, OpcUa_Boolean allowThreadUse=OpcUa_False)
UaStatus finishHistoryUpdate (OpcUa_UInt32 hTransaction, OpcUa_UInt32 callbackHandle, const UaStatus &result, UaStatusCodeArray &operationResults, UaDiagnosticInfos &operationDiagnosticInfos, OpcUa_Boolean allowThreadUse=OpcUa_False)
UaStatus registerNodes (const ServiceContext &serviceContext, const UaNodeIdArray &nodesToRegister, UaNodeIdArray &registeredNodesIds)
UaStatus unregisterNodes (const ServiceContext &serviceContext, const UaNodeIdArray &registeredNodesIds)
UaStatus beginRead (UaReadContext *pUaReadContext)
UaStatus beginWrite (UaWriteContext *pUaWriteContext)
UaStatus beginHistoryRead (UaHistoryReadContext *pUaHistoryReadContext)
UaStatus beginHistoryUpdate (UaHistoryUpdateContext *pUaHistoryUpdateContext)
UaStatus beginMethodCall (UaCallContext *pUaCallContext)

Detailed Description

Implements the UA node manager. Derived from HistoryManagerCallback, and IOManagerCallback. It is not possible to create plane copies of this class. It is not possible to use the default constructor.

UaTransactionManager

Constructor & Destructor Documentation

UaTransactionManager::UaTransactionManager ( ServerManager *  pServerManager  ) 

construction

Parameters:
pServerManager Interface to the central ServerManager object. This interface pointer should be stored in the NodeManager instance to have access to core module objects like the root NodeManager or the ServerConfig

UaTransactionManager::~UaTransactionManager (  ) 

destruction

Member Function Documentation

UaStatus UaTransactionManager::startUp (  ) 

Start up transaction manager.

Returns:
Error code

UaStatus UaTransactionManager::shutDown (  ) 

Shut down transaction manager.

Returns:
Error code

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

Finish a Read transaction.

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.
dataValue the requested Value for this 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

Implements IOManagerCallback.

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

Finish a Write transaction.

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.
statusCode Result of the finishWrite 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

Implements IOManagerCallback.

UaStatus UaTransactionManager::finishStartMonitoring ( OpcUa_UInt32  hTransaction,
OpcUa_UInt32  callbackHandle,
OpcUa_UInt32  hIOVariable,
OpcUa_Double  revisedSamplingInterval,
OpcUa_Boolean  initialDataValueAvailable,
const UaDataValue &  initialDataValue,
const UaStatus &  statusCode 
) [inline, 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

Implements IOManagerCallback.

UaStatus UaTransactionManager::finishModifyMonitoring ( OpcUa_UInt32  hTransaction,
OpcUa_UInt32  callbackHandle,
OpcUa_Double  revisedSamplingInterval,
const UaStatus &  statusCode 
) [inline, 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

Implements IOManagerCallback.

UaStatus UaTransactionManager::finishStopMonitoring ( OpcUa_UInt32  hTransaction,
OpcUa_UInt32  callbackHandle,
const UaStatus &  statusCode 
) [inline, 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

Implements IOManagerCallback.

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

Finish a history data read transaction.

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.
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.
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

Implements HistoryManagerCallback.

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

Finish a history event read transaction.

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.
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 fieldlist of events that can occur.
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

Implements HistoryManagerCallback.

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

Finish a history update transaction.

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.
result the result of the current Operation.
operationResults the results of an actual operation
operationDiagnosticInfos the diagnsotic information of the current 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

Implements HistoryManagerCallback.

UaStatus UaTransactionManager::registerNodes ( const ServiceContext &  serviceContext,
const UaNodeIdArray &  nodesToRegister,
UaNodeIdArray &  registeredNodesIds 
)

Register nodes to create handles in the session context.

Parameters:
serviceContext General context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
nodesToRegister the current used Nodes to register.
registeredNodesIds the registered NodeId of the current Node.
Returns:
Error code

UaStatus UaTransactionManager::unregisterNodes ( const ServiceContext &  serviceContext,
const UaNodeIdArray &  registeredNodesIds 
)

Unregister nodes used as handles in the session context.

Parameters:
serviceContext General context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
registeredNodesIds the registered NodeId of the current Node.
Returns:
Error code

UaStatus UaTransactionManager::beginRead ( UaReadContext *  pUaReadContext  ) 

Begin a Read transaction.

Parameters:
pUaReadContext the needed read context.
Returns:
Error code

List of objects to store a subset of the data for a IOManager

UaStatus UaTransactionManager::beginWrite ( UaWriteContext *  pUaWriteContext  ) 

Begin a Write transaction.

Parameters:
pUaWriteContext the needed write context.
Returns:
Error code

List of objects to store a subset of the data for a IOManager

UaStatus UaTransactionManager::beginHistoryRead ( UaHistoryReadContext *  pUaHistoryReadContext  ) 

Begin a HistoryRead transaction.

Parameters:
pUaHistoryReadContext the needed read context for historizing.
Returns:
Error code

List of objects to store a subset of the data for a HistoryManager

UaStatus UaTransactionManager::beginHistoryUpdate ( UaHistoryUpdateContext *  pUaHistoryUpdateContext  ) 

Begin a HistoryUpdate transaction.

Parameters:
pUaHistoryUpdateContext the needed update context for historizing.
Returns:
Error code

List of objects to store a subset of the data for a HistoryManager

UaStatus UaTransactionManager::beginMethodCall ( UaCallContext *  pUaCallContext  ) 

Begin a Call transaction.

Parameters:
pUaCallContext the needed call context.
Returns:
Error code

The documentation for this class was generated from the following files:
  • src/uaserver/uaservercpp/uamodule/uatransactionmanager.h
  • src/uaserver/uaservercpp/uamodule/uatransactionmanager.cpp