CSIPProfileRegistryBase Class Reference

#include <mw/sipprofileregistrybase.h>

Link against: sipprofilecli.lib

class CSIPProfileRegistryBase : public CBase

Inherits from

  • CSIPProfileRegistryBase
    Protected Attributes
    CSIPProfileItem *iFindEntry
    CSIPProfileITC *iITC
    CSIPProfileITCReceiver *iITCReceiver
    MSIPProfileRegistryObserver &iObserver
    CSIPProfilePlugins *iProfilePlugins
    RPointerArray< CSIPProfileItem >iProfiles
    RSIPProfile *iSipClient
    Public Member Functions
    ~CSIPProfileRegistryBase()
    voidAddProfileL(CSIPProfile &)
    voidAddedL(TUint32)
    voidCrashRevert(TAny *)
    IMPORT_C CSIPProfile *DefaultProfileL()
    voidDisableProfileL(CSIPProfile &)
    voidEnableProfileL(CSIPProfile &)
    voidErrorOccurredL(TUint32, TInt, TInt)
    voidForceDisableProfileL(CSIPProfile &)
    TBool IsDefaultProfileL(const CSIPProfile &)
    CSIPProfileITC &Itc()
    CSIPProfileITCReceiver &ItcReceiver()
    IMPORT_C TIntLastRegistrationError(const CSIPProfile &)
    voidLocalCrashRevert(TAny *)
    voidNegotiatedSecurityMechanismL(CSIPConcreteProfile &)
    pure virtual CSIPProfile *NewInstanceL()
    voidProfileDeleted(CSIPProfile &)
    IMPORT_C CSIPProfile *ProfileL(TUint32)
    IMPORT_C voidProfilesL(RPointerArray< CSIPProfile > &)
    IMPORT_C voidProfilesL(const TSIPProfileTypeInfo &, RPointerArray< CSIPProfile > &)
    IMPORT_C voidProfilesL(const TDesC8 &, RPointerArray< CSIPProfile > &)
    voidRegisteredAORsL(CSIPConcreteProfile &)
    voidRegistrationStatusChangedL(TUint32, TInt, TUint32)
    voidRemoveProfileL(CSIPProfile &)
    voidRemovedL(TUint32)
    IMPORT_C voidSupportedProfileTypesL(RArray< TSIPProfileTypeInfo > &)
    voidUpdateProfileL(CSIPProfile &)
    voidUpdatedL(TUint32, TUint)
    TInt UsageL(const CSIPProfile &)
    Protected Member Functions
    CSIPProfileRegistryBase(MSIPProfileRegistryObserver &)
    voidBaseConstructL()
    TInt ProfileIndex(TUint)
    CSIPProfileItem *ProfileItemByIndex(TUint)
    CSIPProfileItem *ProfileItemL(TUint)
    CSIPProfile *SIPProfileL(TUint32, TInt)
    voidStoreArrayL(RPointerArray< CSIPConcreteProfile > &, RPointerArray< CSIPProfile > &)
    voidStoreProfileL(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

    ParameterDescription
    aObserverobserver to send events to

    ~CSIPProfileRegistryBase ( )

    IMPORT_C~CSIPProfileRegistryBase()

    Member Function Documentation

    AddProfileL ( CSIPProfile & )

    voidAddProfileL(CSIPProfile &aProfile)

    Add profile

    ParameterDescription
    aProfileto be added

    AddedL ( TUint32 )

    voidAddedL(TUint32aProfileId)

    SIP profile creation event.

    ParameterDescription
    aProfileIdid of new SIP Profile

    BaseConstructL ( )

    voidBaseConstructL()[protected]

    Symbian 2nd phase base class constructor

    CrashRevert ( TAny * )

    voidCrashRevert(TAny *aItem)[static]

    Roll back in case of failure

    ParameterDescription
    aItemobject to be cleaned

    DefaultProfileL ( )

    IMPORT_C CSIPProfile *DefaultProfileL()
    Gets the default profile
    leave
    KErrNotFound if profile not found
    leave
    KErrNoMemory if out of memory
    capability
    ReadUserData

    Returns: default profile; the owneship is transfered

    DisableProfileL ( CSIPProfile & )

    voidDisableProfileL(CSIPProfile &aProfile)

    Disable profile

    ParameterDescription
    aProfileto be disabled

    EnableProfileL ( CSIPProfile & )

    voidEnableProfileL(CSIPProfile &aProfile)

    Enable profile

    ParameterDescription
    aProfileto be enabled

    ErrorOccurredL ( TUint32, TInt, TInt )

    voidErrorOccurredL(TUint32aProfileId,
    TIntaStatus,
    TIntaError
    )

    An asynchronous error has occurred related to SIP profile

    ParameterDescription
    aProfileIdthe id of failed profile
    aErrora error code

    ForceDisableProfileL ( CSIPProfile & )

    voidForceDisableProfileL(CSIPProfile &aProfile)

    Force disable profile All Profile related activities will be stopped ungracefully

    ParameterDescription
    aProfileto be disabled

    IsDefaultProfileL ( const CSIPProfile & )

    TBool IsDefaultProfileL(const CSIPProfile &aProfile)

    Checks whether profile is default or not

    ParameterDescription
    aProfilechecked profile

    Returns: ETrue if is default, otherwise EFalse

    Itc ( )

    CSIPProfileITC &Itc()

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

    Returns: Reference to ITC member variable.

    ItcReceiver ( )

    CSIPProfileITCReceiver &ItcReceiver()

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

    Returns: Reference to ITC receiver member variable.

    LastRegistrationError ( const CSIPProfile & )

    IMPORT_C TIntLastRegistrationError(const CSIPProfile &aProfile)const

    Gets the last occurred error during registration

    Returns: last occurred registration error, KErrNone if no error

    LocalCrashRevert ( TAny * )

    voidLocalCrashRevert(TAny *aItem)[static]

    Roll back in case of failure

    ParameterDescription
    aItemobject to be cleaned

    NegotiatedSecurityMechanismL ( CSIPConcreteProfile & )

    voidNegotiatedSecurityMechanismL(CSIPConcreteProfile &aProfile)

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

    ParameterDescription
    aProfilea SIP profile

    NewInstanceL ( )

    CSIPProfile *NewInstanceL()[pure virtual]

    Gets new instance of either type CSIPProfile or CSIPManagedProfile

    Returns: new instance

    ProfileDeleted ( CSIPProfile & )

    voidProfileDeleted(CSIPProfile &aProfile)

    Informs destruction of local profile object instance

    ParameterDescription
    aProfileinstance of deleted profile

    ProfileIndex ( TUint )

    TInt ProfileIndex(TUintaProfileId)[protected]

    Gets profile cache item index

    ParameterDescription
    aProfileIda profile id to be found

    Returns: local cache item index of the profile

    ProfileItemByIndex ( TUint )

    CSIPProfileItem *ProfileItemByIndex(TUintaIndex)[protected]

    Gets profile cache item by index

    ParameterDescription
    aIndexa index of the profile to be found

    Returns: local cache item of the profile

    ProfileItemL ( TUint )

    CSIPProfileItem *ProfileItemL(TUintaProfileId)[protected]

    Gets profile cache item

    ParameterDescription
    aProfileIda profile id to be found

    Returns: local cache item of the profile

    ProfileL ( TUint32 )

    IMPORT_C CSIPProfile *ProfileL(TUint32aId)
    Gets SIP profile identified by the Id The owneship of profile is transferred.
    leave
    KErrNotFound if profile is not found
    capability
    ReadUserData
    ParameterDescription
    aIda SIP profile Id

    Returns: SIP profile

    ProfilesL ( RPointerArray< CSIPProfile > & )

    IMPORT_C voidProfilesL(RPointerArray< CSIPProfile > &aProfiles)
    Gets all SIP profiles
    Pre-condition
    aProfiles.Count() == 0
    leave
    KErrNoMemory if out of memory
    capability
    ReadUserData
    ParameterDescription
    aProfilesa reference to a client-owned array, which on return is filled with all existing SIP profiles

    ProfilesL ( const TSIPProfileTypeInfo &, RPointerArray< CSIPProfile > & )

    IMPORT_C voidProfilesL(const TSIPProfileTypeInfo &aType,
    RPointerArray< CSIPProfile > &aProfiles
    )
    Gets all SIP profiles of particular type The owneship of profiles are transferred.
    Pre-condition
    aProfiles.Count() == 0
    leave
    KErrNoMemory if out of memory
    capability
    ReadUserData
    ParameterDescription
    aTypea SIP profile type that is used for a query
    aProfilesa reference to a client-owned array, which on return is filled with profiles of the given type.

    ProfilesL ( const TDesC8 &, RPointerArray< CSIPProfile > & )

    IMPORT_C voidProfilesL(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
    leave
    KErrNoMemory if out memory
    capability
    ReadUserData
    ParameterDescription
    aAORa SIP AOR e.g. user@domain.com
    aProfilesa reference to a client-owned array, which on return is filled with profiles of the given type.

    RegisteredAORsL ( CSIPConcreteProfile & )

    voidRegisteredAORsL(CSIPConcreteProfile &aProfile)

    Updates SIP profile value for registered AORs; leaves on failure

    ParameterDescription
    aProfilea SIP profile

    RegistrationStatusChangedL ( TUint32, TInt, TUint32 )

    voidRegistrationStatusChangedL(TUint32aProfileId,
    TIntaStatus,
    TUint32aStatusId
    )

    SIP profile registration status changed event

    ParameterDescription
    aProfileIdid of profile which registration status has been changed.
    aStatusnew status of the profile
    aStatusIdid related to registration

    RemoveProfileL ( CSIPProfile & )

    voidRemoveProfileL(CSIPProfile &aProfile)
    Remove profile
    Pre-condition
    UsageL(aProfile) == 0
    ParameterDescription
    aProfileto be removed

    RemovedL ( TUint32 )

    voidRemovedL(TUint32aProfileId)

    SIP profile destruction event.

    ParameterDescription
    aProfileIdid of profile which was destroyed

    SIPProfileL ( TUint32, TInt )

    CSIPProfile *SIPProfileL(TUint32aId,
    TIntaSize = 0
    )[protected]

    Gets SIP profile identified by the Id; leaves on failure The owneship of profile is transferred.

    ParameterDescription
    aIda SIP profile Id
    aSizeof profile if known

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

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

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

    Store array of profiles into client cache

    ParameterDescription
    aProfilesa array containing the profiles
    aRetProfilesreturned array containing profiles

    StoreProfileL ( CSIPProfileCleanupItem * )

    voidStoreProfileL(CSIPProfileCleanupItem *aItem)[protected]

    Store profile into client cache

    ParameterDescription
    aItema cleanup item for roll back in case of failure

    SupportedProfileTypesL ( RArray< TSIPProfileTypeInfo > & )

    IMPORT_C voidSupportedProfileTypesL(RArray< TSIPProfileTypeInfo > &aSupportedProfileTypes)
    Gets supported profile types The owneship of returned objects are transferred.
    Pre-condition
    aSupportedProfileTypes.Count() == 0
    leave
    KErrNoMemory if out of memory
    ParameterDescription
    aSupportedProfileTypesa reference to client-owned array, which on return is filled with supported profile types. Any existing data in the array is destroyed.

    UpdateProfileL ( CSIPProfile & )

    voidUpdateProfileL(CSIPProfile &aProfile)

    Update profile

    ParameterDescription
    aProfileto be updated

    UpdatedL ( TUint32, TUint )

    voidUpdatedL(TUint32aProfileId,
    TUintaSize
    )

    SIP profile information update event

    ParameterDescription
    aProfileIdid of updated SIP Profile
    aSizesize of updated SIP Profile

    UsageL ( const CSIPProfile & )

    TInt UsageL(const CSIPProfile &aProfile)const

    Gets count of clients that have a profile enabled

    ParameterDescription
    aProfileprofile to be checked

    Returns: number of clients that have the profile enabled

    © Nokia 2011.