Symbian^3 Product 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

  • CSIPProfileRegistryBase
Public Member Functions
~CSIPProfileRegistryBase()
voidAddProfileL(CSIPProfile &)
voidAddedL(TUint32)
voidCrashRevert(TAny *)
IMPORT_C CSIPProfile *DefaultProfileL()
voidDisableProfileL(CSIPProfile &)
voidEnableProfileL(CSIPProfile &)
voidErrorOccurredL(TUint32, TInt, TInt)
voidForceDisableProfileL(CSIPProfile &)
TBool IsDefaultProfileL(const CSIPProfile &)
CSIPProfileITC &Itc()
CSIPProfileITCReceiver &ItcReceiver()
IMPORT_C TIntLastRegistrationError(const CSIPProfile &)
voidLocalCrashRevert(TAny *)
voidNegotiatedSecurityMechanismL(CSIPConcreteProfile &)
CSIPProfile *NewInstanceL()
voidProfileDeleted(CSIPProfile &)
IMPORT_C CSIPProfile *ProfileL(TUint32)
IMPORT_C voidProfilesL(RPointerArray< CSIPProfile > &)
IMPORT_C voidProfilesL(const TSIPProfileTypeInfo &, RPointerArray< CSIPProfile > &)
IMPORT_C voidProfilesL(const TDesC8 &, RPointerArray< CSIPProfile > &)
voidRegisteredAORsL(CSIPConcreteProfile &)
voidRegistrationStatusChangedL(TUint32, TInt, TUint32)
voidRemoveProfileL(CSIPProfile &)
voidRemovedL(TUint32)
IMPORT_C voidSupportedProfileTypesL(RArray< TSIPProfileTypeInfo > &)
voidUpdateProfileL(CSIPProfile &)
voidUpdatedL(TUint32, TUint)
TInt UsageL(const CSIPProfile &)
Protected Member Functions
CSIPProfileRegistryBase(MSIPProfileRegistryObserver &)
voidBaseConstructL()
TInt ProfileIndex(TUint)
CSIPProfileItem *ProfileItemByIndex(TUint)
CSIPProfileItem *ProfileItemL(TUint)
CSIPProfile *SIPProfileL(TUint32, TInt)
voidStoreArrayL(RPointerArray< CSIPConcreteProfile > &, RPointerArray< CSIPProfile > &)
voidStoreProfileL(CSIPProfileCleanupItem *)
Private Member Functions
voidProfilesCommonL(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 & aObserverobserver to send events to

~CSIPProfileRegistryBase()

IMPORT_C~CSIPProfileRegistryBase()

Member Functions Documentation

AddProfileL(CSIPProfile &)

voidAddProfileL(CSIPProfile &aProfile)

Add profile

Parameters

CSIPProfile & aProfileto be added

AddedL(TUint32)

voidAddedL(TUint32aProfileId)

SIP profile creation event.

Parameters

TUint32 aProfileIdid of new SIP Profile

BaseConstructL()

voidBaseConstructL()[protected]

Symbian 2nd phase base class constructor

CrashRevert(TAny *)

voidCrashRevert(TAny *aItem)[static]

Roll back in case of failure

Parameters

TAny * aItemobject 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 &)

voidDisableProfileL(CSIPProfile &aProfile)

Disable profile

Parameters

CSIPProfile & aProfileto be disabled

EnableProfileL(CSIPProfile &)

voidEnableProfileL(CSIPProfile &aProfile)

Enable profile

Parameters

CSIPProfile & aProfileto be enabled

ErrorOccurredL(TUint32, TInt, TInt)

voidErrorOccurredL(TUint32aProfileId,
TIntaStatus,
TIntaError
)

An asynchronous error has occurred related to SIP profile

Parameters

TUint32 aProfileIdthe id of failed profile
TInt aStatus
TInt aErrora error code

ForceDisableProfileL(CSIPProfile &)

voidForceDisableProfileL(CSIPProfile &aProfile)

Force disable profile All Profile related activities will be stopped ungracefully

Parameters

CSIPProfile & aProfileto be disabled

IsDefaultProfileL(const CSIPProfile &)

TBool IsDefaultProfileL(const CSIPProfile &aProfile)

Checks whether profile is default or not

Parameters

const CSIPProfile & aProfilechecked 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 TIntLastRegistrationError(const CSIPProfile &aProfile)const

Gets the last occurred error during registration

Parameters

const CSIPProfile & aProfile

LocalCrashRevert(TAny *)

