Symbian^3 Product Developer Library >

RMPM Class Reference

class RMPM : public RSessionBase

Mobility Policy Manager server client interface.

RMPM.lib
Since
3.0

Inherits from

Public Member Functions
RMPM()
IMPORT_C TIntApplicationAcceptedTheCarrier(const TUint32, const TConnectionId)
IMPORT_C voidApplicationAcceptedTheCarrier(const TUint32, const TConnectionId, TRequestStatus &)
IMPORT_C TIntApplicationConnectionEnds(const TConnectionId)
IMPORT_C voidApplicationConnectionEnds(const TConnectionId, TRequestStatus &)
IMPORT_C TIntApplicationIgnoredTheCarrier(const TUint32, const TConnectionId)
IMPORT_C voidApplicationIgnoredTheCarrier(const TUint32, const TConnectionId, TRequestStatus &)
IMPORT_C TIntApplicationJoinsConnection(const TUint32, const TConnectionId)
IMPORT_C voidApplicationJoinsConnection(const TUint32, const TConnectionId, TRequestStatus &)
IMPORT_C TIntApplicationLeavesConnection(const TUint32, const TConnectionId)
IMPORT_C voidApplicationLeavesConnection(const TUint32, const TConnectionId, TRequestStatus &)
IMPORT_C TIntApplicationMigratesToCarrier(const TUint32, const TConnectionId)
IMPORT_C voidApplicationMigratesToCarrier(const TUint32, const TConnectionId, TRequestStatus &)
IMPORT_C TIntApplicationRejectedTheCarrier(const TUint32, const TConnectionId)
IMPORT_C voidApplicationRejectedTheCarrier(const TUint32, const TConnectionId, TRequestStatus &)
IMPORT_C voidCancel(TMpmAsynchCodes)
IMPORT_C voidChooseBestIAP(TConnPref &, const TConnectionId, const TUid, TConnPref &, TRequestStatus &)
IMPORT_C voidClose()
IMPORT_C TIntConnect()
IMPORT_C voidConnect(TRequestStatus &)
IMPORT_C TBoolConnected()
IMPORT_C TIntEasyWlanSsid(const TWlanSsid &)
IMPORT_C TIntIAPConnectionActivated(const TUint32, const TConnectionId)
IMPORT_C TIntIAPConnectionStarted(const TUint32, const TConnectionId)
IMPORT_C voidIAPConnectionStarted(const TUint32, const TConnectionId, TRequestStatus &)
IMPORT_C TIntIAPConnectionStopped(const TUint32, const TConnectionId)
IMPORT_C voidIAPConnectionStopped(const TUint32, const TConnectionId, TRequestStatus &)
IMPORT_C TIntLaunchServer()
IMPORT_C voidProcessError(TInt &, const TConnectionId, TBMNeededAction &, TRequestStatus &)
IMPORT_C voidProcessError(TConnPref &, TInt &, const TConnectionId, TBMNeededAction &, TRequestStatus &)
IMPORT_C TIntRegisterPrefIAPNotif(const TConnectionId)
IMPORT_C voidRegisterPrefIAPNotif(const TConnectionId, TRequestStatus &)
IMPORT_C TIntRegisterPrefIAPNotif(const TConnPref &, const TConnectionId)
IMPORT_C voidReselectBestIAP(const TConnectionId, TConnPref &, TRequestStatus &)
IMPORT_C TIntSendCancelRequest(TMpmAsynchCodes)
IMPORT_C TIntSortSNAP(const TUint32, TMpmSnapBuffer &)
IMPORT_C voidSortSNAP(const TUint32, TMpmSnapBuffer &, TRequestStatus &, const TUint32)
IMPORT_C voidUnregisterPrefIAPNotif(const TConnectionId)
IMPORT_C voidUnregisterPrefIAPNotif(const TConnectionId, TRequestStatus &)
IMPORT_C TVersionVersion()
IMPORT_C voidWaitNotification(TMPMMessageBuffer &, TRequestStatus &)
Private Member Functions
TPtr8 &NextPtr()
Inherited Functions
RHandleBase::Attributes()const
RHandleBase::BTraceId()const
RHandleBase::DoExtendedClose()
RHandleBase::Duplicate(const RThread &,TOwnerType)
RHandleBase::FullName()const
RHandleBase::FullName(TDes &)const
RHandleBase::Handle()const
RHandleBase::HandleInfo(THandleInfo *)
RHandleBase::Name()const
RHandleBase::NotifyDestruction(TRequestStatus &)
RHandleBase::Open(const TFindHandleBase &,TOwnerType)
RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
RHandleBase::RHandleBase()
RHandleBase::RHandleBase(TInt)
RHandleBase::SetHandle(TInt)
RHandleBase::SetHandleNC(TInt)
RSessionBase::CreateSession(RServer2,const TVersion &)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Open(TInt,TOwnerType)
RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Send(TInt)const
RSessionBase::Send(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt)const
RSessionBase::SendReceive(TInt,TRequestStatus &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSessionBase::SetReturnedHandle(TInt)
RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
RSessionBase::ShareAuto()
RSessionBase::ShareProtected()
Inherited Enumerations
RHandleBase:TAttributes
RSessionBase:TAttachMode
Private Attributes
TBool iConnected
TInt iIndex
RArray< TPtr8 >iPtrArray
Inherited Attributes
RHandleBase::iHandle

Constructor & Destructor Documentation

RMPM()

RMPM()[inline]

Member Functions Documentation

ApplicationAcceptedTheCarrier(const TUint32, const TConnectionId)

IMPORT_C TIntApplicationAcceptedTheCarrier(const TUint32aIapId,
const TConnectionIdaConnId
)
Application accepted the carrier.
Since
3.2

Parameters

const TUint32 aIapIdIAP Id of the new carrier.
const TConnectionId aConnIdConnection Id

ApplicationAcceptedTheCarrier(const TUint32, const TConnectionId, TRequestStatus &)

IMPORT_C voidApplicationAcceptedTheCarrier(const TUint32aIapId,
const TConnectionIdaConnId,
TRequestStatus &aStatus
)
Application accpeted the carrier.
Since
3.2

Parameters

const TUint32 aIapIdIAP Id of the accepted carrier.
const TConnectionId aConnIdConnection Id
TRequestStatus & aStatusKErrNone if successful, otherwise one of the system-wide error codes

ApplicationConnectionEnds(const TConnectionId)

IMPORT_C TIntApplicationConnectionEnds(const TConnectionIdaConnId)
Application connection ends.
Since
3.2

Parameters

const TConnectionId aConnIdConnection Id

ApplicationConnectionEnds(const TConnectionId, TRequestStatus &)

IMPORT_C voidApplicationConnectionEnds(const TConnectionIdaConnId,
TRequestStatus &aStatus
)
Application connection ends.
Since
5.2

Parameters

const TConnectionId aConnIdConnection Id
TRequestStatus & aStatusKErrNone if successful, otherwise one of the system-wide error codes

ApplicationIgnoredTheCarrier(const TUint32, const TConnectionId)

IMPORT_C TIntApplicationIgnoredTheCarrier(const TUint32aIapId,
const TConnectionIdaConnId
)
Application ignored the carrier.
Since
3.2

Parameters

const TUint32 aIapIdIAP Id of the new carrier.
const TConnectionId aConnIdConnection Id

ApplicationIgnoredTheCarrier(const TUint32, const TConnectionId, TRequestStatus &)

IMPORT_C voidApplicationIgnoredTheCarrier(const TUint32aIapId,
const TConnectionIdaConnId,
TRequestStatus &aStatus
)
Application ignored the carrier.
Since
3.2

Parameters

const TUint32 aIapIdIAP Id of the new carrier.
const TConnectionId aConnIdConnection Id
TRequestStatus & aStatusKErrNone if successful, otherwise one of the system-wide error codes

ApplicationJoinsConnection(const TUint32, const TConnectionId)

IMPORT_C TIntApplicationJoinsConnection(const TUint32aIapId,
const TConnectionIdaConnId
)
Application joins connection.
Since
3.2

Parameters

const TUint32 aIapIdIAP Id of the connection.
const TConnectionId aConnIdConnection Id

ApplicationJoinsConnection(const TUint32, const TConnectionId, TRequestStatus &)

IMPORT_C voidApplicationJoinsConnection(const TUint32aIapId,
const TConnectionIdaConnId,
TRequestStatus &aStatus
)
Application joins connection.
Since
5.2

Parameters

const TUint32 aIapIdIAP Id of the connection.
const TConnectionId aConnIdConnection Id
TRequestStatus & aStatusKErrNone if successful, otherwise one of the system-wide error codes

ApplicationLeavesConnection(const TUint32, const TConnectionId)

IMPORT_C TIntApplicationLeavesConnection(const TUint32aIapId,
const TConnectionIdaConnId
)
Application leaves connection.
Since
3.1

Parameters

const TUint32 aIapIdIAP Id of the connection.
const TConnectionId aConnIdConnection Id

ApplicationLeavesConnection(const TUint32, const TConnectionId, TRequestStatus &)

IMPORT_C voidApplicationLeavesConnection(const TUint32aIapId,
const TConnectionIdaConnId,
TRequestStatus &aStatus
)
Application leaves connection.
Since
5.2

Parameters

const TUint32 aIapIdIAP Id of the connection.
const TConnectionId aConnIdConnection Id
TRequestStatus & aStatusKErrNone if successful, otherwise one of the system-wide error codes

ApplicationMigratesToCarrier(const TUint32, const TConnectionId)

IMPORT_C TIntApplicationMigratesToCarrier(const TUint32aIapId,
const TConnectionIdaConnId
)
Application migrates to carrier.
Since
3.2

Parameters

const TUint32 aIapIdIAP Id of the new carrier.
const TConnectionId aConnIdConnection Id

ApplicationMigratesToCarrier(const TUint32, const TConnectionId, TRequestStatus &)

IMPORT_C voidApplicationMigratesToCarrier(const TUint32aIapId,
const TConnectionIdaConnId,
TRequestStatus &aStatus
)
Application migrates to carrier.
Since
3.2

Parameters

const TUint32 aIapIdIAP Id of the new carrier.
const TConnectionId aConnIdConnection Id
TRequestStatus & aStatusKErrNone if successful, otherwise one of the system-wide error codes

ApplicationRejectedTheCarrier(const TUint32, const TConnectionId)

IMPORT_C TIntApplicationRejectedTheCarrier(const TUint32aIapId,
const TConnectionIdaConnId
)
Application rejected the carrier.
Since
3.2

Parameters

const TUint32 aIapIdIAP Id of the new carrier.
const TConnectionId aConnIdConnection Id

ApplicationRejectedTheCarrier(const TUint32, const TConnectionId, TRequestStatus &)

IMPORT_C voidApplicationRejectedTheCarrier(const TUint32aIapId,
const TConnectionIdaConnId,
TRequestStatus &aStatus
)
Application rejected the carrier.
Since
3.2

Parameters

const TUint32 aIapIdIAP Id of the rejected carrier.
const TConnectionId aConnIdConnection Id
TRequestStatus & aStatusKErrNone if successful, otherwise one of the system-wide error codes

Cancel(TMpmAsynchCodes)

IMPORT_C voidCancel(TMpmAsynchCodesaReqToCancel)const
Cancels asynchronous request. In the risk of deadlock use the SendCancelRequest()
Since
3.1

Parameters

TMpmAsynchCodes aReqToCancelrequest to be canceled

ChooseBestIAP(TConnPref &, const TConnectionId, const TUid, TConnPref &, TRequestStatus &)

IMPORT_C voidChooseBestIAP(TConnPref &aConnPref,
const TConnectionIdaConnId,
const TUidaAppUid,
TConnPref &aPolicyPref,
TRequestStatus &aStatus
)
Initial select of the most prefered IAP for the connection.
Since
3.1

Parameters

TConnPref & aConnPrefConnection preferences from application
const TConnectionId aConnIdConnection Id
const TUid aAppUidApplication UId
TConnPref & aPolicyPrefConnection preferences chosen by MPM
TRequestStatus & aStatusKErrNone if successful, otherwise one of the system-wide error codes

Close()

IMPORT_C voidClose()
Closes MPM server session.
Since
3.0

Connect()

IMPORT_C TIntConnect()
Connects client to a server session. It must be called before using other session specific methods.
Since
3.0

Connect(TRequestStatus &)

IMPORT_C voidConnect(TRequestStatus &aStatus)
Connects client to a server session. It must be called before using other session specific methods.
Since
5.2

Parameters

TRequestStatus & aStatus

Connected()

IMPORT_C TBoolConnected()
Queries whether MPM is connected.
Since
5.2

EasyWlanSsid(const TWlanSsid &)

IMPORT_C TIntEasyWlanSsid(const TWlanSsid &aSSID)
Displays connecting wait note for Easy WLAN connection.
Since
3.2

Parameters

const TWlanSsid & aSSIDthe id of selected wlan network

IAPConnectionActivated(const TUint32, const TConnectionId)

IMPORT_C TIntIAPConnectionActivated(const TUint32aIapId,
const TConnectionIdaConnId
)
The whole IAP connection is activated.
Since
3.2

Parameters

const TUint32 aIapIdIAP Id of the connection.
const TConnectionId aConnIdConnection Id

IAPConnectionStarted(const TUint32, const TConnectionId)

IMPORT_C TIntIAPConnectionStarted(const TUint32aIapId,
const TConnectionIdaConnId
)
The whole IAP connection is started.
Since
3.2

Parameters

const TUint32 aIapIdIAP Id of the connection.
const TConnectionId aConnIdConnection Id

IAPConnectionStarted(const TUint32, const TConnectionId, TRequestStatus &)

IMPORT_C voidIAPConnectionStarted(const TUint32aIapId,
const TConnectionIdaConnId,
TRequestStatus &aStatus
)
The whole IAP connection is started.
Since
5.2

Parameters

const TUint32 aIapIdIAP Id of the connection.
const TConnectionId aConnIdConnection Id
TRequestStatus & aStatusKErrNone if successful, otherwise one of the system-wide error codes

IAPConnectionStopped(const TUint32, const TConnectionId)

IMPORT_C TIntIAPConnectionStopped(const TUint32aIapId,
const TConnectionIdaConnId
)
The whole IAP connection is stopped.
Since
3.1

Parameters

const TUint32 aIapIdIAP Id of the connection.
const TConnectionId aConnIdConnection Id

IAPConnectionStopped(const TUint32, const TConnectionId, TRequestStatus &)

IMPORT_C voidIAPConnectionStopped(const TUint32aIapId,
const TConnectionIdaConnId,
TRequestStatus &aStatus
)
The whole IAP connection is stopped.
Since
5.2

Parameters

const TUint32 aIapIdIAP Id of the connection.
const TConnectionId aConnIdConnection Id
TRequestStatus & aStatusKErrNone if successful, otherwise one of the system-wide error codes

LaunchServer()

IMPORT_C TIntLaunchServer()
Deprecated, doesn't do anything
Since
3.0

NextPtr()

TPtr8 &NextPtr()[private]

ProcessError(TInt &, const TConnectionId, TBMNeededAction &, TRequestStatus &)

IMPORT_C voidProcessError(TInt &aError,
const TConnectionIdaConnId,
TBMNeededAction &aNeededAction,
TRequestStatus &aStatus
)
Error processing of connection initiation.
Since
3.1

Parameters

TInt & aErrorError code
const TConnectionId aConnIdConnection Id
TBMNeededAction & aNeededActionIgnore error, propagate error or perform a reselection
TRequestStatus & aStatusKErrNone if successful, otherwise one of the system-wide error codes

ProcessError(TConnPref &, TInt &, const TConnectionId, TBMNeededAction &, TRequestStatus &)

IMPORT_C voidProcessError(TConnPref &aConnPref,
TInt &aError,
const TConnectionIdaConnId,
TBMNeededAction &aNeededAction,
TRequestStatus &aStatus
)
Error processing of connection initiation. In 5.2, aConnPref not required.
Since
3.1

Parameters

TConnPref & aConnPrefConnection preferences
TInt & aErrorError code
const TConnectionId aConnIdConnection Id
TBMNeededAction & aNeededActionIgnore error, propagate error or perform a reselection
TRequestStatus & aStatusKErrNone if successful, otherwise one of the system-wide error codes

RegisterPrefIAPNotif(const TConnectionId)

IMPORT_C TIntRegisterPrefIAPNotif(const TConnectionIdaConnId)
Register for getting preferred IAP notifications.
Since
3.1

Parameters

const TConnectionId aConnIdConnection Id

RegisterPrefIAPNotif(const TConnectionId, TRequestStatus &)

IMPORT_C voidRegisterPrefIAPNotif(const TConnectionIdaConnId,
TRequestStatus &aStatus
)
Register for getting preferred IAP notifications.
Since
5.2

Parameters

const TConnectionId aConnIdConnection Id
TRequestStatus & aStatusKErrNone if successful, otherwise one of the system-wide error codes

RegisterPrefIAPNotif(const TConnPref &, const TConnectionId)

IMPORT_C TIntRegisterPrefIAPNotif(const TConnPref &aConnPref,
const TConnectionIdaConnId
)
Register for getting preferred IAP notifications. In 5.2, aConnPref not required.
Since
3.1

Parameters

const TConnPref & aConnPrefConnection preferences
const TConnectionId aConnIdConnection Id

ReselectBestIAP(const TConnectionId, TConnPref &, TRequestStatus &)

IMPORT_C voidReselectBestIAP(const TConnectionIdaConnId,
TConnPref &aPolicyPref,
TRequestStatus &aStatus
)
Re-selectBestIAP. Same as ChooseBestIAP but can be called multiple times. resubmit of
Since
5.2

Parameters

const TConnectionId aConnIdConnection Id
TConnPref & aPolicyPrefConnection preferences chosen by MPM
TRequestStatus & aStatusKErrNone if successful, otherwise one of the system-wide error codes

SendCancelRequest(TMpmAsynchCodes)

IMPORT_C TIntSendCancelRequest(TMpmAsynchCodesaReqToCancel)const
Asynchronous cancellation
Since
5.2

Parameters

TMpmAsynchCodes aReqToCancelrequest to be canceled

SortSNAP(const TUint32, TMpmSnapBuffer &)

IMPORT_C TIntSortSNAP(const TUint32aSNAP,
TMpmSnapBuffer &aSortedList
)
Sort available IAPs belonging to the specified SNAP.
Since
3.2

Parameters

const TUint32 aSNAPService Network Access Point
TMpmSnapBuffer & aSortedListon return contains the sorted list of IAPs

SortSNAP(const TUint32, TMpmSnapBuffer &, TRequestStatus &, const TUint32)

IMPORT_C voidSortSNAP(const TUint32aSNAP,
TMpmSnapBuffer &aSortedList,
TRequestStatus &aStatus,
const TUint32aMaxAgeSeconds = 5
)
Asynchronously sort available IAPs belonging to the specified SNAP.
Since
5.2

Parameters

const TUint32 aSNAPService Network Access Point
TMpmSnapBuffer & aSortedListon return contains the sorted list of IAPs
TRequestStatus & aStatusKErrNone if successful, otherwise one of the system-wide error codes
const TUint32 aMaxAgeSeconds = 5how many seconds old availability data MPM is allowed to use for priorization.

UnregisterPrefIAPNotif(const TConnectionId)

IMPORT_C voidUnregisterPrefIAPNotif(const TConnectionIdaConnId)
Unregister preferred IAP notifications.
Since
3.1

Parameters

const TConnectionId aConnIdConnection Id

UnregisterPrefIAPNotif(const TConnectionId, TRequestStatus &)

IMPORT_C voidUnregisterPrefIAPNotif(const TConnectionIdaConnId,
TRequestStatus &aStatus
)
Unregister preferred IAP notifications.
Since
5.2

Parameters

const TConnectionId aConnIdConnection Id
TRequestStatus & aStatus

Version()

IMPORT_C TVersionVersion()const
Returns MPM server version.
Since
3.0

WaitNotification(TMPMMessageBuffer &, TRequestStatus &)

IMPORT_C voidWaitNotification(TMPMMessageBuffer &aMpmNotification,
TRequestStatus &aStatus
)
Bearer manager provides message buffer for MPM notifications, must be called before registering for notifications.
Since
3.1

Parameters

TMPMMessageBuffer & aMpmNotificationnotification for BM
TRequestStatus & aStatusKErrNone if successful, otherwise one of the system-wide error codes

Member Data Documentation

TBool iConnected

TBool iConnected[private]

TInt iIndex

TInt iIndex[private]

RArray< TPtr8 > iPtrArray

RArray< TPtr8 >iPtrArray[private]

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.