CSIPProfileRegistryBase Class Reference

#include <mw/sipprofileregistrybase.h>

Link against: sipprofilecli.lib

class CSIPProfileRegistryBase : public CBase, public MSIPConcreteProfileObserver

Inherits from

CSIPProfileRegistryBase
- CBase
- MSIPConcreteProfileObserver

Protected Attributes
CSIPProfileItem *	iFindEntry
CSIPProfileITC *	iITC
CSIPProfileITCReceiver *	iITCReceiver
MSIPProfileRegistryObserver &	iObserver
CSIPProfilePlugins *	iProfilePlugins
RPointerArray< CSIPProfileItem >	iProfiles
RSIPProfile *	iSipClient

Public Member Functions
	~CSIPProfileRegistryBase()
void	AddProfileL(CSIPProfile &)
virtual void	AddedL(TUint32)
void	CrashRevert(TAny *)
IMPORT_C CSIPProfile *	DefaultProfileL()
void	DisableProfileL(CSIPProfile &)
void	EnableProfileL(CSIPProfile &)
virtual 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 &)
pure virtual 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 &)
virtual void	RegistrationStatusChangedL(TUint32, TInt, TUint32)
void	RemoveProfileL(CSIPProfile &)
virtual void	RemovedL(TUint32)
IMPORT_C void	SupportedProfileTypesL(RArray< TSIPProfileTypeInfo > &)
void	UpdateProfileL(CSIPProfile &)
virtual 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 *)

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()

Detailed Description

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.

Member Attribute Documentation

iFindEntry

CSIPProfileItem *

iFindEntry

[protected]

iITC

CSIPProfileITC *

iITC

[protected]

iITCReceiver

CSIPProfileITCReceiver *

iITCReceiver

[protected]

iObserver

MSIPProfileRegistryObserver &

iObserver

[protected]

iProfilePlugins

CSIPProfilePlugins *

iProfilePlugins

[protected]

iProfiles

RPointerArray< CSIPProfileItem >

iProfiles

[protected]

iSipClient

RSIPProfile *

iSipClient

[protected]

Constructor & Destructor Documentation

CSIPProfileRegistryBase ( MSIPProfileRegistryObserver & )

CSIPProfileRegistryBase

(

MSIPProfileRegistryObserver &

aObserver

)

[protected]

Constructor

Parameters
aObserver	observer to send events to

~CSIPProfileRegistryBase ( )

IMPORT_C

~CSIPProfileRegistryBase

(

)

Member Function Documentation

AddProfileL ( CSIPProfile & )

void

AddProfileL

(

CSIPProfile &

aProfile

)

Add profile

Parameters
aProfile	to be added

AddedL ( TUint32 )

void

AddedL

(

TUint32

aProfileId

)

[virtual]

Reimplemented from MSIPConcreteProfileObserver::AddedL(TUint32)

SIP profile creation event.

Parameters
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
aItem	object to be cleaned

DefaultProfileL ( )

IMPORT_C CSIPProfile *

DefaultProfileL

(

)

Gets the default profile

Return Value: default profile; the owneship is transfered

Leave Codes
KErrNotFound	if profile not found
KErrNoMemory	if out of memory

Capability
ReadUserData

DisableProfileL ( CSIPProfile & )

void

DisableProfileL

(

CSIPProfile &

aProfile

)

Disable profile

Parameters
aProfile	to be disabled

EnableProfileL ( CSIPProfile & )

void

EnableProfileL

(

CSIPProfile &

aProfile

)

Enable profile

Parameters
aProfile	to be enabled

ErrorOccurredL ( TUint32, TInt, TInt )

void	ErrorOccurredL	(	TUint32	aProfileId,
			TInt	aStatus,
			TInt	aError
		)	[virtual]

Reimplemented from MSIPConcreteProfileObserver::ErrorOccurredL(TUint32,TInt,TInt)

An asynchronous error has occurred related to SIP profile

Parameters
aProfileId	the id of failed profile
aError	a error code

ForceDisableProfileL ( CSIPProfile & )

void

ForceDisableProfileL

(

CSIPProfile &

aProfile

)

Force disable profile All Profile related activities will be stopped ungracefully

Parameters
aProfile	to be disabled

IsDefaultProfileL ( const CSIPProfile & )

TBool

IsDefaultProfileL

(

const CSIPProfile &

aProfile

)

Checks whether profile is default or not

Parameters
aProfile	checked profile

Return Value: ETrue if is default, otherwise EFalse

Itc ( )

CSIPProfileITC &

Itc

(

)

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

Return Value: Reference to ITC member variable.

ItcReceiver ( )

CSIPProfileITCReceiver &

ItcReceiver

(

)

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

Return Value: Reference to ITC receiver member variable.

LastRegistrationError ( const CSIPProfile & )

IMPORT_C TInt

LastRegistrationError

(

const CSIPProfile &

aProfile

)

const

Gets the last occurred error during registration

Return Value: last occurred registration error, KErrNone if no error

