CSIPProfileRegistry Class Reference

#include <mw/sipprofileregistry.h>

Link against: sipprofilecli.lib

class CSIPProfileRegistry : public CSIPProfileRegistryBase

Inherits from

CSIPProfileRegistry
- CSIPProfileRegistryBase

Public Member Functions
	~CSIPProfileRegistry()
IMPORT_C CSIPConnection *	ConnectionL(CSIPProfile &)
IMPORT_C TInt	Disable(CSIPProfile &)
IMPORT_C void	EnableL(CSIPProfile &, MSIPConnectionObserver &)
IMPORT_C TInt	ForceDisable(CSIPProfile &)
IMPORT_C TBool	IsEnabled(const CSIPProfile &)
virtual CSIPProfile *	NewInstanceL()
IMPORT_C CSIPProfileRegistry *	NewL(CSIP &, MSIPProfileRegistryObserver &)
IMPORT_C CSIPProfileRegistry *	NewLC(CSIP &, MSIPProfileRegistryObserver &)
IMPORT_C void	RefreshEnableL(CSIPProfile &)
IMPORT_C CSIP &	SIP()

Inherited Attributes
	CSIPProfileRegistryBase::iFindEntry
	CSIPProfileRegistryBase::iITC
	CSIPProfileRegistryBase::iITCReceiver
	CSIPProfileRegistryBase::iObserver
	CSIPProfileRegistryBase::iProfilePlugins
	CSIPProfileRegistryBase::iProfiles
	CSIPProfileRegistryBase::iSipClient

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()
	CSIPProfileRegistryBase::AddProfileL(CSIPProfile &)
	CSIPProfileRegistryBase::AddedL(TUint32)
	CSIPProfileRegistryBase::BaseConstructL()
	CSIPProfileRegistryBase::CSIPProfileRegistryBase(MSIPProfileRegistryObserver &)
	CSIPProfileRegistryBase::CrashRevert(TAny *)
	CSIPProfileRegistryBase::DefaultProfileL()
	CSIPProfileRegistryBase::DisableProfileL(CSIPProfile &)
	CSIPProfileRegistryBase::EnableProfileL(CSIPProfile &)
	CSIPProfileRegistryBase::ErrorOccurredL(TUint32,TInt,TInt)
	CSIPProfileRegistryBase::ForceDisableProfileL(CSIPProfile &)
	CSIPProfileRegistryBase::IsDefaultProfileL(const CSIPProfile &)
	CSIPProfileRegistryBase::Itc()
	CSIPProfileRegistryBase::ItcReceiver()
	CSIPProfileRegistryBase::LastRegistrationError(const CSIPProfile &)const
	CSIPProfileRegistryBase::LocalCrashRevert(TAny *)
	CSIPProfileRegistryBase::NegotiatedSecurityMechanismL(CSIPConcreteProfile &)
	CSIPProfileRegistryBase::ProfileDeleted(CSIPProfile &)
	CSIPProfileRegistryBase::ProfileIndex(TUint)
	CSIPProfileRegistryBase::ProfileItemByIndex(TUint)
	CSIPProfileRegistryBase::ProfileItemL(TUint)
	CSIPProfileRegistryBase::ProfileL(TUint32)
	CSIPProfileRegistryBase::ProfilesL(RPointerArray< CSIPProfile > &)
	CSIPProfileRegistryBase::ProfilesL(const TDesC8 &,RPointerArray< CSIPProfile > &)
	CSIPProfileRegistryBase::ProfilesL(const TSIPProfileTypeInfo &,RPointerArray< CSIPProfile > &)
	CSIPProfileRegistryBase::RegisteredAORsL(CSIPConcreteProfile &)
	CSIPProfileRegistryBase::RegistrationStatusChangedL(TUint32,TInt,TUint32)
	CSIPProfileRegistryBase::RemoveProfileL(CSIPProfile &)
	CSIPProfileRegistryBase::RemovedL(TUint32)
	CSIPProfileRegistryBase::SIPProfileL(TUint32,TInt)
	CSIPProfileRegistryBase::StoreArrayL(RPointerArray< CSIPConcreteProfile > &,RPointerArray< CSIPProfile > &)
	CSIPProfileRegistryBase::StoreProfileL(CSIPProfileCleanupItem *)
	CSIPProfileRegistryBase::SupportedProfileTypesL(RArray< TSIPProfileTypeInfo > &)
	CSIPProfileRegistryBase::UpdateProfileL(CSIPProfile &)
	CSIPProfileRegistryBase::UpdatedL(TUint32,TUint)
	CSIPProfileRegistryBase::UsageL(const CSIPProfile &)const
	CSIPProfileRegistryBase::~CSIPProfileRegistryBase()

