alma::ACS::jbaci::BACIAction Class Reference

Inheritance diagram for alma::ACS::jbaci::BACIAction:

[legend]

Collaboration diagram for alma::ACS::jbaci::BACIAction:

[legend]

List of all members.

Public Member Functions
	BACIAction (PrioritizedExecutor executor, CBvoid callback, CBDescIn descIn)
	BACIAction (PrioritizedExecutor executor, Callback callback, CBDescIn descIn, CallbackDispatcher callbackDispatcher)
	BACIAction (PrioritizedExecutor executor, CBvoid callback, CBDescIn descIn, BACIPriority priority)
	BACIAction (PrioritizedExecutor executor, Callback callback, CBDescIn descIn, CallbackDispatcher callbackDispatcher, BACIPriority priority)
BACIPriority	getPriority ()
final void	run ()
abstract Object	execute () throws AcsJException
void	submit ()
Protected Member Functions
boolean	dispatch ()
Static Protected Member Functions
static CBDescOut	generateCBDescOut (CBDescIn descIn)
Protected Attributes
BACIPriority	priority
PrioritizedExecutor	executor
CBDescOut	descOut
Callback	callback
CallbackDispatcher	callbackDispatcher
Completion	completion
Object	returnValue

---

Detailed Description

BACI action.

Author:

Matej Sekoranja

Version:

$id$

---

Constructor & Destructor Documentation

alma::ACS::jbaci::BACIAction::BACIAction	(	PrioritizedExecutor	executor,
		CBvoid	callback,
		CBDescIn	descIn
	)			[inline]

Constructor of NORMAL priority action (CBvoid callback).

Parameters:

	executor	executor to be used to execute action.
	callback	action callback.
	descIn	action callback in descriptor.

alma::ACS::jbaci::BACIAction::BACIAction	(	PrioritizedExecutor	executor,
		Callback	callback,
		CBDescIn	descIn,
		CallbackDispatcher	callbackDispatcher
	)			[inline]

Constructor of NORMAL priority action.

Parameters:

	executor	executor to be used to execute action.
	callback	action callback.
	descIn	action callback in descriptor.
	callbackDispatcher	callback dispatcher (value dependend).

alma::ACS::jbaci::BACIAction::BACIAction	(	PrioritizedExecutor	executor,
		CBvoid	callback,
		CBDescIn	descIn,
		BACIPriority	priority
	)			[inline]

Constructor.

Parameters:

	executor	executor to be used to execute action.
	callback	action callback.
	descIn	action in descriptor.
	priority	action priority.

alma::ACS::jbaci::BACIAction::BACIAction	(	PrioritizedExecutor	executor,
		Callback	callback,
		CBDescIn	descIn,
		CallbackDispatcher	callbackDispatcher,
		BACIPriority	priority
	)			[inline]

Constructor.

Parameters:

	executor	executor to be used to execute action.
	callback	action callback.
	descIn	action in descriptor.
	callbackDispatcher	callback dispatcher (value dependend).
	priority	action priority.

References descOut, and generateCBDescOut().

---

Member Function Documentation

boolean alma::ACS::jbaci::BACIAction::dispatch

(

)

[inline, protected]

Dispatch method.

Returns:

true if successfully dispatched.

References callback, callbackDispatcher, completion, descOut, alma::ACS::jbaci::CallbackDispatcher::dispatchCallback(), and returnValue.

Referenced by run().

abstract Object alma::ACS::jbaci::BACIAction::execute

(

)

throws AcsJException [pure virtual]

Action to be executed - implement it. If completion field is left to null (by this method), this class will create a no-error completion with current timestamp. Use alma.ACS.jbaci.CompletionUtil class to generate no-error completion.

Returns:

value to be send via callback, can be null.

Implemented in alma::ACS::impl::CommonPropertyImpl::GetAsyncAction, alma::ACS::impl::CommonPropertyImpl::SetAsyncAction, alma::ACS::impl::RWCommonComparablePropertyImpl::IncrementAction, alma::ACS::impl::RWCommonComparablePropertyImpl::DecrementAction, and alma::ACS::jbaci::ReflectionBACIAction.

Referenced by run().

static CBDescOut alma::ACS::jbaci::BACIAction::generateCBDescOut

(

CBDescIn

descIn

)

[inline, static, protected]

Generates callback out descriptor from in descriptor.

Parameters:

descIn

callback in descriptor.

Returns:

generated callback out descriptor.

References alma::ACS::CBDescIn::id_tag.

Referenced by BACIAction().

BACIPriority alma::ACS::jbaci::BACIAction::getPriority

(

)

[inline]

See also:

alma.ACS.jbaci.PrioritizedRunnable::getPriority()

Implements alma::ACS::jbaci::PrioritizedRunnable.

References priority.

final void alma::ACS::jbaci::BACIAction::run

(

)

[inline]

NOT TO BE CHANGED.

References completion, dispatch(), execute(), and returnValue.

void alma::ACS::jbaci::BACIAction::submit

(

)

[inline]

Sumbit action to be BACIExecutor to be executed.

References alma::ACS::jbaci::PrioritizedExecutor::execute(), and executor.

---

Member Data Documentation

Callback alma::ACS::jbaci::BACIAction::callback [protected]

Callback.

Referenced by dispatch().

CallbackDispatcher alma::ACS::jbaci::BACIAction::callbackDispatcher [protected]

Callback dispatcher (used to dispatch non-CBvoid callbacks).

Referenced by dispatch().

Completion alma::ACS::jbaci::BACIAction::completion [protected]

Completion.

Referenced by dispatch(), alma::ACS::impl::RWCommonComparablePropertyImpl::DecrementAction::execute(), alma::ACS::impl::RWCommonComparablePropertyImpl::IncrementAction::execute(), alma::ACS::impl::CommonPropertyImpl::SetAsyncAction::execute(), alma::ACS::impl::CommonPropertyImpl::GetAsyncAction::execute(), and run().

CBDescOut alma::ACS::jbaci::BACIAction::descOut [protected]

Callback out descriptor.

Referenced by BACIAction(), and dispatch().

PrioritizedExecutor alma::ACS::jbaci::BACIAction::executor [protected]

Executor.

Referenced by submit().

BACIPriority alma::ACS::jbaci::BACIAction::priority [protected]

Action priority.

Referenced by getPriority().

Object alma::ACS::jbaci::BACIAction::returnValue [protected]

Return value.

Referenced by dispatch(), alma::ACS::impl::CommonPropertyImpl::GetAsyncAction::execute(), and run().

---

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

• BACIAction.java