RCmManager Class Reference

class RCmManager

RCmManager gives access to network destinations and connection methods.

cmmanager.lib
Since
S60 v3.2
Public Member Functions
RCmManager ()
IMPORT_C void AllDestinationsL ( RArray < TUint32 > &)
IMPORT_C void BearerPriorityArrayL ( RArray < TBearerPriority > &)
IMPORT_C void CleanupGlobalPriorityArray ( RArray < TBearerPriority > &)
IMPORT_C void Close ()
IMPORT_C RCmConnectionMethod ConnectionMethodL ( TUint32 )
IMPORT_C void ConnectionMethodL ( RArray < TUint32 > &, TBool , TBool , TBool )
IMPORT_C TInt CopyConnectionMethodL ( RCmDestination &, RCmConnectionMethod &)
IMPORT_C RCmConnectionMethod CreateConnectionMethodL ( TUint32 )
IMPORT_C RCmConnectionMethod CreateConnectionMethodL ( TUint32 , TUint32 )
IMPORT_C RCmDestination CreateDestinationL (const TDesC &)
IMPORT_C RCmDestination CreateDestinationL (const TDesC &, TUint32 )
IMPORT_C void CreateTablesAndOpenL ()
IMPORT_C RCmDestination DestinationL ( TUint32 )
IMPORT_C TUint32 EasyWlanIdL ()
IMPORT_C TBool GetBearerInfoBoolL ( TUint32 , TUint32 )
IMPORT_C TUint32 GetBearerInfoIntL ( TUint32 , TUint32 )
IMPORT_C HBufC8 * GetBearerInfoString8L ( TUint32 , TUint32 )
IMPORT_C HBufC * GetBearerInfoStringL ( TUint32 , TUint32 )
IMPORT_C TBool GetConnectionMethodInfoBoolL ( TUint32 , TUint32 )
IMPORT_C TUint32 GetConnectionMethodInfoIntL ( TUint32 , TUint32 )
IMPORT_C HBufC8 * GetConnectionMethodInfoString8L ( TUint32 , TUint32 )
IMPORT_C HBufC * GetConnectionMethodInfoStringL ( TUint32 , TUint32 )
IMPORT_C TInt MoveConnectionMethodL ( RCmDestination &, RCmDestination &, RCmConnectionMethod &)
IMPORT_C void OpenL ()
IMPORT_C void OpenLC ()
IMPORT_C void ReadDefConnL ( TCmDefConnValue &)
IMPORT_C void ReadGenConnSettingsL ( TCmGenConnSettings &)
IMPORT_C void RemoveAllReferencesL ( RCmConnectionMethod &)
IMPORT_C void RemoveConnectionMethodL ( RCmDestination &, RCmConnectionMethod &)
IMPORT_C void SupportedBearersL ( RArray < TUint32 > &)
IMPORT_C CGulIcon * UncategorizedIconL ()
IMPORT_C void UpdateBearerPriorityArrayL (const RArray < TBearerPriority > &)
IMPORT_C void WriteDefConnL (const TCmDefConnValue &)
IMPORT_C void WriteGenConnSettingsL (const TCmGenConnSettings &)
Private Member Functions
RCmManager ( RCmManager &)
RCmManager & operator= ( RCmManager &)
Private Attributes
CCmManagerImpl * iImplementation

Constructor & Destructor Documentation

RCmManager()

RCmManager ( ) [inline]

Default constructor.

RCmManager(RCmManager &)

RCmManager ( RCmManager & ) [private]

This is a private copy constructor without implementation. The sole purpose of this declaration is to forbid the copying of the objects of this class.

Parameters

RCmManager &

Member Functions Documentation

AllDestinationsL(RArray< TUint32 > &)

IMPORT_C void AllDestinationsL ( RArray < TUint32 > & aDestArray ) const

Returns an array of all destination id's

Since
S60 3.2

Parameters

RArray < TUint32 > & aDestArray list all available destinations' id

BearerPriorityArrayL(RArray< TBearerPriority > &)

IMPORT_C void BearerPriorityArrayL ( RArray < TBearerPriority > & aArray ) const

Returns the copy of the bearer priority array. Ownership is passed.

Since
S60 3.2

Parameters

RArray < TBearerPriority > & aArray bearer priority array

CleanupGlobalPriorityArray(RArray< TBearerPriority > &)

IMPORT_C void CleanupGlobalPriorityArray ( RArray < TBearerPriority > & aArray ) const

Clean up passed global bearer priority array. Delete the elements and calls Reset and Close on the array.

Since
S60 3.2

Parameters

RArray < TBearerPriority > & aArray array to be cleaned up

Close()

IMPORT_C void Close ( )

Secondary destructor

Since
S60 3.2

ConnectionMethodL(TUint32)

IMPORT_C RCmConnectionMethod ConnectionMethodL ( TUint32 aConnectionMethodId ) const

Returns the connection method queried by its ID

Since
S60 3.2

Parameters

TUint32 aConnectionMethodId id of the connection method

ConnectionMethodL(RArray< TUint32 > &, TBool, TBool, TBool)

