S60 3rd Edition API Reference: CSIPProfileRegistryBase Class Reference

CSIPProfileRegistryBase Class Reference

API published in: S60 2nd Ed

Link against: sipprofilecli.lib

Capability Information

Required Capabilities

Location NetworkControl NetworkServices ReadDeviceData ReadUserData WriteDeviceData

#include <sipprofileregistrybase.h>

Inherits MSIPConcreteProfileObserver.

Inherited by CSIPProfileRegistry.

Detailed Description

PublishedAll
Released
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.


Public Member Functions

IMPORT_C ~CSIPProfileRegistryBase ()
IMPORT_C void ProfilesL (RPointerArray< CSIPProfile > &aProfiles)
 Gets all SIP profiles.
IMPORT_C void ProfilesL (const TSIPProfileTypeInfo &aType, RPointerArray< CSIPProfile > &aProfiles)
 Gets all SIP profiles of particular type The owneship of profiles are transferred.
IMPORT_C void ProfilesL (const TDesC8 &aAOR, RPointerArray< CSIPProfile > &aProfiles)
 Gets SIP profile for a particular SIP AOR The owneship of profiles are transferred.
IMPORT_C CSIPProfile * ProfileL (TUint32 aId)
 Gets SIP profile identified by the Id The owneship of profile is transferred.
IMPORT_C CSIPProfile * DefaultProfileL ()
 Gets the default profile.
IMPORT_C void SupportedProfileTypesL (RArray< TSIPProfileTypeInfo > &aSupportedProfileTypes)
 Gets supported profile types The owneship of returned objects are transferred.
IMPORT_C TInt LastRegistrationError (const CSIPProfile &aProfile) const
 Gets the last occurred error during registration.
void EnableProfileL (CSIPProfile &aProfile)
 Enable profile.
TInt UsageL (const CSIPProfile &aProfile) const
 Gets count of clients that have a profile enabled.
void DisableProfileL (CSIPProfile &aProfile)
 Disable profile.
void AddProfileL (CSIPProfile &aProfile)
 Add profile.
void UpdateProfileL (CSIPProfile &aProfile)
 Update profile.
void RemoveProfileL (CSIPProfile &aProfile)
 Remove profile.
void ProfileDeleted (CSIPProfile &aProfile)
 Informs destruction of local profile object instance.
TBool IsDefaultProfileL (const CSIPProfile &aProfile)
 Checks whether profile is default or not.
void NegotiatedSecurityMechanismL (CSIPConcreteProfile &aProfile)
 Updates SIP profile value for negotiated security mechanism; leaves on failure.
void RegisteredAORsL (CSIPConcreteProfile &aProfile)
 Updates SIP profile value for registered AORs; leaves on failure.
virtual CSIPProfile * NewInstanceL ()=0
 Gets new instance of either type CSIPProfile or CSIPManagedProfile.
void RegistrationStatusChangedL (TUint32 aProfileId, TInt aStatus, TUint32 aStatusId)
 SIP profile registration status changed event.
void AddedL (TUint32 aProfileId)
 SIP profile creation event.
void RemovedL (TUint32 aProfileId)
 SIP profile destruction event.
void UpdatedL (TUint32 aProfileId, TUint aSize)
 SIP profile information update event.
void ErrorOccurredL (TUint32 aProfileId, TInt aStatus, TInt aError)
 An asynchronous error has occurred related to SIP profile.

Static Public Member Functions

static void CrashRevert (TAny *aItem)
 Roll back in case of failure.
static void LocalCrashRevert (TAny *aItem)
 Roll back in case of failure.

Protected Member Functions

 CSIPProfileRegistryBase (MSIPProfileRegistryObserver &aObserver)
 Constructor.
void BaseConstructL ()
 Symbian 2nd phase base class constructor.
void StoreProfileL (CSIPProfileCleanupItem *aItem)
 Store profile into client cache.
void StoreArrayL (RPointerArray< CSIPConcreteProfile > &aProfiles, RPointerArray< CSIPProfile > &aRetProfiles)
 Store array of profiles into client cache.
CSIPProfileItem * ProfileItemL (TUint aProfileId)
 Gets profile cache item.
TInt ProfileIndex (TUint aProfileId)
 Gets profile cache item index.
CSIPProfileItem * ProfileItemByIndex (TUint aIndex)
 Gets profile cache item by index.
