OMQ::UserApi::Workflow::TempDataHelper Class Reference

This class is a helper class that allows workflow temp data to be read and updated atomically; the write lock for the data is grabbed in the constructor and released in the destructor. More...

Inheritance diagram for OMQ::UserApi::Workflow::TempDataHelper:

Private:Internal Member Methods
	constructor ()
	creates the object and grabs the write lock for workflow temp data during the lifetime of the object More...
nothing	replace (*hash< auto > new_data)
	replaces or erases the workflow temp data More...
nothing	update (hash< auto > new_data)
	adds data to workflow temp data
nothing	deleteKey (softlist keysv)
	deletes one or more keys from workflow temp data

Additional Inherited Members
Public Member Methods inherited from OMQ::UserApi::Workflow::WorkflowDataHelper
	destructor ()
	destroys the object and releases the write lock
auto	get (auto field)
	returns the value of one or more keys in the data or the entire data structure depending on the argument

Detailed Description

This class is a helper class that allows workflow temp data to be read and updated atomically; the write lock for the data is grabbed in the constructor and released in the destructor.

Calls to the following workflow API functions related to workflow temp data can be

made normally while this object exists and the write lock is held

Note

in Python available as wf.TempDataHelper

Since

Qorus 3.1.0

Member Function Documentation

constructor()

OMQ::UserApi::Workflow::TempDataHelper::constructor ( )

private:internal

creates the object and grabs the write lock for workflow temp data during the lifetime of the object

Exceptions

LOCK-ERROR

another TempDataHelper object exists in the same thread; only one object can be

used at a time since the object grabs the write lock

replace()

nothing OMQ::UserApi::Workflow::TempDataHelper::replace ( *hash< auto >  new_data )

private:internal

replaces or erases the workflow temp data

Note

There is currently no function equivalent to this method for

workflow temp data; this method replaces all the data with new_data

---

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

• TempDataHelper.qc