IMPORT_C void ConnectionMethodL ( RArray < TUint32 > & aCMArray,
TBool aCheckBearerType = ETrue,
TBool aLegacyOnly = ETrue,
TBool aEasyWlan = EFalse
) const

Returns the list of connection methods. Connection Methods are filtered by the switch parameters e.g. aLegacyOnly.

Since
S60 3.2

Parameters

RArray < TUint32 > & aCMArray on return it is the array of IAP ids.
TBool aCheckBearerType = ETrue If ETrue only connection methods with supported bearer type are returned
TBool aLegacyOnly = ETrue when set to ETrue only Legacy IAP ids will be returned
TBool aEasyWlan = EFalse when set to ETrue EasyWlan id is returned, too

CopyConnectionMethodL(RCmDestination &, RCmConnectionMethod &)

IMPORT_C TInt CopyConnectionMethodL ( RCmDestination & aTargetDestination,
RCmConnectionMethod & aConnectionMethod
)

Copies a connection method belonging to one destination to another. The connection method becomes shared. Calls UpdateL on the destination

Parameters

RCmDestination & aTargetDestination
RCmConnectionMethod & aConnectionMethod

CreateConnectionMethodL(TUint32)

IMPORT_C RCmConnectionMethod CreateConnectionMethodL ( TUint32 aBearerType )

Creates a connection method does not belong to any destination

Parameters

TUint32 aBearerType

CreateConnectionMethodL(TUint32, TUint32)

IMPORT_C RCmConnectionMethod CreateConnectionMethodL ( TUint32 aImplementationUid,
TUint32 aConnMethodId
)

Creates a connection method does not belong to any destination

Parameters

TUint32 aImplementationUid - bearer type of the new connection method
TUint32 aConnMethodId Predefined id for the connection method.

CreateDestinationL(const TDesC &)

IMPORT_C RCmDestination CreateDestinationL ( const TDesC & aName )

Creates a Destination with the passed name.

Parameters

const TDesC & aName the name of the new destination.

CreateDestinationL(const TDesC &, TUint32)

IMPORT_C RCmDestination CreateDestinationL ( const TDesC & aName,
TUint32 aDestId
)

Creates a Destination with the passed name and id.

Parameters

const TDesC & aName the name of the new destination.
TUint32 aDestId Predefined id of the destination.

CreateTablesAndOpenL()

IMPORT_C void CreateTablesAndOpenL ( )

Open session and create tables if they don't exist

DestinationL(TUint32)

IMPORT_C RCmDestination DestinationL ( TUint32 aDestinationId ) const

Returns the destination to which a specified connection method belongs, search is by destination ID

Since
S60 3.2

Parameters

TUint32 aDestinationId id of destination

EasyWlanIdL()

IMPORT_C TUint32 EasyWlanIdL ( ) const

Returns the id of the EasyWlan connection method.

Since
S60 3.2

GetBearerInfoBoolL(TUint32, TUint32)

IMPORT_C TBool GetBearerInfoBoolL ( TUint32 aBearerType,
TUint32 aAttribute
) const

Used to query bearer information that doesn't belong to a specific connection method, such as ECmCoverage or ECmDefaultPriority etc.

Since
S60 3.2

Parameters

TUint32 aBearerType the bearer
TUint32 aAttribute the setting value

GetBearerInfoIntL(TUint32, TUint32)

IMPORT_C TUint32 GetBearerInfoIntL ( TUint32 aBearerType,
TUint32 aAttribute
) const

Used to query bearer information that doesn't belong to a specific connection method, such as ECmCoverage or ECmDefaultPriority etc.

Since
S60 3.2

Parameters

TUint32 aBearerType the bearer
TUint32 aAttribute the setting value

GetBearerInfoString8L(TUint32, TUint32)

IMPORT_C HBufC8 * GetBearerInfoString8L ( TUint32 aBearerType,
TUint32 aAttribute
) const

Used to query bearer information that does not belong to a specific connection method, such as ECmCoverage or ECmDefaultPriority, etc. HBuf ownership is passed to the caller

Since
S60 3.2

Parameters

TUint32 aBearerType the bearer
TUint32 aAttribute the setting value

GetBearerInfoStringL(TUint32, TUint32)

IMPORT_C HBufC * GetBearerInfoStringL ( TUint32 aBearerType,
TUint32 aAttribute
) const

Used to query bearer information that doesn't belong to a specific connection method, such as ECmCoverage or ECmDefaultPriority etc. HBuf ownership is passed to the caller

Since
S60 3.2

Parameters

TUint32 aBearerType the bearer
TUint32 aAttribute the setting value

GetConnectionMethodInfoBoolL(TUint32, TUint32)

IMPORT_C TBool GetConnectionMethodInfoBoolL ( TUint32 aIapId,
TUint32 aAttribute
) const

Used to query any, non-bearer specific information about a given connection method. This can be e.g. ECmBearerType, ECmName, ECmStartPage, etc.

Since
S60 3.2

Parameters

TUint32 aIapId the connection method id
TUint32 aAttribute the setting value

