#include <uatransactionmanager.h>

Inherits HistoryManagerCallback, and IOManagerCallback.

Public Member Functions
	UaTransactionManager (ServerManager pServerManager, UaSubscriptionManager pUaSubscriptionManager)
	construction More...

	~UaTransactionManager ()
	destruction

UaStatus	startUp ()
	Start up transaction manager. More...

UaStatus	shutDown ()
	Shut down transaction manager. More...

UaStatus	finishRead (OpcUa_UInt32, OpcUa_UInt32, UaDataValue &, OpcUa_Boolean detachValue=OpcUa_False, OpcUa_Boolean allowThreadUse=OpcUa_False, UaDiagnosticInfo *pDiagnosticInfo=NULL)
	Finish a Read transaction. More...

UaStatus	finishWrite (OpcUa_UInt32, OpcUa_UInt32, const UaStatus &, OpcUa_Boolean allowThreadUse=OpcUa_False)
	Finish a Write transaction. More...

UaStatus	finishStartMonitoring (OpcUa_UInt32, OpcUa_UInt32, OpcUa_UInt32, OpcUa_Double, OpcUa_Boolean, const UaDataValue &, const UaStatus &)
	Finished start monitoring of an attribute value of a node. More...

UaStatus	finishModifyMonitoring (OpcUa_UInt32, OpcUa_UInt32, OpcUa_Double, const UaStatus &)
	Finished modify monitoring of an attribute value of a node. More...

UaStatus	finishStopMonitoring (OpcUa_UInt32, OpcUa_UInt32, const UaStatus &)
	Finished stop monitoring of an attribute value of a node. More...

UaStatus	finishHistoryReadData (OpcUa_UInt32, OpcUa_UInt32, const UaStatus &, HistoryReadCPUserDataBase *, UaDataValues &, OpcUa_Boolean)
	Finish a history data read transaction. More...

UaStatus	finishHistoryReadModifiedData (OpcUa_UInt32, OpcUa_UInt32, const UaStatus &, HistoryReadCPUserDataBase *, UaDataValues &, UaModificationInfo &, OpcUa_Boolean)
	Callback function for a historical read of modified data. More...

UaStatus	finishHistoryReadEvent (OpcUa_UInt32, OpcUa_UInt32, const UaStatus &, HistoryReadCPUserDataBase *, UaHistoryEventFieldLists &s, OpcUa_Boolean)
	Finish a history event read transaction. More...

UaStatus	finishHistoryUpdate (OpcUa_UInt32, OpcUa_UInt32, const UaStatus &, UaStatusCodeArray &, UaDiagnosticInfos &, OpcUa_Boolean)
	Finish a history update transaction. More...

UaStatus	beginHistoryRead (UaHistoryReadContext *pUaHistoryReadContext)
	Begin a HistoryRead transaction. More...

UaStatus	beginHistoryUpdate (UaHistoryUpdateContext *pUaHistoryUpdateContext)
	Begin a HistoryUpdate transaction. More...

UaStatus	cancelServices (const ServiceContext &serviceContext, OpcUa_UInt32 requestHandle, OpcUa_UInt32 &cancelCount)
	Cancel services in the session context. More...

virtual UaStatus	registerNodes (const ServiceContext &serviceContext, const UaNodeIdArray &nodesToRegister, UaNodeIdArray &registeredNodesIds)
	Register nodes to create handles in the session context. More...

virtual UaStatus	unregisterNodes (const ServiceContext &serviceContext, const UaNodeIdArray &registeredNodesIds)
	Unregister nodes used as handles in the session context. More...

virtual UaStatus	beginBrowse (UaBrowseContext *pUaBrowseContext)
	Begin a Browse transaction. More...

virtual UaStatus	beginBrowseNext (UaBrowseNextContext *pUaBrowseNextContext)
	Begin a BrowseNext transaction. More...

virtual UaStatus	beginTranslateBrowsePathsToNodeIds (UaTranslateBrowsePathsToNodeIdsContext *pUaTranslateBrowsePathsToNodeIdsContext)
	Begin a TranslateBrowsePathsToNodeIds transaction. More...

virtual UaStatus	beginQuery (UaQueryContext *pUaQueryContext)
	Begin a Query transaction. More...

UaStatus	beginRead (UaReadContext *pUaReadContext)
	Begin a Read transaction. More...

UaStatus	beginWrite (UaWriteContext *pUaWriteContext)
	Begin a Write transaction. More...

UaStatus	detachTransaction (OpcUa_UInt32 hTransaction)
	Remove a transaction from the TransactionHandleManager without deleting the context. More...

virtual UaStatus	beginMethodCall (UaCallContext *pUaCallContext)
	Begin a Call transaction. More...

Public Member Functions inherited from HistoryManagerCallback
	HistoryManagerCallback ()
	construction

virtual	~HistoryManagerCallback ()
	destruction

Public Member Functions inherited from IOManagerCallback
	IOManagerCallback ()
	Construction.

virtual	~IOManagerCallback ()
	Destruction.

Detailed Description

UaTransactionManager.

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

Constructor & Destructor Documentation

UaTransactionManager::UaTransactionManager	(	ServerManager *	pServerManager,
		UaSubscriptionManager *	pUaSubscriptionManager
	)

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
pUaSubscriptionManager	Interface of the UaSubscriptionManager

Member Function Documentation

UaStatus UaTransactionManager::beginBrowse ( UaBrowseContext * pUaBrowseContext )

virtual

Begin a Browse transaction.

