CSIPProfile Class Reference

#include <mw/sipprofile.h>

Link against: sipprofilecli.lib

class CSIPProfile : public CBase, public MSIPRegistrationContext

Inherits from

Protected Attributes
CSIPConcreteProfile *iSIPProfile
CSIPProfileRegistryBase *iSIPProfileRegistry
Public Member Functions
~CSIPProfile()
voidClearConcreteProfile()
voidClearRegistry()
CSIPConcreteProfile &ConcreteProfile()
const CSIPConcreteProfile &ConcreteProfile()
virtual TUint32 ContextId()
voidDefaultSNAPL(TUint32 &)
IMPORT_C TIntGetParameter(TUint32, TDesC8 const *&)
IMPORT_C TIntGetParameter(TUint32, TUint32 &)
IMPORT_C TIntGetParameter(TUint32, TBool &)
IMPORT_C TIntGetParameter(TUint32, MDesC8Array const *&)
IMPORT_C TIntGetParameter(TUint32, TUint32, TDesC8 const *&)
virtual TBool IsContextActive()
TBool IsEnabled()
TInt LastRegistrationError()
CSIPProfile *NewL(CSIPProfileRegistry *)
CSIPProfile *NewLC(CSIPProfileRegistry *)
voidSetConcreteProfile(CSIPConcreteProfile *)
voidSetEnabled(TBool)
voidSetRegistry(CSIPProfileRegistryBase *)
IMPORT_C const TSIPProfileTypeInfo &Type()
Protected Member Functions
CSIPProfile(CSIPProfileRegistryBase *)
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()
MSIPRegistrationContext::~MSIPRegistrationContext()

Detailed Description

Class contains profile information of particular SIP service provider. Class provides functions for quering profile parameter values.

Member Attribute Documentation

iSIPProfile

CSIPConcreteProfile *iSIPProfile[protected]

iSIPProfileRegistry

CSIPProfileRegistryBase *iSIPProfileRegistry[protected]

Constructor & Destructor Documentation

CSIPProfile ( CSIPProfileRegistryBase * )

CSIPProfile(CSIPProfileRegistryBase *aRegistry)[protected]

Constructor.

~CSIPProfile ( )

IMPORT_C~CSIPProfile()
Destructor.
Capability
NetworkServices

Member Function Documentation

ClearConcreteProfile ( )

voidClearConcreteProfile()

Clears concrete profile that holds actual data

ClearRegistry ( )

voidClearRegistry()

Clears pointer to registry from profile

ConcreteProfile ( )

CSIPConcreteProfile &ConcreteProfile()

Gets concrete profile that holds actual data

Return Value
concrete profile holding data

ConcreteProfile ( )

const CSIPConcreteProfile &ConcreteProfile()const

Gets concrete profile that holds actual data

Return Value
concrete profile holding data

ConstructL ( )

voidConstructL()[protected]

2nd phase constructor.

ContextId ( )

TUint32 ContextId()const [virtual]

For internal use only

Return Value
context id

DefaultSNAPL ( TUint32 & )

voidDefaultSNAPL(TUint32 &aSnapId)const

gets the Default SNAP ID from the Connectivity Settings

GetParameter ( TUint32, TDesC8 const *& )

IMPORT_C TIntGetParameter(TUint32aParam,
TDesC8 const *&aVal
)const

Gets profile parameter

Parameters
aParama parameter to get
aValon return will contain parameter value
Return Value
KErrNotFound if parameter was not found, KErrNone otherwise

GetParameter ( TUint32, TUint32 & )

IMPORT_C TIntGetParameter(TUint32aParam,
TUint32 &aVal
)const

Gets profile parameter

Parameters
aParama parameter to get
aValon return will contain parameter value
Return Value
KErrNotFound if parameter was not found, KErrNone otherwise

GetParameter ( TUint32, TBool & )

IMPORT_C TIntGetParameter(TUint32aParam,
TBool &aVal
)const

Gets profile parameter

Parameters
aParama parameter to get
aValon return will contain parameter value
Return Value
KErrNotFound if parameter was not found, KErrNone otherwise

GetParameter ( TUint32, MDesC8Array const *& )

IMPORT_C TIntGetParameter(TUint32aParam,
MDesC8Array const *&aVal
)const

Gets profile parameter

Parameters
aParama parameter to get
aValon return will contain parameter value
Return Value
KErrNotFound if parameter was not found, KErrNone otherwise

GetParameter ( TUint32, TUint32, TDesC8 const *& )

IMPORT_C TIntGetParameter(TUint32aServerType,
TUint32aParam,
TDesC8 const *&aVal
)const

Gets profile parameter that is defined for a particular SIP server

Parameters
aParama parameter to get
aValon return will contain parameter value
Return Value
KErrNotFound if parameter was not found, KErrNone otherwise

IsContextActive ( )

TBool IsContextActive()const [virtual]

Tests if the registration context can be used for creating SIP messages/dialogs Profile can be used, when CSIPProfileRegistry::IsEnabled() == ETrue and Status() == ERegistered.

Return Value
ETrue if can be used, EFalse otherwise

IsEnabled ( )

TBool IsEnabled()const

Checks if the profile is enabled

Return Value
ETrue if enabled, EFalse otherwise

LastRegistrationError ( )

TInt LastRegistrationError()const

Gets last occurred error during registration

Return Value
last occurred error code, KErrNone if no error

NewL ( CSIPProfileRegistry * )

CSIPProfile *NewL(CSIPProfileRegistry *aSIPRegistry)[static]

Two-phased constructor.

Parameters
aSIPRegistrya SIP profile client providing connection to SIP profile server.

NewLC ( CSIPProfileRegistry * )

CSIPProfile *NewLC(CSIPProfileRegistry *aSIPRegistry)[static]

Two-phased constructor.

Parameters
aSIPRegistrya SIP profile client providing connection to SIP profile server. Constructs an object and adds the pointer to the cleanup stack;

SetConcreteProfile ( CSIPConcreteProfile * )

voidSetConcreteProfile(CSIPConcreteProfile *aProfile)

Sets concrete profile that holds actual data

Parameters
aProfileprofile instance containing data

SetEnabled ( TBool )

voidSetEnabled(TBoolaEnabled)

Sets profiles enabled state

Parameters
aEnabledETrue if enabled

SetRegistry ( CSIPProfileRegistryBase * )

voidSetRegistry(CSIPProfileRegistryBase *aRegistry)

sets pointer to registry for profile

Type ( )

IMPORT_C const TSIPProfileTypeInfo &Type()const

Gets profile type information

Return Value
profile type information
© Nokia 2011.