Class CSIPProfileRegistry

class CSIPProfileRegistry : public CSIPProfileRegistryBase;

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

sipprofilecli.lib

Derivation

• MSIPConcreteProfileObserver - Observer class to be implemented by users of CSIPConcreteProfile It provides event notifications related to profiles
• CBase - Base class for all classes to be instantiated on the heap

• CSIPProfileRegistryBase - The class functions for retrieving SIP profiles from permanent storage

• CSIPProfileRegistry - The class for retrieving SIP profiles from permanent storage

Members

Defined in CSIPProfileRegistry:
ConnectionL(), Disable(), EnableL(), IsEnabled(), NewL(), NewLC(), SIP(), ~CSIPProfileRegistry()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CSIPProfileRegistryBase:
DefaultProfileL(), LastRegistrationError(), ProfileL(), ProfilesL(), SupportedProfileTypesL()

Inherited from MSIPConcreteProfileObserver:
AddedL(), ErrorOccurredL(), RegistrationStatusChangedL(), RemovedL(), UpdatedL()

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

Description

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

Parameters

CSIP &aSip a SIP client providing connection to SIP stack. MSIPProfileRegistryObserver &aObserver a observer for SIP profile change events.

Return value

CSIPProfileRegistry *

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

Description

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 &aSip a SIP client providing connection to SIP stack. MSIPProfileRegistryObserver &aObserver a observer for SIP profile change events.

Return value

CSIPProfileRegistry *

IMPORT_C ~CSIPProfileRegistry();

Description

Destructor

IMPORT_C CSIP &SIP() const;

Description

Gets handle to the SIP server

Return value

CSIP & handle to the SIP server

Capability:

NetworkServices

IMPORT_C CSIPConnection *ConnectionL(CSIPProfile &aProfile);

Pre-Condition

IsEnabled() == ETrue

Description

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

Parameters

CSIPProfile &aProfile a sip profile

Return value

CSIPConnection * a SIP connection to be used; the owneship is transfered

Leave codes

KErrNoMemory if out of memory

Capability:

NetworkServices

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

Description

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.

Parameters

CSIPProfile &aProfile a sip profile to enable MSIPConnectionObserver &aObserver a observer for SIP connection events

Leave codes

KErrNotFound if non-existing profile is provided

Capability:

NetworkServices

IMPORT_C TInt Disable(CSIPProfile &aProfile);

Description

Disables the usage of SIP profile

Parameters

CSIPProfile &aProfile a sip profile to disable

Return value

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

IMPORT_C TBool IsEnabled(const CSIPProfile &aProfile) const;

Description

Tests is the SIP profile enabled for the use

Parameters

const CSIPProfile &aProfile a SIP profile to be checked

Return value

TBool ETrue if SIP profile is enabled; EFalse otherwise