Collapse all Symbian^3 Product Developer Library

CBTEngActive Class Reference

class CBTEngActive : public CActive

?more_complete_description

bteng*.lib

Since: S60 v3.2

Inherits from

CBTEngActive
- CActive
  - CBase

Public Member Functions
	~CBTEngActive()
void	CancelRequest()
void	DoCancel()
void	GoActive()
CBTEngActive *	NewL(MBTEngActiveObserver &, TInt, TInt)
TInt	RequestId()
TRequestStatus &	RequestStatus()
TInt	RunError(TInt)
void	RunL()
void	SetRequestId(TInt)

Private Member Functions
	CBTEngActive(MBTEngActiveObserver &, TInt, TInt)
void	ConstructL()

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	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()

Inherited Enumerations
	CActive:TPriority

Private Attributes
MBTEngActiveObserver &	iObserver
TInt	iRequestId

Inherited Attributes
	CActive::iStatus

Constructor & Destructor Documentation

CBTEngActive(MBTEngActiveObserver &, TInt, TInt)

CBTEngActive	(	MBTEngActiveObserver &	aObserver,
		TInt	aId,
		TInt	aPriority
	)	[private, inline]

C++ default constructor

Since: S60 v3.2

Parameters

MBTEngActiveObserver & aObserver	Pointer to callback interface that receives notification that the request has been completed.
TInt aId	ID of the request (for the client to keep track of multiple active objects).
TInt aPriority	Priority of

~CBTEngActive()

~CBTEngActive

(

)

[inline, virtual]

Destructor

Member Functions Documentation

CancelRequest()

void

CancelRequest

(

)

[inline]

Cancel an outstanding request.

Since: S60 v3.2

ConstructL()

void

ConstructL

(

)

[private, inline]

Symbian 2nd-phase constructor

Since: S60 v3.2

DoCancel()

void

DoCancel

(

)

[inline, virtual]

From CActive. Called by the active scheduler when the request has been cancelled.

Since: S60 v3.2

GoActive()

void

GoActive

(

)

[inline]

Activate the active object.

Since: S60 v3.2

NewL(MBTEngActiveObserver &, TInt, TInt)

CBTEngActive *	NewL	(	MBTEngActiveObserver &	aObserver,
			TInt	aId,
			TInt	aPriority = CActive::EPriorityStandard
		)	[static, inline]

Two-phase constructor

Since: S60 v3.2

Parameters

MBTEngActiveObserver & aObserver	Pointer to callback interface that receives notification that the request has been completed.
TInt aId	Identifier for the CBTEngActive instance.
TInt aPriority = CActive::EPriorityStandard	The priority of the active object.

RequestId()

TInt

RequestId

(

)

[inline]

Get the request ID of this active object.

Since: S60 v3.2

RequestStatus()

TRequestStatus &

RequestStatus

(

)

[inline]

Get a reference to the active object request status.

Since: S60 v3.2

RunError(TInt)

TInt

RunError

(

TInt

aError

)

[inline, virtual]

From CActive. Called by the active scheduler when an error in RunL has occurred.

Since: S60 v3.2

Parameters

TInt aError

RunL()

void

RunL

(

)

[inline, virtual]

From CActive. Called by the active scheduler when the request has been completed.

Since: S60 v3.2

SetRequestId(TInt)

void

SetRequestId

(

TInt

aId

)

[inline]

Set a new request ID for this active object.

Since: S60 v3.2

Parameters

TInt aId

Member Data Documentation

MBTEngActiveObserver & iObserver

MBTEngActiveObserver &

iObserver

[private]

Our observer. Not own.

TInt iRequestId

TInt

iRequestId

[private]

ID of the request (used only by our client).