| 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
| Public Member Functions | |
|---|---|
| ~CActiveCommsMobilityApiExt() | |
| IMPORT_C void | IgnorePreferredCarrier() |
| IMPORT_C void | MigrateToPreferredCarrier() |
| IMPORT_C void | NewCarrierAccepted() |
| IMPORT_C void | NewCarrierRejected() |
| IMPORT_C CActiveCommsMobilityApiExt * | NewL(RCommsSubSession &, MMobilityProtocolResp &) |
| Protected Member Functions | |
|---|---|
| CActiveCommsMobilityApiExt(MMobilityProtocolResp &) | |
| void | ConstructL(RCommsSubSession &) |
| Private Member Functions | |
|---|---|
| void | DoCancel() |
| TInt | RunError(TInt) |
| void | RunL() |
| Inherited Enumerations | |
|---|---|
| CActive:TPriority | |
| Private Attributes | |
|---|---|
| RCommsMobilityApiExt | iExtApi |
| MMobilityProtocolResp & | iProtocol |
| RBuf8 | iResponseBuf |
| Inherited Attributes | |
|---|---|
| CActive::iStatus | |
| CActiveCommsMobilityApiExt | ( | MMobilityProtocolResp & | aProtocol | ) | [protected, explicit] |
| MMobilityProtocolResp & aProtocol |
| IMPORT_C | ~CActiveCommsMobilityApiExt | ( | ) |
Cancels the outstanding notification request and deletes the Mobility extension.
| void | ConstructL | ( | RCommsSubSession & | aExtensionProvider | ) | [protected] |
| RCommsSubSession & aExtensionProvider |
| void | DoCancel | ( | ) | [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().
| IMPORT_C void | IgnorePreferredCarrier | ( | ) |
Instructs the Implementation that it should not migrate the Client to the newly available preferred carrier and that the Client wishes to continue using the current carrier.
| IMPORT_C void | MigrateToPreferredCarrier | ( | ) |
Instructs the Implementation that it should migrate the Client to the newly available preferred carrier (or, in case of the current carrier becoming unavailable, to the less preferred but available carrier).
| IMPORT_C void | NewCarrierAccepted | ( | ) |
Instructs the Implementation that the Client wishes to use the new carrier it has been migrated to.
| IMPORT_C void | NewCarrierRejected | ( | ) |
Instruct the Implementation that the Client wishes to reject the new carrier it has been migrated to be offered another preferred carrier unless nothing else is available. In case nothing else is available the request completes with an error.
| IMPORT_C CActiveCommsMobilityApiExt * | NewL | ( | RCommsSubSession & | aExtensionProvider, |
| MMobilityProtocolResp & | aProtocol | |||
| ) | [static] | |||
This call is used to construct the Mobility extension, initialised with the MMobilityProtocolResp implementation provided as a parameter. MMobilityProtocolResp implementation is used when a Mobility notification arrives to the Client and is being dispatched on one of the call back APIs of MMobilityProtocolResp.
| RCommsSubSession & aExtensionProvider | The corresponding RCommsSubSession under which the extension is to be opened (in case of Mobility this is the RConnection or RCommsManager instance). |
| MMobilityProtocolResp & aProtocol | Handles the response communication between the implementation and the client. |
| void | RunL | ( | ) | [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
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.