LocalCrashRevert ( TAny * )

void

LocalCrashRevert

(

TAny *

aItem

)

[static]

Roll back in case of failure

Parameters
aItem	object to be cleaned

NegotiatedSecurityMechanismL ( CSIPConcreteProfile & )

void

NegotiatedSecurityMechanismL

(

CSIPConcreteProfile &

aProfile

)

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

Parameters
aProfile	a SIP profile

NewInstanceL ( )

CSIPProfile *

NewInstanceL

(

)

[pure virtual]

Gets new instance of either type CSIPProfile or CSIPManagedProfile

Return Value: new instance

ProfileDeleted ( CSIPProfile & )

void

ProfileDeleted

(

CSIPProfile &

aProfile

)

Informs destruction of local profile object instance

Parameters
aProfile	instance of deleted profile

ProfileIndex ( TUint )

TInt

ProfileIndex

(

TUint

aProfileId

)

[protected]

Gets profile cache item index

Parameters
aProfileId	a profile id to be found

Return Value: local cache item index of the profile

ProfileItemByIndex ( TUint )

CSIPProfileItem *

ProfileItemByIndex

(

TUint

aIndex

)

[protected]

Gets profile cache item by index

Parameters
aIndex	a index of the profile to be found

Return Value: local cache item of the profile

ProfileItemL ( TUint )

CSIPProfileItem *

ProfileItemL

(

TUint

aProfileId

)

[protected]

Gets profile cache item

Parameters
aProfileId	a profile id to be found

Return Value: local cache item of the profile

ProfileL ( TUint32 )

IMPORT_C CSIPProfile *

ProfileL

(

TUint32

aId

)

Gets SIP profile identified by the Id The owneship of profile is transferred.

Parameters
aId	a SIP profile Id

Return Value: SIP profile

Leave Codes
KErrNotFound	if profile is not found

Capability
ReadUserData

ProfilesL ( RPointerArray< CSIPProfile > & )

IMPORT_C void

ProfilesL

(

RPointerArray< CSIPProfile > &

aProfiles

)

Gets all SIP profiles

Pre-condition: aProfiles.Count() == 0

Parameters
aProfiles	a reference to a client-owned array, which on return is filled with all existing SIP profiles

Leave Codes
KErrNoMemory	if out of memory

Capability
ReadUserData

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

Parameters
aType	a SIP profile type that is used for a query
aProfiles	a reference to a client-owned array, which on return is filled with profiles of the given type.

Leave Codes
KErrNoMemory	if out of memory

Capability
ReadUserData

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

Parameters
aAOR	a SIP AOR e.g. [email protected]
aProfiles	a reference to a client-owned array, which on return is filled with profiles of the given type.

Leave Codes
KErrNoMemory	if out memory

Capability
ReadUserData

RegisteredAORsL ( CSIPConcreteProfile & )

void

RegisteredAORsL

(

CSIPConcreteProfile &

aProfile

)

Updates SIP profile value for registered AORs; leaves on failure

Parameters
aProfile	a SIP profile

RegistrationStatusChangedL ( TUint32, TInt, TUint32 )

void	RegistrationStatusChangedL	(	TUint32	aProfileId,
			TInt	aStatus,
			TUint32	aStatusId
		)	[virtual]

Reimplemented from MSIPConcreteProfileObserver::RegistrationStatusChangedL(TUint32,TInt,TUint32)

SIP profile registration status changed event

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

RemoveProfileL ( CSIPProfile & )

void

RemoveProfileL

(

CSIPProfile &

aProfile

)

Remove profile

Pre-condition: UsageL(aProfile) == 0

Parameters
aProfile	to be removed

RemovedL ( TUint32 )

void

RemovedL

(

TUint32

aProfileId

)

[virtual]

Reimplemented from MSIPConcreteProfileObserver::RemovedL(TUint32)

SIP profile destruction event.

Parameters
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
aId	a SIP profile Id
aSize	of profile if known

Return Value: SIP profile or 0 pointer if there's no such SIP profile

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

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

Store array of profiles into client cache

Parameters
aProfiles	a array containing the profiles
aRetProfiles	returned array containing profiles

StoreProfileL ( CSIPProfileCleanupItem * )

void

StoreProfileL

(

CSIPProfileCleanupItem *

aItem

)

[protected]

Store profile into client cache

Parameters
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

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

Leave Codes
KErrNoMemory	if out of memory

UpdateProfileL ( CSIPProfile & )

void

UpdateProfileL

(

CSIPProfile &

aProfile

)

Update profile

Parameters
aProfile	to be updated

UpdatedL ( TUint32, TUint )

void	UpdatedL	(	TUint32	aProfileId,
			TUint	aSize
		)	[virtual]

Reimplemented from MSIPConcreteProfileObserver::UpdatedL(TUint32,TUint)

SIP profile information update event

Parameters
aProfileId	id of updated SIP Profile
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
aProfile	profile to be checked

Return Value: number of clients that have the profile enabled