Detailed Description

The class for retrieving SIP profiles from permanent storage. This class provides services for retreiving SIP profiles and enabling/disabling them for the usage.

The user can create only one instance of this class (a singleton class).

Constructor & Destructor Documentation

~CSIPProfileRegistry ( )

IMPORT_C

~CSIPProfileRegistry

(

)

Destructor

Member Function Documentation

ConnectionL ( CSIPProfile & )

IMPORT_C CSIPConnection *

ConnectionL

(

CSIPProfile &

aProfile

)

Gets the SIP connection to be used with this SIP profile.

Pre-condition: IsEnabled() == ETrue

leave: KErrNoMemory if out of memory

capability: NetworkServices

Parameter	Description
aProfile	a sip profile

Returns: a SIP connection to be used; the owneship is transfered

Disable ( CSIPProfile & )

IMPORT_C TInt

Disable

(

CSIPProfile &

aProfile

)

Disables the usage of SIP profile

capability: NetworkServices

Parameter	Description
aProfile	a sip profile to disable

Returns: KErrNone if SIP profile was successfully disabled; system wide error otherwise

EnableL ( CSIPProfile &, MSIPConnectionObserver & )

IMPORT_C void	EnableL	(	CSIPProfile &	aProfile,
			MSIPConnectionObserver &	aObserver
		)

Enables the SIP profile for use. Enabling the SIP profile will cause the SIP profile to be registered if its status was unregistered. The user must check the profile status after calling this function. In case the profile is not registered the user must wait until the it is notified about profile registration on MSIPProfileRegistryObserver-callback interface.

leave: KErrNotFound if non-existing profile is provided

capability: NetworkServices

Parameter	Description
aProfile	a sip profile to enable
aObserver	a observer for SIP connection events

ForceDisable ( CSIPProfile & )

IMPORT_C TInt

ForceDisable

(

CSIPProfile &

aProfile

)

Force disables the usage of SIP profile All Profile related activities will be stopped ungracefully

capability: NetworkControl

Parameter	Description
aProfile	a sip profile to disable

Returns: KErrNone if SIP profile was successfully disabled; system wide error otherwise

IsEnabled ( const CSIPProfile & )

IMPORT_C TBool

IsEnabled

(

const CSIPProfile &

aProfile

)

const

Tests is the SIP profile enabled for the use

Parameter	Description
aProfile	a SIP profile to be checked

Returns: ETrue if SIP profile is enabled; EFalse otherwise

NewInstanceL ( )

CSIPProfile *

NewInstanceL

(

)

[virtual]

Reimplemented from CSIPProfileRegistryBase::NewInstanceL()

NewL ( CSIP &, MSIPProfileRegistryObserver & )

IMPORT_C CSIPProfileRegistry *	NewL	(	CSIP &	aSip,
			MSIPProfileRegistryObserver &	aObserver
		)	[static]

Two-phased constructor. This constructor should be used if the client intends to use SIP services with profiles.

Parameter	Description
aSip	a SIP client providing connection to SIP stack.
aObserver	a observer for SIP profile change events.

NewLC ( CSIP &, MSIPProfileRegistryObserver & )

IMPORT_C CSIPProfileRegistry *	NewLC	(	CSIP &	aSip,
			MSIPProfileRegistryObserver &	aObserver
		)	[static]

Two-phased constructor. This constructor should be used if the client intends to use SIP services with profiles. Constructs an object and adds the pointer to the cleanup stack;

Parameter	Description
aSip	a SIP client providing connection to SIP stack.
aObserver	a observer for SIP profile change events.

RefreshEnableL ( CSIPProfile & )

IMPORT_C void

RefreshEnableL

(

CSIPProfile &

aProfile

)

Refreshes the Enabled SIP profile for use. Refreshing the Enabled Profile will cause the SIP Profile to get Registered if its status was not registered. This function has to be used when the profile is in Enabled state and might be unregistered due to a connection loss.

leave: KErrNotFound if non-existing profile is provided

leave: KErrArgument if the profile is not previously Enabled and in Unregistered state.

capability: NetworkServices

Parameter	Description
aProfile	a sip profile to enable

SIP ( )

IMPORT_C CSIP &

SIP

(

)

const

Gets handle to the SIP server

Returns: handle to the SIP server