GetConnectionMethodInfoIntL(TUint32, TUint32)

IMPORT_C TUint32 GetConnectionMethodInfoIntL ( TUint32 aIapId,
TUint32 aAttribute
) const

Used to query any non-bearer specific information about a given connection method. This can be e.g. ECmBearerType, ECmName, ECmStartPage, etc.

Since
S60 3.2

Parameters

TUint32 aIapId the connection method id
TUint32 aAttribute the setting value

GetConnectionMethodInfoString8L(TUint32, TUint32)

IMPORT_C HBufC8 * GetConnectionMethodInfoString8L ( TUint32 aIapId,
TUint32 aAttribute
) const

Used to query any non-bearer specific information about a given connection method. This can be e.g. ECmBearerType, ECmName, ECmStartPage, etc. HBuf ownership is passed to the caller

Since
S60 3.2

Parameters

TUint32 aIapId the connection method id
TUint32 aAttribute the setting value

GetConnectionMethodInfoStringL(TUint32, TUint32)

IMPORT_C HBufC * GetConnectionMethodInfoStringL ( TUint32 aIapId,
TUint32 aAttribute
) const

Used to query any non-bearer specific information about a given connection method. This can be e.g. ECmBearerType, ECmName, ECmStartPage, etc. HBuf ownership is passed to the caller

Since
S60 3.2

Parameters

TUint32 aIapId the connection method id
TUint32 aAttribute the setting value

MoveConnectionMethodL(RCmDestination &, RCmDestination &, RCmConnectionMethod &)

IMPORT_C TInt MoveConnectionMethodL ( RCmDestination & aSourceDestination,
RCmDestination & aTargetDestination,
RCmConnectionMethod & aConnectionMethod
)

Moves a connection method belonging to one destination to another. The connection method is removed from the source destination

Parameters

RCmDestination & aSourceDestination
RCmDestination & aTargetDestination
RCmConnectionMethod & aConnectionMethod

OpenL()

IMPORT_C void OpenL ( )

Symbian constructor

Since
S60 3.2

OpenLC()

IMPORT_C void OpenLC ( )

Symbian constructor Pushes the object on the cleanup stack

Since
S60 3.2

ReadDefConnL(TCmDefConnValue &)

IMPORT_C void ReadDefConnL ( TCmDefConnValue & aDCSetting )

Returns the default connection method/SNAP.

Since
S60 3.2

Parameters

TCmDefConnValue & aDCSetting

ReadGenConnSettingsL(TCmGenConnSettings &)

IMPORT_C void ReadGenConnSettingsL ( TCmGenConnSettings & aGenConnSettings )

Returns the general connection settings.

Since
S60 9.2

Parameters

TCmGenConnSettings & aGenConnSettings

RemoveAllReferencesL(RCmConnectionMethod &)

IMPORT_C void RemoveAllReferencesL ( RCmConnectionMethod & aConnectionMethod )

Removes connection method from every destination and make it uncategorized.

Parameters

RCmConnectionMethod & aConnectionMethod connection method to be removed

RemoveConnectionMethodL(RCmDestination &, RCmConnectionMethod &)

IMPORT_C void RemoveConnectionMethodL ( RCmDestination & aDestination,
RCmConnectionMethod & aConnectionMethod
)

Remove connection method from the destination

Parameters

RCmDestination & aDestination destination the connection method is attached to
RCmConnectionMethod & aConnectionMethod connection method to be removed

SupportedBearersL(RArray< TUint32 > &)

IMPORT_C void SupportedBearersL ( RArray < TUint32 > & aArray ) const

Query all of the supported bearer types.

Parameters

RArray < TUint32 > & aArray list of all supported bearer types.

UncategorizedIconL()

IMPORT_C CGulIcon * UncategorizedIconL ( ) const

Returns "Uncategorized" icon. This fucton leaves if the client does not have a valid UI context

UpdateBearerPriorityArrayL(const RArray< TBearerPriority > &)

IMPORT_C void UpdateBearerPriorityArrayL ( const RArray < TBearerPriority > & aArray )

Update bearer priority array

Parameters

const RArray < TBearerPriority > & aArray array with new global bearer priority

WriteDefConnL(const TCmDefConnValue &)

IMPORT_C void WriteDefConnL ( const TCmDefConnValue & aDCSetting )

Stores the default connection method/SNAP.

Since
S60 3.2

Parameters

const TCmDefConnValue & aDCSetting

WriteGenConnSettingsL(const TCmGenConnSettings &)

IMPORT_C void WriteGenConnSettingsL ( const TCmGenConnSettings & aGenConnSettings )

Writes the general connection settings.

Since
S60 9.2

Parameters

const TCmGenConnSettings & aGenConnSettings

operator=(RCmManager &)

RCmManager & operator= ( RCmManager & ) [private]

This is a private copy constructor without implementation. The sole purpose of this declaration is to forbid the copying of the objects of this class.

Parameters

RCmManager &

Member Data Documentation

CCmManagerImpl * iImplementation

CCmManagerImpl * iImplementation [private]

the implementation class