Class: TActionDistributor

Declaration: ActionDistributor.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TRequest

Inherited By:

TViewActionDistributor

Purpose:

TActionDistributor is used to distribute actions. TActionDistributor is derived from TRequest so that it can be called directly from the request processor, if desired.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Use TActionDistributor to derive classes that support distribution policies which you define.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TActionDistributor::TActionDistributor

TActionDistributor (TAction * adoptedAction)

Interface Category:

API.

Purpose:

Creates a TActionDistributor, adopting the specified action.

Calling Context:

Called to create a TActionDistributor.

Parameters:

TAction * adoptedAction -The action to adopt.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TActionDistributor::~TActionDistributor

virtual ~ TActionDistributor ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TActionDistributor::Do

virtual void Do ()

Interface Category:

API.

Purpose:

Distributes the action. The default implementation does nothing and should be overridden by deriving classes.

Calling Context:

Called to distribute the action.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TActionDistributor::GetAction

TAction * GetAction () const

Interface Category:

API.

Purpose:

Returns the action adopted by this TActionDistributor.

Calling Context:

Called to obtain the action adopted by this TActionDistributor.

Parameters:

Takes no parameters.

Return Value:

Returns the action adopted by this TActionDistributor.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TActionDistributor::OrphanAction

TAction * OrphanAction ()

Interface Category:

API.

Purpose:

Orphans the action that was adopted by this TActionDistributor.

Calling Context:

Called to orphan the action that was adopted by this TActionDistributor.

Parameters:

Takes no parameters.

Return Value:

Returns a reference to the object that was orphaned.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TActionDistributor::SetActionHandled

void SetActionHandled ()

Interface Category:

API.

Purpose:

Sets this object's state to indicate that the action was handled.

Calling Context:

Called to indicate that this object's action has been handled.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TActionDistributor::IsActionHandled

bool IsActionHandled () const

Interface Category:

API.

Purpose:

Returns true if this object's action has been handled.

Calling Context:

Called to determine if this object's action has been handled.

Parameters:

Takes no parameters.

Return Value:

Returns true if this object's action has been handled.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.