CSIPProfile * SIPProfileL (TUint32 aId, TInt aSize=0)
 Gets SIP profile identified by the Id; leaves on failure The owneship of profile is transferred.

Protected Attributes

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

Constructor & Destructor Documentation

IMPORT_C CSIPProfileRegistryBase::~CSIPProfileRegistryBase (   ) 
 
CSIPProfileRegistryBase::CSIPProfileRegistryBase ( MSIPProfileRegistryObserver &  aObserver  )  [protected]
 

Constructor.

Parameters:
aObserver observer to send events to

Member Function Documentation

void CSIPProfileRegistryBase::AddedL ( TUint32  aProfileId  )  [virtual]
 

SIP profile creation event.

Parameters:
aProfileId id of new SIP Profile

Implements MSIPConcreteProfileObserver.

void CSIPProfileRegistryBase::AddProfileL ( CSIPProfile &  aProfile  ) 
 

Add profile.

Parameters:
aProfile to be added
void CSIPProfileRegistryBase::BaseConstructL (   )  [protected]
 

Symbian 2nd phase base class constructor.

static void CSIPProfileRegistryBase::CrashRevert ( TAny *  aItem  )  [static]
 

Roll back in case of failure.

Parameters:
aItem object to be cleaned
IMPORT_C CSIPProfile* CSIPProfileRegistryBase::DefaultProfileL (   ) 
 

Gets the default profile.

Returns:
default profile; the owneship is transfered
Leave:
KErrNotFound if profile not found
Leave:
KErrNoMemory if out of memory ReadUserData
void CSIPProfileRegistryBase::DisableProfileL ( CSIPProfile &  aProfile  ) 
 

Disable profile.

Parameters:
aProfile to be disabled
void CSIPProfileRegistryBase::EnableProfileL ( CSIPProfile &  aProfile  ) 
 

Enable profile.

Parameters:
aProfile to be enabled
void CSIPProfileRegistryBase::ErrorOccurredL ( TUint32  aProfileId,
TInt  aStatus,
TInt  aError
)  [virtual]
 

An asynchronous error has occurred related to SIP profile.

Parameters:
aProfileId the id of failed profile
aStatus 
aError a error code

Implements MSIPConcreteProfileObserver.

TBool CSIPProfileRegistryBase::IsDefaultProfileL ( const CSIPProfile &  aProfile  ) 
 

Checks whether profile is default or not.

Parameters:
aProfile checked profile
Returns:
ETrue if is default, otherwise EFalse
IMPORT_C TInt CSIPProfileRegistryBase::LastRegistrationError ( const CSIPProfile &  aProfile  )  const
 

Gets the last occurred error during registration.

Parameters:
aProfile 
Returns:
last occurred registration error, KErrNone if no error
static void CSIPProfileRegistryBase::LocalCrashRevert ( TAny *  aItem  )  [static]
 

Roll back in case of failure.

Parameters:
aItem object to be cleaned
void CSIPProfileRegistryBase::NegotiatedSecurityMechanismL ( CSIPConcreteProfile &  aProfile  ) 
 

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

Parameters:
aProfile a SIP profile
virtual CSIPProfile* CSIPProfileRegistryBase::NewInstanceL (   )  [pure virtual]
 

Gets new instance of either type CSIPProfile or CSIPManagedProfile.

Returns:
new instance

Implemented in CSIPProfileRegistry.

void CSIPProfileRegistryBase::ProfileDeleted ( CSIPProfile &  aProfile  ) 
 

Informs destruction of local profile object instance.

Parameters:
aProfile instance of deleted profile
TInt CSIPProfileRegistryBase::ProfileIndex ( TUint  aProfileId  )  [protected]
 

Gets profile cache item index.

Parameters:
aProfileId a profile id to be found
Returns:
local cache item index of the profile
CSIPProfileItem* CSIPProfileRegistryBase::ProfileItemByIndex ( TUint  aIndex  )  [protected]
 

Gets profile cache item by index.

Parameters:
aIndex a index of the profile to be found
Returns:
local cache item of the profile
CSIPProfileItem* CSIPProfileRegistryBase::ProfileItemL ( TUint  aProfileId  )  [protected]
 

Gets profile cache item.

Parameters:
aProfileId a profile id to be found
Returns:
local cache item of the profile
IMPORT_C CSIPProfile* CSIPProfileRegistryBase::ProfileL ( TUint32  aId  ) 
 

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

