Symbian^3 Application Developer Library >

CSIPProfileRegistryBase Class Reference

class CSIPProfileRegistryBase : public CBase

The class functions for retrieving SIP profiles from permanent storage. It enables retrieval of single or more profiles from permanent storage located in profile server.

The class enables also the query of supported profile types.

This class is an abstract class and cannot be instantiated.

sipprofilecli.lib

Inherits from

Public Member Functions
~CSIPProfileRegistryBase ()
void AddProfileL ( CSIPProfile &)
void AddedL ( TUint32 )
void CrashRevert ( TAny *)
IMPORT_C CSIPProfile * DefaultProfileL ()
void DisableProfileL ( CSIPProfile &)
void EnableProfileL ( CSIPProfile &)
void ErrorOccurredL ( TUint32 , TInt , TInt )
void ForceDisableProfileL ( CSIPProfile &)
TBool IsDefaultProfileL (const CSIPProfile &)
CSIPProfileITC & Itc ()
CSIPProfileITCReceiver & ItcReceiver ()
IMPORT_C TInt LastRegistrationError (const CSIPProfile &)
void LocalCrashRevert ( TAny *)
void NegotiatedSecurityMechanismL ( CSIPConcreteProfile &)
CSIPProfile * NewInstanceL ()
void ProfileDeleted ( CSIPProfile &)
IMPORT_C CSIPProfile * ProfileL ( TUint32 )
IMPORT_C void ProfilesL ( RPointerArray < CSIPProfile > &)
IMPORT_C void ProfilesL (const TSIPProfileTypeInfo &, RPointerArray < CSIPProfile > &)
IMPORT_C void ProfilesL (const TDesC8 &, RPointerArray < CSIPProfile > &)
void RegisteredAORsL ( CSIPConcreteProfile &)
void RegistrationStatusChangedL ( TUint32 , TInt , TUint32 )
void RemoveProfileL ( CSIPProfile &)
void RemovedL ( TUint32 )
IMPORT_C void SupportedProfileTypesL ( RArray < TSIPProfileTypeInfo > &)
void UpdateProfileL ( CSIPProfile &)
void UpdatedL ( TUint32 , TUint )
TInt UsageL (const CSIPProfile &)
Protected Member Functions
CSIPProfileRegistryBase ( MSIPProfileRegistryObserver &)
void BaseConstructL ()
TInt ProfileIndex ( TUint )
CSIPProfileItem * ProfileItemByIndex ( TUint )
CSIPProfileItem * ProfileItemL ( TUint )
CSIPProfile * SIPProfileL ( TUint32 , TInt )
void StoreArrayL ( RPointerArray < CSIPConcreteProfile > &, RPointerArray < CSIPProfile > &)
void StoreProfileL ( CSIPProfileCleanupItem *)
Private Member Functions
void ProfilesCommonL ( RPointerArray < CSIPProfile > &, CSIPConcreteProfileHolder *)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
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()
Protected Attributes
CSIPProfileItem * iFindEntry
CSIPProfileITC * iITC
CSIPProfileITCReceiver * iITCReceiver
MSIPProfileRegistryObserver & iObserver
CSIPProfilePlugins * iProfilePlugins
RPointerArray < CSIPProfileItem > iProfiles
RSIPProfile * iSipClient

Constructor & Destructor Documentation

CSIPProfileRegistryBase(MSIPProfileRegistryObserver &)

CSIPProfileRegistryBase ( MSIPProfileRegistryObserver & aObserver ) [protected]

Constructor

Parameters

MSIPProfileRegistryObserver & aObserver observer to send events to

~CSIPProfileRegistryBase()

IMPORT_C ~CSIPProfileRegistryBase ( )

Member Functions Documentation

AddProfileL(CSIPProfile &)

void AddProfileL ( CSIPProfile & aProfile )

Add profile

Parameters

CSIPProfile & aProfile to be added

AddedL(TUint32)

void AddedL ( TUint32 aProfileId )

SIP profile creation event.

Parameters

TUint32 aProfileId id of new SIP Profile

BaseConstructL()

void BaseConstructL ( ) [protected]

Symbian 2nd phase base class constructor

CrashRevert(TAny *)

void CrashRevert ( TAny * aItem ) [static]

Roll back in case of failure

Parameters

TAny * aItem object to be cleaned

DefaultProfileL()

IMPORT_C CSIPProfile * DefaultProfileL ( )
Gets the default profile
leave
KErrNotFound if profile not found
leave
KErrNoMemory if out of memory
capability
ReadUserData

DisableProfileL(CSIPProfile &)

void DisableProfileL ( CSIPProfile & aProfile )

Disable profile

Parameters

CSIPProfile & aProfile to be disabled

