CActiveCommsMobilityApiExt Class Reference

#include <comms-infras/es_mobility_apiext.h>

class CActiveCommsMobilityApiExt : public CActive

Inherits from

  • CActiveCommsMobilityApiExt
    Public Member Functions
    ~CActiveCommsMobilityApiExt()
    IMPORT_C voidIgnorePreferredCarrier()
    IMPORT_C voidMigrateToPreferredCarrier()
    IMPORT_C voidNewCarrierAccepted()
    IMPORT_C voidNewCarrierRejected()
    IMPORT_C CActiveCommsMobilityApiExt *NewL(RCommsSubSession &, MMobilityProtocolResp &)
    Protected Member Functions
    CActiveCommsMobilityApiExt(MMobilityProtocolResp &)
    voidConstructL(RCommsSubSession &)
    Inherited Attributes
    CActive::iStatus
    Inherited Enumerations
    CActive:TPriority
    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()

    Detailed Description

    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

    See also: RCommsMobilityApiExt

    Constructor & Destructor Documentation

    CActiveCommsMobilityApiExt ( MMobilityProtocolResp & )

    CActiveCommsMobilityApiExt(MMobilityProtocolResp &aProtocol)[protected, explicit]

    ~CActiveCommsMobilityApiExt ( )

    IMPORT_C~CActiveCommsMobilityApiExt()

    Cancels the outstanding notification request and deletes the Mobility extension.

    Member Function Documentation

    ConstructL ( RCommsSubSession & )

    voidConstructL(RCommsSubSession &aExtensionProvider)[protected]

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

    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.

    NewL ( RCommsSubSession &, MMobilityProtocolResp & )

    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.

    ParameterDescription
    aExtensionProviderThe corresponding RCommsSubSession under which the extension is to be opened (in case of Mobility this is the RConnection or RCommsManager instance).
    aProtocolHandles the response communication between the implementation and the client.
    © Nokia 2011.