Class CSmsuActiveBase

class CSmsuActiveBase : public CActive;

Description

Base class for SMS active objects.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CActive - The core class of the active object abstraction

• CSmsuActiveBase - Base class for SMS active objects

Members

Defined in CSmsuActiveBase:
CSmsuActiveBase(), Complete(), CompleteMyself(), ConstructTimeoutL(), DoComplete(), DoRunL(), Queue(), RunError(), RunL(), TimedSetActive(), iReport, iSmsuTimeout, ~CSmsuActiveBase()

Inherited from CActive:
Cancel(), Deque(), DoCancel(), EPriorityHigh, EPriorityIdle, EPriorityLow, EPriorityStandard, EPriorityUserInput, Extension_(), IsActive(), IsAdded(), Priority(), SetActive(), SetPriority(), TPriority, iStatus

Inherited from CBase:
Delete(), operator new()

Capability:

Illegal

IMPORT_C ~CSmsuActiveBase();

Description

Destructor.

Capability:

Illegal

protected: IMPORT_C CSmsuActiveBase(TInt aPriority);

Description

Constructor.

Parameters

TInt aPriority Active object priority

Capability:

Illegal

protected: virtual IMPORT_C void Complete(TInt aStatus);

Description

Object use complete.

This is called at the end of the RunL(), if the RunL() has not reset the object to be active.

If an observer has been set (see Queue()), DoComplete() is called, and that observer is signalled with the object status.

Parameters

TInt aStatus Active object status word

Capability:

Illegal

protected: IMPORT_C void CompleteMyself(TInt aStatus, TBool aSetActive=ETrue);

Description

Signals this object.

Parameters

TInt aStatus Status code with which to signal the object TBool aSetActive True to set the object to be active

Capability:

Illegal

protected: IMPORT_C void TimedSetActive(const TTimeIntervalMicroSeconds32 &aTimeIntervalMicroSeconds32);

Description

Activates the object, and sets it to be completed after a specified time.

Parameters

const TTimeIntervalMicroSeconds32 &aTimeIntervalMicroSeconds32 Time after which to complete the object

Capability:

Illegal

protected: IMPORT_C void ConstructTimeoutL();

Description

Constructs a timer.

This is required before use of TimedSetActive().

Capability:

Illegal

protected: IMPORT_C void Queue(TRequestStatus &aStatus);

Description

Sets an asynchronous observer to which to report completion of this object.

Parameters

TRequestStatus &aStatus Asynchronous status word of the observer

Capability:

Illegal

protected: virtual IMPORT_C TInt RunError(TInt aError);

Description

Calls complete.

Handles leaves occurring in the RunL() function.

It calls Complete().

Parameters

TInt aError RunL() leave code

Return value

TInt KErrNone

protected: virtual void DoRunL()=0;

Description

Implements derived-class specified RunL() behaviour.

This is called from RunL().

protected: inline virtual void DoComplete(TInt &);

Description

Implements derived-class specified Complete() behaviour.

This is called from Complete().

Parameters

TInt &

Capability:

Illegal

protected: virtual IMPORT_C void RunL();

Description

Handles the object's request completion event.

If a timer has been set with TimedSetActive(), this is cancelled. DoRunL() is then called. If, after this, the object is not active, Complete() is called.

protected: CSmsuTimeout * iSmsuTimeout;

Description

Timer, to be activated by TimedSetActive().

protected: TRequestStatus * iReport;

Description

Observer, set by Queue().