RCommsMobilityApiExt Class Reference

#include <comms-infras/es_mobility_apiext.h>

class RCommsMobilityApiExt : public RCommsApiExtension< EMobilityApiExt >

Inherits from

  • RCommsMobilityApiExt

    Detailed Description

    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

    Constructor & Destructor Documentation

    RCommsMobilityApiExt ( )

    IMPORT_CRCommsMobilityApiExt()[explicit]

    Default empty constructor, and is present only to support virtual function table export.

    Member Function Documentation

    CancelMobilityNotification ( )

    IMPORT_C voidCancelMobilityNotification()

    Cancels previously requested subscription for Mobility notifications.

    Close ( )

    IMPORT_C voidClose()

    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.

    IgnorePreferredCarrier ( )

    IMPORT_C voidIgnorePreferredCarrier()

    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.

    MigrateToPreferredCarrier ( )

    IMPORT_C voidMigrateToPreferredCarrier()

    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).

    NewCarrierAccepted ( )

    IMPORT_C voidNewCarrierAccepted()

    Instructs the Implementation that the Client wishes to use the new carrier it has been migrated to.

    NewCarrierRejected ( )

    IMPORT_C voidNewCarrierRejected()

    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.

    RegisterForMobilityNotification ( TDes8 &, TRequestStatus & )

    IMPORT_C voidRegisterForMobilityNotification(TDes8 &aResponseEventBuf,
    TRequestStatus &aStatus
    )

    This API is used to register (subscribe) for Mobility notifications from the Implementation.

    ParameterDescription
    aResponseEventBufWill be filled with a corresponding response message before aStatus is completed.