#include <comms-infras/es_mobility_apiext.h>
| class RCommsMobilityApiExt : public RCommsApiExtension< EMobilityApiExt > |
| Public Member Functions | |
|---|---|
| RCommsMobilityApiExt() | |
| IMPORT_C void | CancelMobilityNotification() |
| IMPORT_C void | Close() |
| IMPORT_C void | IgnorePreferredCarrier() |
| IMPORT_C void | MigrateToPreferredCarrier() |
| IMPORT_C void | NewCarrierAccepted() |
| IMPORT_C void | NewCarrierRejected() |
| IMPORT_C void | RegisterForMobilityNotification(TDes8 &, TRequestStatus &) |
| Inherited Attributes | |
|---|---|
| RCommsApiExtensionBase::iInterfaceId | |
| RCommsApiExtensionBase::iProvider | |
| Inherited Functions | |
|---|---|
| RCommsApiExtension< EMobilityApiExt >::Open(RCommsSession &) | |
| RCommsApiExtension< EMobilityApiExt >::Open(RCommsSubSession &) | |
| RCommsApiExtensionBase::Open(RCommsSession &,TSupportedCommsApiExt) | |
| RCommsApiExtensionBase::Open(RCommsSubSession &,TSupportedCommsApiExt) | |
| RCommsApiExtensionBase::RCommsApiExtensionBase() | |
| RCommsApiExtensionBase::SendMessage(TCommsApiExtReqMsg &) | |
| RCommsApiExtensionBase::SendRequest(TCommsApiExtReqMsg &,TDes8 &,TRequestStatus &) | |
Comms Mobility API extension for client not running an Active Scheduler.
This class can actually be used by any client, one running an Active Scheduler and one that is not. However, if the Active Scheduler is present, it is recommended to use CActiveCommsMobilityApiExt which is much simpler.
See also: CActiveCommsMobilityApiExt
| IMPORT_C | RCommsMobilityApiExt | ( | ) | [explicit] |
Default empty constructor, and is present only to support virtual function table export.
| IMPORT_C void | CancelMobilityNotification | ( | ) |
Cancels previously requested subscription for Mobility notifications.
| IMPORT_C void | Close | ( | ) |
Reimplemented from RCommsApiExtensionBase::Close()
Closes the extension after it has been used. It is not possible to use an extension after it has been closed.
| 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 | ( | ) |
Instructs the Implementation that the Client wishes to reject the new carrier it has been migrated to and be offered another preferred carrier unless nothing else is available. In case nothing else is available the request completes with an error.
| IMPORT_C void | RegisterForMobilityNotification | ( | TDes8 & | aResponseEventBuf, |
| TRequestStatus & | aStatus | |||
| ) | ||||
This API is used to register (subscribe) for Mobility notifications from the Implementation.
| Parameters | |
|---|---|
| aResponseEventBuf | Will be filled with a corresponding response message before aStatus is completed. |