CSIPProfileRegistry Class Reference

class CSIPProfileRegistry : public CSIPProfileRegistryBase

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

sipprofilecli.lib

Inherits from

Public Member Functions
~CSIPProfileRegistry()
IMPORT_C CSIPConnection *ConnectionL(CSIPProfile &)
IMPORT_C TIntDisable(CSIPProfile &)
IMPORT_C voidEnableL(CSIPProfile &, MSIPConnectionObserver &)
IMPORT_C TIntForceDisable(CSIPProfile &)
IMPORT_C TBoolIsEnabled(const CSIPProfile &)
CSIPProfile *NewInstanceL()
IMPORT_C CSIPProfileRegistry *NewL(CSIP &, MSIPProfileRegistryObserver &)
IMPORT_C CSIPProfileRegistry *NewLC(CSIP &, MSIPProfileRegistryObserver &)
IMPORT_C voidRefreshEnableL(CSIPProfile &)
IMPORT_C CSIP &SIP()
Private Member Functions
CSIPProfileRegistry()
CSIPProfileRegistry(CSIP &, MSIPProfileRegistryObserver &)
voidConstructL()
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()
Private Attributes
MSIPConnectionObserver *iConnectionObserver
CSIP &iSip
Inherited Attributes
CSIPProfileRegistryBase::iFindEntry
CSIPProfileRegistryBase::iITC
CSIPProfileRegistryBase::iITCReceiver
CSIPProfileRegistryBase::iObserver
CSIPProfileRegistryBase::iProfilePlugins
CSIPProfileRegistryBase::iProfiles
CSIPProfileRegistryBase::iSipClient

Constructor & Destructor Documentation

CSIPProfileRegistry()

CSIPProfileRegistry()[private]

CSIPProfileRegistry(CSIP &, MSIPProfileRegistryObserver &)

CSIPProfileRegistry(CSIP &aSip,
MSIPProfileRegistryObserver &aObserver
)[private]

Parameters

CSIP & aSip
MSIPProfileRegistryObserver & aObserver

~CSIPProfileRegistry()

IMPORT_C~CSIPProfileRegistry()

Destructor

Member Functions 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

Parameters

CSIPProfile & aProfilea sip profile

ConstructL()

voidConstructL()[private]

Disable(CSIPProfile &)

IMPORT_C TIntDisable(CSIPProfile &aProfile)
Disables the usage of SIP profile
capability
NetworkServices

Parameters

CSIPProfile & aProfilea sip profile to disable

EnableL(CSIPProfile &, MSIPConnectionObserver &)

IMPORT_C voidEnableL(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

Parameters

CSIPProfile & aProfilea sip profile to enable
MSIPConnectionObserver & aObservera observer for SIP connection events

ForceDisable(CSIPProfile &)

IMPORT_C TIntForceDisable(CSIPProfile &aProfile)
Force disables the usage of SIP profile All Profile related activities will be stopped ungracefully
capability
NetworkControl

Parameters

CSIPProfile & aProfilea sip profile to disable

IsEnabled(const CSIPProfile &)

IMPORT_C TBoolIsEnabled(const CSIPProfile &aProfile)const

Tests is the SIP profile enabled for the use

Parameters

const CSIPProfile & aProfilea SIP profile to be checked

NewInstanceL()

CSIPProfile *NewInstanceL()[virtual]

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.

Parameters

CSIP & aSipa SIP client providing connection to SIP stack.
MSIPProfileRegistryObserver & aObservera 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;

Parameters

CSIP & aSipa SIP client providing connection to SIP stack.
MSIPProfileRegistryObserver & aObservera observer for SIP profile change events.

RefreshEnableL(CSIPProfile &)

IMPORT_C voidRefreshEnableL(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

Parameters

CSIPProfile & aProfilea sip profile to enable

SIP()

IMPORT_C CSIP &SIP()const

Gets handle to the SIP server

Member Data Documentation

MSIPConnectionObserver * iConnectionObserver

MSIPConnectionObserver *iConnectionObserver[private]

CSIP & iSip

CSIP &iSip[private]