voidLocalCrashRevert(TAny *aItem)[static]

Roll back in case of failure

Parameters

TAny * aItemobject to be cleaned

NegotiatedSecurityMechanismL(CSIPConcreteProfile &)

voidNegotiatedSecurityMechanismL(CSIPConcreteProfile &aProfile)

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

Parameters

CSIPConcreteProfile & aProfilea SIP profile

NewInstanceL()

CSIPProfile *NewInstanceL()[pure virtual]

Gets new instance of either type CSIPProfile or CSIPManagedProfile

ProfileDeleted(CSIPProfile &)

voidProfileDeleted(CSIPProfile &aProfile)

Informs destruction of local profile object instance

Parameters

CSIPProfile & aProfileinstance of deleted profile

ProfileIndex(TUint)

TInt ProfileIndex(TUintaProfileId)[protected]

Gets profile cache item index

Parameters

TUint aProfileIda profile id to be found

ProfileItemByIndex(TUint)

CSIPProfileItem *ProfileItemByIndex(TUintaIndex)[protected]

Gets profile cache item by index

Parameters

TUint aIndexa index of the profile to be found

ProfileItemL(TUint)

CSIPProfileItem *ProfileItemL(TUintaProfileId)[protected]

Gets profile cache item

Parameters

TUint aProfileIda profile id to be found

ProfileL(TUint32)

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

Parameters

TUint32 aIda SIP profile Id

ProfilesCommonL(RPointerArray< CSIPProfile > &, CSIPConcreteProfileHolder *)

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

Parameters

RPointerArray< CSIPProfile > & aProfiles
CSIPConcreteProfileHolder * aHolder

ProfilesL(RPointerArray< CSIPProfile > &)

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

Parameters

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

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

IMPORT_C voidProfilesL(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 & aTypea SIP profile type that is used for a query
RPointerArray< CSIPProfile > & aProfilesa reference to a client-owned array, which on return is filled with profiles of the given type.

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

IMPORT_C voidProfilesL(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 & aAORa SIP AOR e.g.
RPointerArray< CSIPProfile > & aProfilesa reference to a client-owned array, which on return is filled with profiles of the given type.

RegisteredAORsL(CSIPConcreteProfile &)

voidRegisteredAORsL(CSIPConcreteProfile &aProfile)

Updates SIP profile value for registered AORs; leaves on failure

Parameters

CSIPConcreteProfile & aProfilea SIP profile

RegistrationStatusChangedL(TUint32, TInt, TUint32)

voidRegistrationStatusChangedL(TUint32aProfileId,
TIntaStatus,
TUint32aStatusId
)

SIP profile registration status changed event

Parameters

TUint32 aProfileIdid of profile which registration status has been changed.
TInt aStatusnew status of the profile
TUint32 aStatusIdid related to registration

RemoveProfileL(CSIPProfile &)

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

Parameters

CSIPProfile & aProfileto be removed

RemovedL(TUint32)

voidRemovedL(TUint32aProfileId)

SIP profile destruction event.

Parameters

TUint32 aProfileIdid of profile which was destroyed

SIPProfileL(TUint32, TInt)

CSIPProfile *SIPProfileL(TUint32aId,
TIntaSize = 0
)[protected]

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

Parameters

TUint32 aIda SIP profile Id
TInt aSize = 0of profile if known

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

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

Store array of profiles into client cache

Parameters

RPointerArray< CSIPConcreteProfile > & aProfilesa array containing the profiles
RPointerArray< CSIPProfile > & aRetProfilesreturned array containing profiles

StoreProfileL(CSIPProfileCleanupItem *)

voidStoreProfileL(CSIPProfileCleanupItem *aItem)[protected]

Store profile into client cache

Parameters

CSIPProfileCleanupItem * aItema cleanup item for roll back in case of failure

SupportedProfileTypesL(RArray< TSIPProfileTypeInfo > &)

IMPORT_C voidSupportedProfileTypesL(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 > & aSupportedProfileTypesa reference to client-owned array, which on return is filled with supported profile types. Any existing data in the array is destroyed.

UpdateProfileL(CSIPProfile &)

voidUpdateProfileL(CSIPProfile &aProfile)

Update profile

Parameters

CSIPProfile & aProfileto be updated

UpdatedL(TUint32, TUint)

voidUpdatedL(TUint32aProfileId,
TUintaSize
)

SIP profile information update event

Parameters

TUint32 aProfileIdid of updated SIP Profile
TUint aSizesize 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 & aProfileprofile 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.