EnableProfileL(CSIPProfile &)

void EnableProfileL ( CSIPProfile & aProfile )

Enable profile

Parameters

CSIPProfile & aProfile to be enabled

ErrorOccurredL(TUint32, TInt, TInt)

void ErrorOccurredL ( TUint32 aProfileId,
TInt aStatus,
TInt aError
)

An asynchronous error has occurred related to SIP profile

Parameters

TUint32 aProfileId the id of failed profile
TInt aStatus
TInt aError a error code

ForceDisableProfileL(CSIPProfile &)

void ForceDisableProfileL ( CSIPProfile & aProfile )

Force disable profile All Profile related activities will be stopped ungracefully

Parameters

CSIPProfile & aProfile to be disabled

IsDefaultProfileL(const CSIPProfile &)

TBool IsDefaultProfileL ( const CSIPProfile & aProfile )

Checks whether profile is default or not

Parameters

const CSIPProfile & aProfile checked profile

Itc()

CSIPProfileITC & Itc ( )

Gets the ITC member variable. The owneship of ITC is not transferred.

ItcReceiver()

CSIPProfileITCReceiver & ItcReceiver ( )

Gets the ITC receiver member variable. The owneship of ITC receiver is not transferred.

LastRegistrationError(const CSIPProfile &)

IMPORT_C TInt LastRegistrationError ( const CSIPProfile & aProfile ) const

Gets the last occurred error during registration

Parameters

const CSIPProfile & aProfile

LocalCrashRevert(TAny *)

void LocalCrashRevert ( TAny * aItem ) [static]

Roll back in case of failure

Parameters

TAny * aItem object to be cleaned

NegotiatedSecurityMechanismL(CSIPConcreteProfile &)

void NegotiatedSecurityMechanismL ( CSIPConcreteProfile & aProfile )

Updates SIP profile value for negotiated security mechanism; leaves on failure

Parameters

CSIPConcreteProfile & aProfile a SIP profile

NewInstanceL()

CSIPProfile * NewInstanceL ( ) [pure virtual]

Gets new instance of either type CSIPProfile or CSIPManagedProfile

ProfileDeleted(CSIPProfile &)

void ProfileDeleted ( CSIPProfile & aProfile )

Informs destruction of local profile object instance

Parameters

CSIPProfile & aProfile instance of deleted profile

ProfileIndex(TUint)

TInt ProfileIndex ( TUint aProfileId ) [protected]

Gets profile cache item index

Parameters

TUint aProfileId a profile id to be found

ProfileItemByIndex(TUint)

CSIPProfileItem * ProfileItemByIndex ( TUint aIndex ) [protected]

Gets profile cache item by index

Parameters

TUint aIndex a index of the profile to be found

ProfileItemL(TUint)

CSIPProfileItem * ProfileItemL ( TUint aProfileId ) [protected]

Gets profile cache item

Parameters

TUint aProfileId a profile id to be found

ProfileL(TUint32)

IMPORT_C CSIPProfile * ProfileL ( TUint32 aId )
Gets SIP profile identified by the Id The owneship of profile is transferred.
leave
KErrNotFound if profile is not found
capability
ReadUserData

Parameters

TUint32 aId a SIP profile Id

ProfilesCommonL(RPointerArray< CSIPProfile > &, CSIPConcreteProfileHolder *)

void ProfilesCommonL ( RPointerArray < CSIPProfile > & aProfiles,
CSIPConcreteProfileHolder * aHolder
) [private]

Parameters

RPointerArray < CSIPProfile > & aProfiles
CSIPConcreteProfileHolder * aHolder

ProfilesL(RPointerArray< CSIPProfile > &)

IMPORT_C void ProfilesL ( RPointerArray < CSIPProfile > & aProfiles )
Gets all SIP profiles
Pre-condition
aProfiles.Count() == 0
leave
KErrNoMemory if out of memory
capability
ReadUserData

Parameters

RPointerArray < CSIPProfile > & aProfiles a reference to a client-owned array, which on return is filled with all existing SIP profiles

ProfilesL(const TSIPProfileTypeInfo &, RPointerArray< CSIPProfile > &)

IMPORT_C void ProfilesL ( const TSIPProfileTypeInfo & aType,
RPointerArray < CSIPProfile > & aProfiles
)
Gets all SIP profiles of particular type The owneship of profiles are transferred.
Pre-condition
aProfiles.Count() == 0
leave
KErrNoMemory if out of memory
capability
ReadUserData

Parameters

const TSIPProfileTypeInfo & aType a SIP profile type that is used for a query
RPointerArray < CSIPProfile > & aProfiles a reference to a client-owned array, which on return is filled with profiles of the given type.

