Symbian^3 Application 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 TInt ApplicationAcceptedTheCarrier (const TUint32 , const TConnectionId )
IMPORT_C void ApplicationAcceptedTheCarrier (const TUint32 , const TConnectionId , TRequestStatus &)
IMPORT_C TInt ApplicationConnectionEnds (const TConnectionId )
IMPORT_C void ApplicationConnectionEnds (const TConnectionId , TRequestStatus &)
IMPORT_C TInt ApplicationIgnoredTheCarrier (const TUint32 , const TConnectionId )
IMPORT_C void ApplicationIgnoredTheCarrier (const TUint32 , const TConnectionId , TRequestStatus &)
IMPORT_C TInt ApplicationJoinsConnection (const TUint32 , const TConnectionId )
IMPORT_C void ApplicationJoinsConnection (const TUint32 , const TConnectionId , TRequestStatus &)
IMPORT_C TInt ApplicationLeavesConnection (const TUint32 , const TConnectionId )
IMPORT_C void ApplicationLeavesConnection (const TUint32 , const TConnectionId , TRequestStatus &)
IMPORT_C TInt ApplicationMigratesToCarrier (const TUint32 , const TConnectionId )
IMPORT_C void ApplicationMigratesToCarrier (const TUint32 , const TConnectionId , TRequestStatus &)
IMPORT_C TInt ApplicationRejectedTheCarrier (const TUint32 , const TConnectionId )
IMPORT_C void ApplicationRejectedTheCarrier (const TUint32 , const TConnectionId , TRequestStatus &)
IMPORT_C void Cancel ( TMpmAsynchCodes )
IMPORT_C void ChooseBestIAP ( TConnPref &, const TConnectionId , const TUid , TConnPref &, TRequestStatus &)
IMPORT_C void Close ()
IMPORT_C TInt Connect ()
IMPORT_C void Connect ( TRequestStatus &)
IMPORT_C TBool Connected ()
IMPORT_C TInt EasyWlanSsid (const TWlanSsid &)
IMPORT_C TInt IAPConnectionActivated (const TUint32 , const TConnectionId )
IMPORT_C TInt IAPConnectionStarted (const TUint32 , const TConnectionId )
IMPORT_C void IAPConnectionStarted (const TUint32 , const TConnectionId , TRequestStatus &)
IMPORT_C TInt IAPConnectionStopped (const TUint32 , const TConnectionId )
IMPORT_C void IAPConnectionStopped (const TUint32 , const TConnectionId , TRequestStatus &)
IMPORT_C TInt LaunchServer ()
IMPORT_C void ProcessError ( TInt &, const TConnectionId , TBMNeededAction &, TRequestStatus &)
IMPORT_C void ProcessError ( TConnPref &, TInt &, const TConnectionId , TBMNeededAction &, TRequestStatus &)
IMPORT_C TInt RegisterPrefIAPNotif (const TConnectionId )
IMPORT_C void RegisterPrefIAPNotif (const TConnectionId , TRequestStatus &)
IMPORT_C TInt RegisterPrefIAPNotif (const TConnPref &, const TConnectionId )
IMPORT_C void ReselectBestIAP (const TConnectionId , TConnPref &, TRequestStatus &)
IMPORT_C TInt SendCancelRequest ( TMpmAsynchCodes )
IMPORT_C TInt SortSNAP (const TUint32 , TMpmSnapBuffer &)
IMPORT_C void SortSNAP (const TUint32 , TMpmSnapBuffer &, TRequestStatus &, const TUint32 )
IMPORT_C void UnregisterPrefIAPNotif (const TConnectionId )
IMPORT_C void UnregisterPrefIAPNotif (const TConnectionId , TRequestStatus &)
IMPORT_C TVersion Version ()
IMPORT_C void WaitNotification ( 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 TInt ApplicationAcceptedTheCarrier ( const TUint32 aIapId,
const TConnectionId aConnId
)
Application accepted the carrier.
Since
3.2

Parameters

const TUint32 aIapId IAP Id of the new carrier.
const TConnectionId aConnId Connection Id

ApplicationAcceptedTheCarrier(const TUint32, const TConnectionId, TRequestStatus &)

IMPORT_C void ApplicationAcceptedTheCarrier ( const TUint32 aIapId,
const TConnectionId aConnId,
TRequestStatus & aStatus
)
Application accpeted the carrier.
Since
3.2

Parameters

const TUint32 aIapId IAP Id of the accepted carrier.
const TConnectionId aConnId Connection Id
TRequestStatus & aStatus KErrNone if successful, otherwise one of the system-wide error codes

ApplicationConnectionEnds(const TConnectionId)

IMPORT_C TInt ApplicationConnectionEnds ( const TConnectionId aConnId )
Application connection ends.
Since
3.2

Parameters

const TConnectionId aConnId Connection Id

ApplicationConnectionEnds(const TConnectionId, TRequestStatus &)

IMPORT_C void ApplicationConnectionEnds ( const TConnectionId aConnId,
TRequestStatus & aStatus
)
Application connection ends.
Since
5.2

Parameters

const TConnectionId aConnId Connection Id
TRequestStatus & aStatus KErrNone if successful, otherwise one of the system-wide error codes

ApplicationIgnoredTheCarrier(const TUint32, const TConnectionId)

IMPORT_C TInt ApplicationIgnoredTheCarrier ( const TUint32 aIapId,
const TConnectionId aConnId
)
Application ignored the carrier.
Since
3.2

Parameters

const TUint32 aIapId IAP Id of the new carrier.
const TConnectionId aConnId Connection Id

ApplicationIgnoredTheCarrier(const TUint32, const TConnectionId, TRequestStatus &)

IMPORT_C void ApplicationIgnoredTheCarrier ( const TUint32 aIapId,
const TConnectionId aConnId,
TRequestStatus & aStatus
)
Application ignored the carrier.
Since
3.2

Parameters

const TUint32 aIapId IAP Id of the new carrier.
const TConnectionId aConnId Connection Id
TRequestStatus & aStatus KErrNone if successful, otherwise one of the system-wide error codes

ApplicationJoinsConnection(const TUint32, const TConnectionId)

IMPORT_C TInt ApplicationJoinsConnection ( const TUint32 aIapId,
const TConnectionId aConnId
)
Application joins connection.
Since
3.2

Parameters

const TUint32 aIapId IAP Id of the connection.
const TConnectionId aConnId Connection Id

ApplicationJoinsConnection(const TUint32, const TConnectionId, TRequestStatus &)

IMPORT_C void ApplicationJoinsConnection ( const TUint32 aIapId,
const TConnectionId aConnId,
TRequestStatus & aStatus
)
Application joins connection.
Since
5.2

Parameters

const TUint32 aIapId IAP Id of the connection.
const TConnectionId aConnId Connection Id
TRequestStatus & aStatus KErrNone if successful, otherwise one of the system-wide error codes

ApplicationLeavesConnection(const TUint32, const TConnectionId)

IMPORT_C TInt ApplicationLeavesConnection ( const TUint32 aIapId,
const TConnectionId aConnId
)
Application leaves connection.
Since
3.1

Parameters

const TUint32 aIapId IAP Id of the connection.
const TConnectionId aConnId Connection Id

ApplicationLeavesConnection(const TUint32, const TConnectionId, TRequestStatus &)

IMPORT_C void ApplicationLeavesConnection ( const TUint32 aIapId,
const TConnectionId aConnId,
TRequestStatus & aStatus
)
Application leaves connection.
Since
5.2

Parameters

const TUint32 aIapId IAP Id of the connection.
const TConnectionId aConnId Connection Id
TRequestStatus & aStatus KErrNone if successful, otherwise one of the system-wide error codes

ApplicationMigratesToCarrier(const TUint32, const TConnectionId)

IMPORT_C TInt ApplicationMigratesToCarrier ( const TUint32 aIapId,
const TConnectionId aConnId
)
Application migrates to carrier.
Since
3.2

Parameters

const TUint32 aIapId IAP Id of the new carrier.
const TConnectionId aConnId Connection Id

ApplicationMigratesToCarrier(const TUint32, const TConnectionId, TRequestStatus &)

IMPORT_C void ApplicationMigratesToCarrier ( const TUint32 aIapId,
const TConnectionId aConnId,
TRequestStatus & aStatus
)
Application migrates to carrier.
Since
3.2

Parameters

const TUint32 aIapId IAP Id of the new carrier.
const TConnectionId aConnId Connection Id
TRequestStatus & aStatus KErrNone if successful, otherwise one of the system-wide error codes

ApplicationRejectedTheCarrier(const TUint32, const TConnectionId)

IMPORT_C TInt ApplicationRejectedTheCarrier ( const TUint32 aIapId,
const TConnectionId aConnId
)
Application rejected the carrier.
Since
3.2

Parameters

const TUint32 aIapId IAP Id of the new carrier.
const TConnectionId aConnId Connection Id

ApplicationRejectedTheCarrier(const TUint32, const TConnectionId, TRequestStatus &)

IMPORT_C void ApplicationRejectedTheCarrier ( const TUint32 aIapId,
const TConnectionId aConnId,
TRequestStatus & aStatus
)
Application rejected the carrier.
Since
3.2

Parameters

const TUint32 aIapId IAP Id of the rejected carrier.
const TConnectionId aConnId Connection Id
TRequestStatus & aStatus KErrNone if successful, otherwise one of the system-wide error codes

Cancel(TMpmAsynchCodes)

IMPORT_C void Cancel ( TMpmAsynchCodes aReqToCancel ) const
Cancels asynchronous request. In the risk of deadlock use the SendCancelRequest()
Since
3.1

Parameters

TMpmAsynchCodes aReqToCancel request to be canceled

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

IMPORT_C void ChooseBestIAP ( TConnPref & aConnPref,
const TConnectionId aConnId,
const TUid aAppUid,
TConnPref & aPolicyPref,
TRequestStatus & aStatus
)
Initial select of the most prefered IAP for the connection.
Since
3.1

Parameters

TConnPref & aConnPref Connection preferences from application
const TConnectionId aConnId Connection Id
const TUid aAppUid Application UId
TConnPref & aPolicyPref Connection preferences chosen by MPM
TRequestStatus & aStatus KErrNone if successful, otherwise one of the system-wide error codes

Close()

IMPORT_C void Close ( )
Closes MPM server session.
Since
3.0

Connect()

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

Connect(TRequestStatus &)

IMPORT_C void Connect ( 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 TBool Connected ( )
Queries whether MPM is connected.
Since
5.2

EasyWlanSsid(const TWlanSsid &)

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

Parameters

const TWlanSsid & aSSID the id of selected wlan network

IAPConnectionActivated(const TUint32, const TConnectionId)

IMPORT_C TInt IAPConnectionActivated ( const TUint32 aIapId,
const TConnectionId aConnId
)
The whole IAP connection is activated.
Since
3.2

Parameters

const TUint32 aIapId IAP Id of the connection.
const TConnectionId aConnId Connection Id

IAPConnectionStarted(const TUint32, const TConnectionId)

IMPORT_C TInt IAPConnectionStarted ( const TUint32 aIapId,
const TConnectionId aConnId
)
The whole IAP connection is started.
Since
3.2

Parameters

const TUint32 aIapId IAP Id of the connection.
const TConnectionId aConnId Connection Id

IAPConnectionStarted(const TUint32, const TConnectionId, TRequestStatus &)

IMPORT_C void IAPConnectionStarted ( const TUint32 aIapId,
const TConnectionId aConnId,
TRequestStatus & aStatus
)
The whole IAP connection is started.
Since
5.2

Parameters

const TUint32 aIapId IAP Id of the connection.
const TConnectionId aConnId Connection Id
TRequestStatus & aStatus KErrNone if successful, otherwise one of the system-wide error codes

IAPConnectionStopped(const TUint32, const TConnectionId)

IMPORT_C TInt IAPConnectionStopped ( const TUint32 aIapId,
const TConnectionId aConnId
)
The whole IAP connection is stopped.
Since
3.1

Parameters

const TUint32 aIapId IAP Id of the connection.
const TConnectionId aConnId Connection Id

IAPConnectionStopped(const TUint32, const TConnectionId, TRequestStatus &)

IMPORT_C void IAPConnectionStopped ( const TUint32 aIapId,
const TConnectionId aConnId,
TRequestStatus & aStatus
)
The whole IAP connection is stopped.
Since
5.2

Parameters

const TUint32 aIapId IAP Id of the connection.
const TConnectionId aConnId Connection Id
TRequestStatus & aStatus KErrNone if successful, otherwise one of the system-wide error codes

LaunchServer()

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

NextPtr()

TPtr8 & NextPtr ( ) [private]

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

IMPORT_C void ProcessError ( TInt & aError,
const TConnectionId aConnId,
TBMNeededAction & aNeededAction,
TRequestStatus & aStatus
)
Error processing of connection initiation.
Since
3.1

Parameters

TInt & aError Error code
const TConnectionId aConnId Connection Id
TBMNeededAction & aNeededAction Ignore error, propagate error or perform a reselection
TRequestStatus & aStatus KErrNone if successful, otherwise one of the system-wide error codes

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

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

Parameters

TConnPref & aConnPref Connection preferences
TInt & aError Error code
const TConnectionId aConnId Connection Id
TBMNeededAction & aNeededAction Ignore error, propagate error or perform a reselection
TRequestStatus & aStatus KErrNone if successful, otherwise one of the system-wide error codes

RegisterPrefIAPNotif(const TConnectionId)

IMPORT_C TInt RegisterPrefIAPNotif ( const TConnectionId aConnId )
Register for getting preferred IAP notifications.
Since
3.1

Parameters

const TConnectionId aConnId Connection Id

RegisterPrefIAPNotif(const TConnectionId, TRequestStatus &)

IMPORT_C void RegisterPrefIAPNotif ( const TConnectionId aConnId,
TRequestStatus & aStatus
)
Register for getting preferred IAP notifications.
Since
5.2

Parameters

const TConnectionId aConnId Connection Id
TRequestStatus & aStatus KErrNone if successful, otherwise one of the system-wide error codes

RegisterPrefIAPNotif(const TConnPref &, const TConnectionId)

IMPORT_C TInt RegisterPrefIAPNotif ( const TConnPref & aConnPref,
const TConnectionId aConnId
)
Register for getting preferred IAP notifications. In 5.2, aConnPref not required.
Since
3.1

Parameters

const TConnPref & aConnPref Connection preferences
const TConnectionId aConnId Connection Id

ReselectBestIAP(const TConnectionId, TConnPref &, TRequestStatus &)

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

Parameters

const TConnectionId aConnId Connection Id
TConnPref & aPolicyPref Connection preferences chosen by MPM
TRequestStatus & aStatus KErrNone if successful, otherwise one of the system-wide error codes

SendCancelRequest(TMpmAsynchCodes)

IMPORT_C TInt SendCancelRequest ( TMpmAsynchCodes aReqToCancel ) const
Asynchronous cancellation
Since
5.2

Parameters

TMpmAsynchCodes aReqToCancel request to be canceled

SortSNAP(const TUint32, TMpmSnapBuffer &)

IMPORT_C TInt SortSNAP ( const TUint32 aSNAP,
TMpmSnapBuffer & aSortedList
)
Sort available IAPs belonging to the specified SNAP.
Since
3.2

Parameters

const TUint32 aSNAP Service Network Access Point
TMpmSnapBuffer & aSortedList on return contains the sorted list of IAPs

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

IMPORT_C void SortSNAP ( const TUint32 aSNAP,
TMpmSnapBuffer & aSortedList,
TRequestStatus & aStatus,
const TUint32 aMaxAgeSeconds = 5
)
Asynchronously sort available IAPs belonging to the specified SNAP.
Since
5.2

Parameters

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

UnregisterPrefIAPNotif(const TConnectionId)

IMPORT_C void UnregisterPrefIAPNotif ( const TConnectionId aConnId )
Unregister preferred IAP notifications.
Since
3.1

Parameters

const TConnectionId aConnId Connection Id

UnregisterPrefIAPNotif(const TConnectionId, TRequestStatus &)

IMPORT_C void UnregisterPrefIAPNotif ( const TConnectionId aConnId,
TRequestStatus & aStatus
)
Unregister preferred IAP notifications.
Since
5.2

Parameters

const TConnectionId aConnId Connection Id
TRequestStatus & aStatus

Version()

IMPORT_C TVersion Version ( ) const
Returns MPM server version.
Since
3.0

WaitNotification(TMPMMessageBuffer &, TRequestStatus &)

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

Parameters

TMPMMessageBuffer & aMpmNotification notification for BM
TRequestStatus & aStatus KErrNone 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.