CActiveCommsMobilityApiExt Class Reference

class CActiveCommsMobilityApiExt : public CActive

Comms Mobility API extension for client running an Active Scheduler.. Whenever an Active Scheduler is present, this API is recommended over RCommsMobilityApiExt because of its simplicity.

With few important exceptions, CActiveCommsMobilityApiExt exports very similar APIs to RCommsMobilityApiExt

RCommsMobilityApiExt

Inherits from

Constructor & Destructor Documentation

CActiveCommsMobilityApiExt(MMobilityProtocolResp &)

CActiveCommsMobilityApiExt(MMobilityProtocolResp &aProtocol)[protected, explicit]

Parameters

MMobilityProtocolResp & aProtocol

~CActiveCommsMobilityApiExt()

IMPORT_C~CActiveCommsMobilityApiExt()

Member Functions Documentation

ConstructL(RCommsSubSession &)

voidConstructL(RCommsSubSession &aExtensionProvider)[protected]

Parameters

RCommsSubSession & aExtensionProvider

DoCancel()

voidDoCancel()[private, virtual]

Implements cancellation of an outstanding request.

This function is called as part of the active object's Cancel().

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

DoCancel() must not wait for event completion; this is handled by Cancel().

CActive::Cancel

IgnorePreferredCarrier()

IMPORT_C voidIgnorePreferredCarrier()

MigrateToPreferredCarrier()

IMPORT_C voidMigrateToPreferredCarrier()

NewCarrierAccepted()

IMPORT_C voidNewCarrierAccepted()

NewCarrierRejected()

IMPORT_C voidNewCarrierRejected()

NewL(RCommsSubSession &, MMobilityProtocolResp &)

IMPORT_C CActiveCommsMobilityApiExt *NewL(RCommsSubSession &aExtensionProvider,
MMobilityProtocolResp &aProtocol
)[static]

Parameters

RCommsSubSession & aExtensionProvider
MMobilityProtocolResp & aProtocol

RunError(TInt)

TInt RunError(TIntaError)[private, virtual]

Parameters

TInt aError

RunL()

voidRunL()[private, virtual]

Handles an active object's request completion event.

A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.

The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest() function completes.

Before calling this active object's RunL() function, the active scheduler has:

1. decided that this is the highest priority active object with a completed request

2. marked this active object's request as complete (i.e. the request is no longer outstanding)

RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls RunError() to handle the leave.

Note that once the active scheduler's Start() function has been called, all user code is run under one of the program's active object's RunL() or RunError() functions.

CActiveScheduler::Start

CActiveScheduler::Error

CActiveScheduler::WaitForAnyRequest

TRAPD

Member Data Documentation

RCommsMobilityApiExt iExtApi

RCommsMobilityApiExt iExtApi[private]

MMobilityProtocolResp & iProtocol

MMobilityProtocolResp &iProtocol[private]

RBuf8 iResponseBuf

RBuf8 iResponseBuf[private]