Parameters:
aId a SIP profile Id
Returns:
SIP profile
Leave:
KErrNotFound if profile is not found ReadUserData
IMPORT_C void CSIPProfileRegistryBase::ProfilesL ( const TDesC8 &  aAOR,
RPointerArray< CSIPProfile > &  aProfiles
) 
 

Gets SIP profile for a particular SIP AOR The owneship of profiles are transferred.

Precondition:
aProfiles.Count() == 0
Parameters:
aAOR a SIP AOR e.g. user@domain.com
aProfiles a reference to a client-owned array, which on return is filled with profiles of the given type.
Leave:
KErrNoMemory if out memory ReadUserData
IMPORT_C void CSIPProfileRegistryBase::ProfilesL ( const TSIPProfileTypeInfo &  aType,
RPointerArray< CSIPProfile > &  aProfiles
) 
 

Gets all SIP profiles of particular type The owneship of profiles are transferred.

Precondition:
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:
KErrNoMemory if out of memory ReadUserData
IMPORT_C void CSIPProfileRegistryBase::ProfilesL ( RPointerArray< CSIPProfile > &  aProfiles  ) 
 

Gets all SIP profiles.

Precondition:
aProfiles.Count() == 0
Parameters:
aProfiles a reference to a client-owned array, which on return is filled with all existing SIP profiles
Leave:
KErrNoMemory if out of memory ReadUserData
void CSIPProfileRegistryBase::RegisteredAORsL ( CSIPConcreteProfile &  aProfile  ) 
 

Updates SIP profile value for registered AORs; leaves on failure.

Parameters:
aProfile a SIP profile
void CSIPProfileRegistryBase::RegistrationStatusChangedL ( TUint32  aProfileId,
TInt  aStatus,
TUint32  aStatusId
)  [virtual]
 

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

Implements MSIPConcreteProfileObserver.

void CSIPProfileRegistryBase::RemovedL ( TUint32  aProfileId  )  [virtual]
 

SIP profile destruction event.

Parameters:
aProfileId id of profile which was destroyed

Implements MSIPConcreteProfileObserver.

void CSIPProfileRegistryBase::RemoveProfileL ( CSIPProfile &  aProfile  ) 
 

Remove profile.

Precondition:
UsageL(aProfile) == 0
Parameters:
aProfile to be removed
CSIPProfile* CSIPProfileRegistryBase::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
Returns:
SIP profile or 0 pointer if there's no such SIP profile
void CSIPProfileRegistryBase::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
void CSIPProfileRegistryBase::StoreProfileL ( CSIPProfileCleanupItem *  aItem  )  [protected]
 

Store profile into client cache.

Parameters:
aItem a cleanup item for roll back in case of failure
IMPORT_C void CSIPProfileRegistryBase::SupportedProfileTypesL ( RArray< TSIPProfileTypeInfo > &  aSupportedProfileTypes  ) 
 

Gets supported profile types The owneship of returned objects are transferred.

Precondition:
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:
KErrNoMemory if out of memory
void CSIPProfileRegistryBase::UpdatedL ( TUint32  aProfileId,
TUint  aSize
)  [virtual]
 

SIP profile information update event.

Parameters:
aProfileId id of updated SIP Profile
aSize size of updated SIP Profile

Implements MSIPConcreteProfileObserver.

void CSIPProfileRegistryBase::UpdateProfileL ( CSIPProfile &  aProfile  ) 
 

Update profile.

Parameters:
aProfile to be updated
TInt CSIPProfileRegistryBase::UsageL ( const CSIPProfile &  aProfile  )  const
 

Gets count of clients that have a profile enabled.

Parameters:
aProfile profile to be checked
Returns:
number of clients that have the profile enabled

Field Documentation

CSIPProfileItem* CSIPProfileRegistryBase::iFindEntry [protected]
 
CSIPProfileITC* CSIPProfileRegistryBase::iITC [protected]
 
CSIPProfileITCReceiver* CSIPProfileRegistryBase::iITCReceiver [protected]
 
MSIPProfileRegistryObserver& CSIPProfileRegistryBase::iObserver [protected]
 
CSIPProfilePlugins* CSIPProfileRegistryBase::iProfilePlugins [protected]
 
RPointerArray<CSIPProfileItem> CSIPProfileRegistryBase::iProfiles [protected]
 
RSIPProfile* CSIPProfileRegistryBase::iSipClient [protected]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top