CSmsuActiveBase Class Reference

#include <smsuact.h>

Link against: smsu.lib

class CSmsuActiveBase : public CActive, public CActive

Inherits from

CSmsuActiveBase
- CActive
  - CBase
- CActive
  - CBase

Protected Attributes
TRequestStatus *	iReport
CSmsuTimeout *	iSmsuTimeout

Public Member Functions
	~CSmsuActiveBase()

Protected Member Functions
	CSmsuActiveBase(TInt)
virtual IMPORT_C void	Complete(TInt)
IMPORT_C void	CompleteMyself(TInt, TBool)
IMPORT_C void	CompleteMyselfAfterTimeout(TInt)
IMPORT_C void	ConstructTimeoutL()
virtual void	DoComplete(TInt &)
pure virtual void	DoRunL()
IMPORT_C void	Queue(TRequestStatus &)
virtual IMPORT_C TInt	RunError(TInt)
virtual IMPORT_C void	RunL()
IMPORT_C TBool	TimedOut()
IMPORT_C void	TimedSetActive(const TTimeIntervalMicroSeconds32 &)
IMPORT_C void	TimedSetActiveCancel()

Inherited Attributes
	CActive::iStatus

Inherited Enumerations
	CActive:TPriority

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	CActive::DoCancel()
	CActive::Extension_(TUint,TAny &,TAny )
	CActive::IsActive()const
	CActive::IsAdded()const
	CActive::Priority()const
	CActive::SetActive()
	CActive::SetPriority(TInt)
	CActive::~CActive()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

Base class for SMS active objects.

Member Attribute Documentation

iReport

TRequestStatus *

iReport

[protected]

Observer, set by Queue().

iSmsuTimeout

CSmsuTimeout *

iSmsuTimeout

[protected]

Timer, to be activated by TimedSetActive().

Constructor & Destructor Documentation

CSmsuActiveBase ( TInt )

IMPORT_C

CSmsuActiveBase

(

TInt

aPriority

)

[protected]

Constructor.

Parameters
aPriority	Active object priority

Capability
None

~CSmsuActiveBase ( )

IMPORT_C

~CSmsuActiveBase

(

)

Destructor.

Capability
None

Member Function Documentation

Complete ( TInt )

IMPORT_C void

Complete

(

TInt

aStatus

)

[protected, virtual]

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
aStatus	Active object status word

Capability
None

CompleteMyself ( TInt, TBool )

IMPORT_C void	CompleteMyself	(	TInt	aStatus,
			TBool	aSetActive = ETrue
		)	[protected]

Signals this object.

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

Capability
None

CompleteMyselfAfterTimeout ( TInt )

IMPORT_C void

CompleteMyselfAfterTimeout

(

TInt

aStatus

)

[protected]

This function is used to request that the active object is completed after the current timeout is handled. When a timeout occurs, the active object is cancelled which requires DoCancel() to be called. However the object is active until after the DoCancel() meaning it is not possible to make a new request. This function requests a second call to Complete() (via RunL etc.) which is done without the object being active.

This function can only be called when a timeout occurs, otherwise it would not get actioned.

Parameters
aStatus	Status code with which to signal the object

Capability
None

ConstructTimeoutL ( )

IMPORT_C void

ConstructTimeoutL

(

)

[protected]

Constructs a timer.

This is required before use of TimedSetActive().

Capability
None

DoComplete ( TInt & )

void

DoComplete

(

TInt &

)

[protected, inline, virtual]

Implements derived-class specified Complete() behaviour.

This is called from Complete().

DoRunL ( )

void

DoRunL

(

)

[protected, pure virtual]

Implements derived-class specified RunL() behaviour.

This is called from RunL().

Queue ( TRequestStatus & )

IMPORT_C void

Queue

(

TRequestStatus &

aStatus

)

[protected]

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

Parameters
aStatus	Asynchronous status word of the observer

Capability
None

RunError ( TInt )

IMPORT_C TInt

RunError

(

TInt

aError

)

[protected, virtual]

Reimplemented from CActive::RunError(TInt)

Handles leaves occurring in the RunL() function.

It calls Complete().

Parameters
aError	RunL() leave code

Return Value: KErrNone

Capability
None

RunL ( )

IMPORT_C void

RunL

(

)

[protected, virtual]

Reimplemented from CActive::RunL()

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.

Capability
None

TimedOut ( )

IMPORT_C TBool

TimedOut

(

)

const [protected]

Determines if the object has timed out.

TimedSetActive ( const TTimeIntervalMicroSeconds32 & )

IMPORT_C void

TimedSetActive

(

const TTimeIntervalMicroSeconds32 &

aTimeIntervalMicroSeconds32

)

[protected]

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

Parameters
aTimeIntervalMicroSeconds32	Time after which to complete the object

Capability
None

TimedSetActiveCancel ( )

IMPORT_C void

TimedSetActiveCancel

(

)

[protected]

Cancels a TimedSetActive() request.