Parameters

pUaBrowseContext the needed browse context.

Returns: Error code

UaStatus UaTransactionManager::beginBrowseNext ( UaBrowseNextContext * pUaBrowseNextContext )

virtual

Begin a BrowseNext transaction.

Parameters

pUaBrowseNextContext the needed BrowseNext context.

Returns: Error code

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 )

virtual

Begin a Call transaction.

Parameters

pUaCallContext the needed call context.

Returns: Error code

UaStatus UaTransactionManager::beginQuery ( UaQueryContext * pUaQueryContext )

virtual

Begin a Query transaction.

Parameters

pUaQueryContext the needed query context.

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::beginTranslateBrowsePathsToNodeIds ( UaTranslateBrowsePathsToNodeIdsContext * pUaTranslateBrowsePathsToNodeIdsContext )

virtual

Begin a TranslateBrowsePathsToNodeIds transaction.

Parameters

pUaTranslateBrowsePathsToNodeIdsContext the needed TranslateBrowsePathsToNodeIdsContext context.

Returns: Error code

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::cancelServices	(	const ServiceContext &	serviceContext,
		OpcUa_UInt32	requestHandle,
		OpcUa_UInt32 &	cancelCount
	)

Cancel services in the session context.

Parameters

serviceContext	General context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
requestHandle	RequestHandle of service requests to cancel.
cancelCount	Number of cancelled requests.

Returns: Error code

UaStatus UaTransactionManager::detachTransaction ( OpcUa_UInt32 hTransaction )

Remove a transaction from the TransactionHandleManager without deleting the context.

Parameters

hTransaction Handle returned by from the TransactionHandleManager when the context was added.

Returns: Error code

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

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 HistoryManager with the beginHistoryTransaction method.
callbackHandle	Handle for the node in the callback. This handle was passed in to the HistoryManager with either beginReadRawModified, beginReadProcessed or beginReadAtTime.
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
	)

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 HistoryManager with the beginHistoryTransaction method.
callbackHandle	Handle for the node in the callback. This handle was passed in to the HistoryManager with the beginReadEvents 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 field list 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::finishHistoryReadModifiedData	(	OpcUa_UInt32	hTransaction,
		OpcUa_UInt32	callbackHandle,
		const UaStatus &	result,
		HistoryReadCPUserDataBase *	pContinuationPoint,
		UaDataValues &	dataValues,
		UaModificationInfo &	modificationInformations,
		OpcUa_Boolean	allowThreadUse
	)

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 HistoryManager with the beginHistoryTransaction method.
callbackHandle	Handle for the node in the callback. This handle was passed in to the HistoryManager with the beginReadRawModified 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.
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 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
	)

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 HistoryManager with the beginHistoryTransaction method.
callbackHandle	Handle for the node in the callback. This handle was passed in to the HistoryManager with either beginUpdateData, beginUpdateEvents, beginDeleteRawModified, beginDeleteAtTime or beginDeleteEvents.
result	the result of the current Operation.
operationResults	the results of an actual operation
operationDiagnosticInfos	the diagnostic 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::finishModifyMonitoring	(	OpcUa_UInt32	hTransaction,
		OpcUa_UInt32	callbackHandle,
		OpcUa_Double	revisedSamplingInterval,
		const UaStatus &	statusCode
	)

inlinevirtual

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. Optional diagnostig information requested by the client in the parameter ServiceContext::returnDiagnostics of IOManager::beginTransaction can be provided through UaStatus::setDiagnosticInfo().

Returns: Error code

Implements IOManagerCallback.

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 beginRead 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 diagnostic information requested by the client in the parameter ServiceContext::returnDiagnostics of IOManager::beginTransaction

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
	)

inlinevirtual

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 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.
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. Optional diagnostig information requested by the client in the parameter ServiceContext::returnDiagnostics of IOManager::beginTransaction can be provided through UaStatus::setDiagnosticInfo().

Returns: Error code

Implements IOManagerCallback.

UaStatus UaTransactionManager::finishStopMonitoring	(	OpcUa_UInt32	hTransaction,
		OpcUa_UInt32	callbackHandle,
		const UaStatus &	statusCode
	)

inlinevirtual

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. Optional diagnostig information requested by the client in the parameter ServiceContext::returnDiagnostics of IOManager::beginTransaction can be provided through UaStatus::setDiagnosticInfo().

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 beginWrite 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::registerNodes	(	const ServiceContext &	serviceContext,
		const UaNodeIdArray &	nodesToRegister,
		UaNodeIdArray &	registeredNodesIds
	)

virtual

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

Possible check for structural invalid NodeIds - should be handled by stack already for ( i=0; i<itemCount; i++ ) { Size checks can be added Schould be handled by stack already if ( nodesToRegister[i].IdentifierType > OpcUa_IdentifierType_Opaque ) { TRACE1_ERROR(UA_MODULE, "<-- UaTransactionManager::registerNodes [ret=OpcUa_BadNodeIdInvalid] - NodeId %u has invalid IdentifierType", i); return OpcUa_BadNodeIdInvalid; } }

UaStatus UaTransactionManager::shutDown ( )

Shut down transaction manager.

Returns: Error code

UaStatus UaTransactionManager::startUp ( )

Start up transaction manager.

Returns: Error code

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

virtual

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

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

C:/work/uasdkcpp/src/uaserver/uaservercpp/uamodule/uatransactionmanager.h
C:/work/uasdkcpp/src/uaserver/uaservercpp/uamodule/uatransactionmanager.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation