OMQ::UserApi::Workflow::QorusAsyncStepBase Class Reference

The Qore base interface class for asynchronous steps. More...

Inheritance diagram for OMQ::UserApi::Workflow::QorusAsyncStepBase:

Static Public Member Methods
static public	submitAsyncKey (string key)
	Binds the given key to the asynchronous step. More...
static public	skipAsyncStep ()
	This method will skip the execution of an asynchronous step. More...

Detailed Description

The Qore base interface class for asynchronous steps.

Note

Qorus step constructors do not take any arguments; see Class-Based Step Constructors and Static Initialization for information about constructors and static class initialization.

See also

Asynchronous Steps

Member Function Documentation

skipAsyncStep()

static public OMQ::UserApi::Workflow::QorusAsyncStepBase::skipAsyncStep ( )

static

This method will skip the execution of an asynchronous step.

Calling this method or submitAsyncKey() more than once from an asynchronous step will result in an exception.

Exceptions

INVALID-FUNCTION-CALL

invalid method call (double call, etc)

Note

Asynchronous steps must call either this method or submitAsyncKey() or an error will be raised.

See also

wf_submit_async_key()

submitAsyncKey()

static public OMQ::UserApi::Workflow::QorusAsyncStepBase::submitAsyncKey ( string  key )

static

Binds the given key to the asynchronous step.

If this method is called more than once from an asynchronous step, an exception will be thrown.

If the key already exists in the queue, an exception will be thrown.

The queue name and ID is taken from the step definition; queue entries are created in the table QUEUE_DATA.

Parameters

key	the key for the queue entry; must be unique in the queue

Exceptions

INVALID-FUNCTION-CALL	invalid method call (double call, etc)
INVALID-KEY	empty string passed for key

Note

Asynchronous steps must call either this method or skipAsyncStep() or an error will be raised.

See also

wf_submit_async_key()

---

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

• QorusAsyncStepBase.qc