ProfilesL(const TDesC8 &, RPointerArray< CSIPProfile > &)

IMPORT_C void ProfilesL ( const TDesC8 & aAOR,
RPointerArray < CSIPProfile > & aProfiles
)
Gets SIP profile for a particular SIP AOR The owneship of profiles are transferred.
Pre-condition
aProfiles.Count() == 0
leave
KErrNoMemory if out memory
capability
ReadUserData

Parameters

const TDesC8 & aAOR a SIP AOR e.g.
RPointerArray < CSIPProfile > & aProfiles a reference to a client-owned array, which on return is filled with profiles of the given type.

RegisteredAORsL(CSIPConcreteProfile &)

void RegisteredAORsL ( CSIPConcreteProfile & aProfile )

Updates SIP profile value for registered AORs; leaves on failure

Parameters

CSIPConcreteProfile & aProfile a SIP profile

RegistrationStatusChangedL(TUint32, TInt, TUint32)

void RegistrationStatusChangedL ( TUint32 aProfileId,
TInt aStatus,
TUint32 aStatusId
)

SIP profile registration status changed event

Parameters

TUint32 aProfileId id of profile which registration status has been changed.
TInt aStatus new status of the profile
TUint32 aStatusId id related to registration

RemoveProfileL(CSIPProfile &)

void RemoveProfileL ( CSIPProfile & aProfile )
Remove profile
Pre-condition
UsageL(aProfile) == 0

Parameters

CSIPProfile & aProfile to be removed

RemovedL(TUint32)

void RemovedL ( TUint32 aProfileId )

SIP profile destruction event.

Parameters

TUint32 aProfileId id of profile which was destroyed

SIPProfileL(TUint32, TInt)

CSIPProfile * SIPProfileL ( TUint32 aId,
TInt aSize = 0
) [protected]

Gets SIP profile identified by the Id; leaves on failure The owneship of profile is transferred.

Parameters

TUint32 aId a SIP profile Id
TInt aSize = 0 of profile if known

StoreArrayL(RPointerArray< CSIPConcreteProfile > &, RPointerArray< CSIPProfile > &)

void StoreArrayL ( RPointerArray < CSIPConcreteProfile > & aProfiles,
RPointerArray < CSIPProfile > & aRetProfiles
) [protected]

Store array of profiles into client cache

Parameters

RPointerArray < CSIPConcreteProfile > & aProfiles a array containing the profiles
RPointerArray < CSIPProfile > & aRetProfiles returned array containing profiles

StoreProfileL(CSIPProfileCleanupItem *)

void StoreProfileL ( CSIPProfileCleanupItem * aItem ) [protected]

Store profile into client cache

Parameters

CSIPProfileCleanupItem * aItem a cleanup item for roll back in case of failure

SupportedProfileTypesL(RArray< TSIPProfileTypeInfo > &)

IMPORT_C void SupportedProfileTypesL ( RArray < TSIPProfileTypeInfo > & aSupportedProfileTypes )
Gets supported profile types The owneship of returned objects are transferred.
Pre-condition
aSupportedProfileTypes.Count() == 0
leave
KErrNoMemory if out of memory

Parameters

RArray < TSIPProfileTypeInfo > & aSupportedProfileTypes a reference to client-owned array, which on return is filled with supported profile types. Any existing data in the array is destroyed.

UpdateProfileL(CSIPProfile &)

void UpdateProfileL ( CSIPProfile & aProfile )

Update profile

Parameters

CSIPProfile & aProfile to be updated

UpdatedL(TUint32, TUint)

void UpdatedL ( TUint32 aProfileId,
TUint aSize
)

SIP profile information update event

Parameters

TUint32 aProfileId id of updated SIP Profile
TUint aSize size of updated SIP Profile

UsageL(const CSIPProfile &)

TInt UsageL ( const CSIPProfile & aProfile ) const

Gets count of clients that have a profile enabled

Parameters

const CSIPProfile & aProfile profile to be checked

Member Data Documentation

CSIPProfileItem * iFindEntry

CSIPProfileItem * iFindEntry [protected]

CSIPProfileITC * iITC

CSIPProfileITC * iITC [protected]

CSIPProfileITCReceiver * iITCReceiver

CSIPProfileITCReceiver * iITCReceiver [protected]

MSIPProfileRegistryObserver & iObserver

MSIPProfileRegistryObserver & iObserver [protected]

CSIPProfilePlugins * iProfilePlugins

CSIPProfilePlugins * iProfilePlugins [protected]

RPointerArray< CSIPProfileItem > iProfiles

RPointerArray < CSIPProfileItem > iProfiles [protected]

RSIPProfile * iSipClient

RSIPProfile * iSipClient [protected]

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.