CSIPConcreteProfile Class Reference

class CSIPConcreteProfile : public CBase

A container for SIP profile data for one SIP profile. Provides functions for setting and getting profile parameters and serializing the profile data to a write stream and reading the data from a read stream.

sipprofile.lib

Inherits from

Public Member Functions
~CSIPConcreteProfile()
IMPORT_C const TDesC8 &AOR()
IMPORT_C const TUriC8 &AORUri8()
IMPORT_C CSIPConcreteProfile *CloneL()
IMPORT_C CSIPConcreteProfile *CloneWithDynamicValuesL()
IMPORT_C const MDesC8Array &ContactHeaderParams()
IMPORT_C TUint32ContextId()
CDesC8ArrayFlat *CopyDesArrayL(const MDesC8Array &)
IMPORT_C const TDesC8 &DynamicProxy()
IMPORT_C voidEnableSecurityNegotiation(TBool)
IMPORT_C voidEnableSigComp(TBool)
IMPORT_C TIntExtensionBoolParameterCount()
IMPORT_C TIntExtensionDesArrayParameterCount()
IMPORT_C TIntExtensionDesParameterCount()
IMPORT_C TIntExtensionIntParameterCount()
IMPORT_C TIntExtensionParameter(TUint, TUint32 &)
IMPORT_C TIntExtensionParameter(TUint, TBool &)
IMPORT_C TIntExtensionParameter(TUint, TDesC8 const *&)
IMPORT_C TIntExtensionParameter(TUint, MDesC8Array const *&)
IMPORT_C TIntExtensionParameter(TInt, TUint &, TUint32 &)
IMPORT_C TIntExtensionParameter(TInt, TUint &, TBool &)
IMPORT_C TIntExtensionParameter(TInt, TUint &, MDesC8Array const *&)
IMPORT_C TIntExtensionParameter(TInt, TUint &, TDesC8 const *&)
voidExternalizeDesArrayL(const MDesC8Array &, RWriteStream &)
IMPORT_C voidExternalizeL(RWriteStream &, TBool)
IMPORT_C voidExternalizeRegisteredAORsL(RWriteStream &)
IMPORT_C TUintExternalizedRegisteredAORsSizeL()
IMPORT_C TUintExternalizedSizeL(TBool)
IMPORT_C TUint32IapId()
IMPORT_C TUint32Id()
CDesC8ArrayFlat *InternalizeDesArrayL(RReadStream &)
IMPORT_C CSIPConcreteProfile *InternalizeL(RReadStream &, TBool)
IMPORT_C voidInternalizeRegisteredAORsL(RReadStream &)
IMPORT_C TBoolIsAutoRegistrationEnabled()
IMPORT_C TBoolIsDefault()
IMPORT_C TBoolIsEnabled()
IMPORT_C TBoolIsSecurityNegotiationEnabled()
IMPORT_C TBoolIsSigCompEnabled()
TInt32 LastCompareResult()
IMPORT_C TIntLastRegistrationError()
IMPORT_C const TDesC8 &NegotiatedSecurityMechanism()
IMPORT_C CSIPConcreteProfile *NewL()
IMPORT_C CSIPConcreteProfile *NewLC()
IMPORT_C const TDesC8 &PrivateIdentity()
IMPORT_C const TSIPProfileTypeInfo &ProfileType()
IMPORT_C const TDesC8 &ProviderName()
IMPORT_C const MDesC8Array &RegisteredAORs()
IMPORT_C const MDesC8Array &SIPHeaders()
IMPORT_C const TDesC8 &Server(TUint32)
IMPORT_C const TDesC8 &ServerExtensionParameter(TUint32, const TDesC8 &)
IMPORT_C TIntServerExtensionParameter(TUint32, TInt, TDesC8 const *&, TDesC8 const *&)
IMPORT_C TIntServerExtensionParameterCount(TUint32)
IMPORT_C const TDesC8 &ServerParameter(TUint32, TUint32)
IMPORT_C TIntServerParameter(TUint32, TInt, TUint &, TDesC8 const *&)
IMPORT_C TIntServerParameterCount(TUint32)
IMPORT_C voidSetAORL(const TDesC8 &)
IMPORT_C voidSetAutoRegistrationEnabled(TBool)
IMPORT_C voidSetContactHeaderParamsL(const MDesC8Array &)
IMPORT_C voidSetContextId(TUint32)
IMPORT_C voidSetDefault(TBool)
IMPORT_C voidSetDynamicProxyL(const TDesC8 &)
IMPORT_C voidSetEnabled(TBool)
IMPORT_C voidSetExtensionParameterL(TUint32, TUint32)
IMPORT_C voidSetExtensionParameterL(TUint32, TBool)
IMPORT_C voidSetExtensionParameterL(TUint32, const TDesC8 &)
IMPORT_C voidSetExtensionParameterL(TUint32, const MDesC8Array &)
IMPORT_C voidSetIapId(TUint32)
IMPORT_C voidSetId(TUint32)
IMPORT_C voidSetLastRegistrationError(TInt)
IMPORT_C voidSetNegotiatedSecurityMechanismL(const TDesC8 &)
IMPORT_C voidSetPrivateIdentityL(const TDesC8 &)
IMPORT_C voidSetProfileType(const TSIPProfileTypeInfo &)
IMPORT_C voidSetProviderNameL(const TDesC8 &)
IMPORT_C voidSetRegisteredAORsL(const MDesC8Array &)
IMPORT_C voidSetSIPHeadersL(const MDesC8Array &)
IMPORT_C voidSetServerExtensionParameterL(TUint32, const TDesC8 &, const TDesC8 &)
IMPORT_C voidSetServerL(TUint32, const TDesC8 &)
IMPORT_C voidSetServerParameterL(TUint32, TUint32, const TDesC8 &)
IMPORT_C voidSetStatus(CSIPConcreteProfile::TStatus)
IMPORT_C voidSetStorageId(TUint32)
IMPORT_C CSIPConcreteProfile::TStatusStatus()
IMPORT_C TUint32StorageId()
IMPORT_C TBoolValidateProfileParamsL()
TBool operator==(const CSIPConcreteProfile &)
Private Member Functions
CSIPConcreteProfile()
voidCloneExtensionParamsL(CSIPConcreteProfile &)
CSIPConcreteProfile *CloneL(TBool)
voidConstructL()
HBufC8 *CreateContactUserNameLC()
voidDoInternalizeL(RReadStream &, TBool)
TInt ExtensionBoolParamIndex(TUint32)
TInt ExtensionDescrArrayParamIndex(TUint32)
TInt ExtensionDescrParamIndex(TUint32)
TInt ExtensionIntParamIndex(TUint32)
TUint32 FetchIAPIDL(const TDesC8 &)
TUint32 FetchSNAPIDL(const TDesC8 &)
TUint8 GetNextBits(const TDesC8 &, TInt, TUint &)
TInt IndexOf(const TDesC8 &, const RPointerArray< CSIPProfileParameter > *)
voidInternalizeExtensionParamsL(RReadStream &)
voidInternalizeProxyL(RReadStream &)
voidInternalizeRegistrarL(RReadStream &)
const TDesC8 &Parameter(const RPointerArray< CSIPProfileParameter > *, const TDesC8 &)
voidSetOutboundProxyL(const TDesC8 &)
voidSetParameterL(RPointerArray< CSIPProfileParameter > *, const TDesC8 &, const TDesC8 &)
voidSetRegistrarL(const TDesC8 &)
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()
Public Member Enumerations
enumTComparison {
EId = 1, EName = 2, EIAPId = 4, ERegistrar = 8, ERegistrarParameters = 16, ERegistrarExtensionParameters = 32, EOutboundProxy = 64, EOutboundProxyParameters = 128, EOutboundProxyExtensionParameters = 256, EPrivateIdentity = 512, EAOR = 1024, ESigComp = 2048, ESecurityNegotiation = 4096, EAutoRegistration = 8192, ETypeInfo = 16384, EExtensionParameters = 32768, EProxyResolving = 65536, EContactHeaderParams = 131072, ESIPHeaders = 262144
}
enumTStatus { EUnregistered = 1, EUnregistrationInProgress, ERegistrationInProgress, ERegistered }
Private Attributes
TUint32 iContextId
TBool iDefaultProfile
HBufC8 *iDynamicProxy
TBool iDynamicProxyResolving
RArray< TExtensionBoolParam >iExtensionBoolParams
RPointerArray< CExtensionDescrArrayParam >iExtensionDescrArrayParams
RPointerArray< CExtensionDescrParam >iExtensionDescrParams
RArray< TExtensionIntParam >iExtensionIntParams
TBool iIsEnabled
TInt32 iLastComparisonResult
TInt iLastRegistrationError
CUri8 *iSIPAORUri8
TBool iSIPAutoRegistered
CDesC8ArrayFlat *iSIPContactHeaderParams
CDesC8ArrayFlat *iSIPHeaders
TUint32 iSIPIAPId
HBufC8 *iSIPNegotiatedSecurityMechanism
HBufC8 *iSIPOutboundProxy
RPointerArray< CSIPProfileParameter >iSIPOutboundProxyExtParameter
RPointerArray< CSIPProfileParameter >iSIPOutboundProxyParameter
HBufC8 *iSIPPrivateIdentity
TUint32 iSIPProfileId
TSIPProfileTypeInfo iSIPProfileType
HBufC8 *iSIPProviderName
CDesC8ArrayFlat *iSIPRegisteredAORs
HBufC8 *iSIPRegistrar
RPointerArray< CSIPProfileParameter >iSIPRegistrarExtParameter
RPointerArray< CSIPProfileParameter >iSIPRegistrarParameter
TBool iSIPSigComp
TBool iSecurityNegotiation
TStatus iStatus
TUint32 iStorageId

Constructor & Destructor Documentation

CSIPConcreteProfile()

CSIPConcreteProfile()[private]

~CSIPConcreteProfile()

IMPORT_C~CSIPConcreteProfile()

Destructor.

Member Functions Documentation

AOR()

IMPORT_C const TDesC8 &AOR()const

Gets the AOR (public user identity) used for the profile

AORUri8()

IMPORT_C const TUriC8 &AORUri8()const

Gets the AOR used for the profile parsed as a URI

CloneExtensionParamsL(CSIPConcreteProfile &)

voidCloneExtensionParamsL(CSIPConcreteProfile &aNewObject)const [private]

Parameters

CSIPConcreteProfile & aNewObject

CloneL()

IMPORT_C CSIPConcreteProfile *CloneL()const

Clones profile. All non-dynamic values except profile id are copied.

CloneL(TBool)

CSIPConcreteProfile *CloneL(TBoolaWithDynamicValues)const [private]

Clones profile.

Parameters

TBool aWithDynamicValuesShould all values be copied

CloneWithDynamicValuesL()

IMPORT_C CSIPConcreteProfile *CloneWithDynamicValuesL()const

Clones profile. All values are copied.

ConstructL()

voidConstructL()[private]

ContactHeaderParams()

IMPORT_C const MDesC8Array &ContactHeaderParams()const

Gets all the Contact-header params defined for the profile. Each array element contains one parameter.

ContextId()

IMPORT_C TUint32ContextId()const

Gets the internal registration context id of the profile. In practice this is the value of MSIPRegistrationContext::ContextId() for a CSIPRegistrationBinding related to the profile.

CopyDesArrayL(const MDesC8Array &)

CDesC8ArrayFlat *CopyDesArrayL(const MDesC8Array &aArray)[static]

Parameters

const MDesC8Array & aArray

CreateContactUserNameLC()

HBufC8 *CreateContactUserNameLC()const [private]

DoInternalizeL(RReadStream &, TBool)

voidDoInternalizeL(RReadStream &aReadStream,
TBoolaAll = ETrue
)[private]

Parameters

RReadStream & aReadStream
TBool aAll = ETrue

DynamicProxy()

IMPORT_C const TDesC8 &DynamicProxy()const

Gets the dynamic proxy address in use. Dynamic proxy address is discovered on run-time, for eaxmple using DHCP.

EnableSecurityNegotiation(TBool)

IMPORT_C voidEnableSecurityNegotiation(TBoolaOn = ETrue)

Enables/disables the usage of security negotiation

Parameters

TBool aOn = ETrueETrue enables security negotiation for the profile, EFalse disables it.

EnableSigComp(TBool)

IMPORT_C voidEnableSigComp(TBoolaOn = ETrue)

Enables/disables the usage of SigComp

Parameters

TBool aOn = ETrueETrue enables SigComp for the profile, EFalse disables it

ExtensionBoolParamIndex(TUint32)

TInt ExtensionBoolParamIndex(TUint32aID)const [private]

Parameters

TUint32 aID

ExtensionBoolParameterCount()

IMPORT_C TIntExtensionBoolParameterCount()const

Gets extension parameter count of type TBool.

ExtensionDesArrayParameterCount()

IMPORT_C TIntExtensionDesArrayParameterCount()const

Gets extension parameter count of type MDesC8Array.

ExtensionDesParameterCount()

IMPORT_C TIntExtensionDesParameterCount()const

Gets extension parameter count of type TDesC8.

ExtensionDescrArrayParamIndex(TUint32)

TInt ExtensionDescrArrayParamIndex(TUint32aID)const [private]

Parameters

TUint32 aID

ExtensionDescrParamIndex(TUint32)

TInt ExtensionDescrParamIndex(TUint32aID)const [private]

Parameters

TUint32 aID

ExtensionIntParamIndex(TUint32)

TInt ExtensionIntParamIndex(TUint32aID)const [private]

Parameters

TUint32 aID

ExtensionIntParameterCount()

IMPORT_C TIntExtensionIntParameterCount()const

Gets extension parameter count of type TUint32.

ExtensionParameter(TUint, TUint32 &)

IMPORT_C TIntExtensionParameter(TUintaID,
TUint32 &aValue
)const

Gets an extension parameter of type TUint32.

Parameters

TUint aIDparameter identifier
TUint32 & aValue

ExtensionParameter(TUint, TBool &)

IMPORT_C TIntExtensionParameter(TUintaID,
TBool &aValue
)const

Gets an extension parameter of type TBool.

Parameters

TUint aIDparameter identifier
TBool & aValue

ExtensionParameter(TUint, TDesC8 const *&)

IMPORT_C TIntExtensionParameter(TUintaID,
TDesC8 const *&aValue
)const

Gets an extension parameter that is of descriptor type.

Parameters

TUint aIDparameter identifier
TDesC8 const *& aValue

ExtensionParameter(TUint, MDesC8Array const *&)

IMPORT_C TIntExtensionParameter(TUintaID,
MDesC8Array const *&aValue
)const

Gets an extension parameter that is of descriptor array type.

Parameters

TUint aIDparameter identifier
MDesC8Array const *& aValue

ExtensionParameter(TInt, TUint &, TUint32 &)

IMPORT_C TIntExtensionParameter(TIntaIndex,
TUint &aID,
TUint32 &aValue
)const

Gets the extension parameter

Parameters

TInt aIndexparameter's index in the extension array
TUint & aIDOUT: parameter's identifier, if found
TUint32 & aValueOUT: parameter's value, if found

ExtensionParameter(TInt, TUint &, TBool &)

IMPORT_C TIntExtensionParameter(TIntaIndex,
TUint &aID,
TBool &aValue
)const

Gets the extension parameter

Parameters

TInt aIndexparameter's index in the extension array
TUint & aIDOUT: parameter's identifier, if found
TBool & aValueOUT: parameter's value, if found

ExtensionParameter(TInt, TUint &, MDesC8Array const *&)

IMPORT_C TIntExtensionParameter(TIntaIndex,
TUint &aID,
MDesC8Array const *&aValue
)const

Gets the extension parameter

Parameters

TInt aIndexparameter's index in the extension array
TUint & aIDOUT: parameter's identifier, if found
MDesC8Array const *& aValueOUT: parameter's value, if found

ExtensionParameter(TInt, TUint &, TDesC8 const *&)

IMPORT_C TIntExtensionParameter(TIntaIndex,
TUint &aID,
TDesC8 const *&aValue
)const

Gets the extension parameter

Parameters

TInt aIndexparameter's index in the extension array
TUint & aIDOUT: parameter's identifier, if found
TDesC8 const *& aValueOUT: parameter's value, if found

ExternalizeDesArrayL(const MDesC8Array &, RWriteStream &)

voidExternalizeDesArrayL(const MDesC8Array &aArray,
RWriteStream &aWriteStream
)[static]

Parameters

const MDesC8Array & aArray
RWriteStream & aWriteStream

ExternalizeL(RWriteStream &, TBool)

IMPORT_C voidExternalizeL(RWriteStream &aWriteStream,
TBoolaAll = ETrue
)const

Serializes the profile to the stream

Parameters

RWriteStream & aWriteStreamstream where profile is to be serialized
TBool aAll = ETrueETrue, if all values serialized, EFalse, if only non-dynamic values

ExternalizeRegisteredAORsL(RWriteStream &)

IMPORT_C voidExternalizeRegisteredAORsL(RWriteStream &aWriteStream)const

Serialize registered AORs from profile to stream

Parameters

RWriteStream & aWriteStreamstream where profile is to be serialized

ExternalizedRegisteredAORsSizeL()

IMPORT_C TUintExternalizedRegisteredAORsSizeL()const

Get size of serialized registered AORs from profile

ExternalizedSizeL(TBool)

IMPORT_C TUintExternalizedSizeL(TBoolaAll = ETrue)const

Gets the size of the serialized profile

Parameters

TBool aAll = ETrueETrue, if all values serialized, EFalse, if only non-dynamic values

FetchIAPIDL(const TDesC8 &)

TUint32 FetchIAPIDL(const TDesC8 &aValue)[private]

Fetch IAP ID*

Parameters

const TDesC8 & aValuethe IAP Name

FetchSNAPIDL(const TDesC8 &)

TUint32 FetchSNAPIDL(const TDesC8 &aValue)[private]

Fetch the Snap ID*

Parameters

const TDesC8 & aValuethe SNAP Name

GetNextBits(const TDesC8 &, TInt, TUint &)

TUint8 GetNextBits(const TDesC8 &aBuf,
TIntaBits,
TUint &aCounter
)const [private]

Parameters

const TDesC8 & aBuf
TInt aBits
TUint & aCounter

IapId()

IMPORT_C TUint32IapId()const

Gets the IAP ID used by the profile

Id()

IMPORT_C TUint32Id()const

Gets the profile Id

IndexOf(const TDesC8 &, const RPointerArray< CSIPProfileParameter > *)

TInt IndexOf(const TDesC8 &aKey,
const RPointerArray< CSIPProfileParameter > *aArray
)const [private]

Parameters

const TDesC8 & aKey
const RPointerArray< CSIPProfileParameter > * aArray

InternalizeDesArrayL(RReadStream &)

CDesC8ArrayFlat *InternalizeDesArrayL(RReadStream &aReadStream)[static]

Parameters

RReadStream & aReadStream

InternalizeExtensionParamsL(RReadStream &)

voidInternalizeExtensionParamsL(RReadStream &aReadStream)[private]

Parameters

RReadStream & aReadStream

InternalizeL(RReadStream &, TBool)

IMPORT_C CSIPConcreteProfile *InternalizeL(RReadStream &aReadStream,
TBoolaAll = ETrue
)[static]

Deserializes the profile from the stream

Parameters

RReadStream & aReadStreamstream holding serialized profile
TBool aAll = ETrueETrue, if all values deserialized, EFalse, if only non-dynamic values

InternalizeProxyL(RReadStream &)

voidInternalizeProxyL(RReadStream &aReadStream)[private]

Parameters

RReadStream & aReadStream

InternalizeRegisteredAORsL(RReadStream &)

IMPORT_C voidInternalizeRegisteredAORsL(RReadStream &aReadStream)

Deserialize registered AORs into profile from stream

Parameters

RReadStream & aReadStreamstream holding serialized profile

InternalizeRegistrarL(RReadStream &)

voidInternalizeRegistrarL(RReadStream &aReadStream)[private]

Parameters

RReadStream & aReadStream

IsAutoRegistrationEnabled()

IMPORT_C TBoolIsAutoRegistrationEnabled()const

Checks if the profile is marked for auto-registration

IsDefault()

IMPORT_C TBoolIsDefault()const

Checks if the profile is the default one

IsEnabled()

IMPORT_C TBoolIsEnabled()const

Checks whether the profile has been enabled by at least one user.

IsSecurityNegotiationEnabled()

IMPORT_C TBoolIsSecurityNegotiationEnabled()const

Checks if the profile uses SIP security negotiation

IsSigCompEnabled()

IMPORT_C TBoolIsSigCompEnabled()const

Checks if the profile uses SigComp

LastCompareResult()

TInt32 LastCompareResult()const

LastRegistrationError()

IMPORT_C TIntLastRegistrationError()const

Gets last occurred error during registration

NegotiatedSecurityMechanism()

IMPORT_C const TDesC8 &NegotiatedSecurityMechanism()const

Gets the negotiated security mechanism

NewL()

IMPORT_C CSIPConcreteProfile *NewL()[static]

Constructs an object of type CSIPConcreteProfile.

NewLC()

IMPORT_C CSIPConcreteProfile *NewLC()[static]

Constructs an object of type CSIPConcreteProfile and adds a pointer to it to the cleanup stack.

Parameter(const RPointerArray< CSIPProfileParameter > *, const TDesC8 &)

const TDesC8 &Parameter(const RPointerArray< CSIPProfileParameter > *aArray,
const TDesC8 &aName
)const [private]

Parameters

const RPointerArray< CSIPProfileParameter > * aArray
const TDesC8 & aName

PrivateIdentity()

IMPORT_C const TDesC8 &PrivateIdentity()const

Gets the user private identity

ProfileType()

IMPORT_C const TSIPProfileTypeInfo &ProfileType()const

Gets profile type.

ProviderName()

IMPORT_C const TDesC8 &ProviderName()const

Gets the provider's name

RegisteredAORs()

IMPORT_C const MDesC8Array &RegisteredAORs()const

Gets dynamically registered AORs defined for the profile

SIPHeaders()

IMPORT_C const MDesC8Array &SIPHeaders()const

Gets all extra SIP headers defined for the profile. Each array element contains one header including the name and the value, for example "HeaderName: value".

Server(TUint32)

IMPORT_C const TDesC8 &Server(TUint32aServer)const

Gets the server's URI

Parameters

TUint32 aServerthe type of the server

ServerExtensionParameter(TUint32, const TDesC8 &)

IMPORT_C const TDesC8 &ServerExtensionParameter(TUint32aServer,
const TDesC8 &aName
)const

Gets a server's extension parameter

Parameters

TUint32 aServerthe type of the server
const TDesC8 & aNamethe parameter's name

ServerExtensionParameter(TUint32, TInt, TDesC8 const *&, TDesC8 const *&)

IMPORT_C TIntServerExtensionParameter(TUint32aServer,
TIntaIndex,
TDesC8 const *&aKey,
TDesC8 const *&aValue
)const

Gets the server extension parameter

Parameters

TUint32 aServerthe type of the server
TInt aIndexparameter's index in the extension array
TDesC8 const *& aKeyOUT: parameter's identifier, if found
TDesC8 const *& aValueOUT: parameter's value, if found

ServerExtensionParameterCount(TUint32)

IMPORT_C TIntServerExtensionParameterCount(TUint32aServer)const

Gets server extension parameter count

Parameters

TUint32 aServerthe type of the server

ServerParameter(TUint32, TUint32)

IMPORT_C const TDesC8 &ServerParameter(TUint32aServer,
TUint32aServerParam
)const

Gets a server's parameter

Parameters

TUint32 aServerthe type of the server
TUint32 aServerParamthe type of the parameter

ServerParameter(TUint32, TInt, TUint &, TDesC8 const *&)

IMPORT_C TIntServerParameter(TUint32aServer,
TIntaIndex,
TUint &aID,
TDesC8 const *&aValue
)const

Gets the server parameter

Parameters

TUint32 aServerthe type of the server
TInt aIndexparameter's index in the extension array
TUint & aIDOUT: parameter's identifier, if found
TDesC8 const *& aValueOUT: parameter's value, if found

ServerParameterCount(TUint32)

IMPORT_C TIntServerParameterCount(TUint32aServer)const

Gets server parameter count

Parameters

TUint32 aServerthe type of the server

SetAORL(const TDesC8 &)

IMPORT_C voidSetAORL(const TDesC8 &aAOR)

Sets the AOR (public user identity) used for the profile AORs to bet set

Parameters

const TDesC8 & aAOR

SetAutoRegistrationEnabled(TBool)

IMPORT_C voidSetAutoRegistrationEnabled(TBoolaOn = ETrue)

Enables/disables auto registration

Parameters

TBool aOn = ETrueETrue enables profile auto-registration, EFalse disables it.

SetContactHeaderParamsL(const MDesC8Array &)

IMPORT_C voidSetContactHeaderParamsL(const MDesC8Array &aParams)

Sets Contact-header parameters for the profile. Each array element contains one parameter.

Parameters

const MDesC8Array & aParamsparameters to set

SetContextId(TUint32)

IMPORT_C voidSetContextId(TUint32aId)

Sets the internal registration context id of the profile. In practice this is the value of MSIPRegistrationContext::ContextId() for a CSIPRegistrationBinding related to the profile.

Parameters

TUint32 aIdcontext id

SetDefault(TBool)

IMPORT_C voidSetDefault(TBoolaOn = ETrue)

Sets/resets the profile to be the default one.

Parameters

TBool aOn = ETrueETrue sets the profile as default, EFalse removes the setting

SetDynamicProxyL(const TDesC8 &)

IMPORT_C voidSetDynamicProxyL(const TDesC8 &aDynamicProxy)

Sets the dynamic proxy address in use. Dynamic proxy address is discovered on run-time, for eaxmple using DHCP.

Parameters

const TDesC8 & aDynamicProxyproxy address

SetEnabled(TBool)

IMPORT_C voidSetEnabled(TBoolaIsEnabled)

Sets the profile enabled

Parameters

TBool aIsEnabledETrue if profile is enabled

SetExtensionParameterL(TUint32, TUint32)

IMPORT_C voidSetExtensionParameterL(TUint32aID,
TUint32aValue
)

Sets an extension parameter of type TUint32.

Parameters

TUint32 aIDparameter identifier
TUint32 aValueparameter value

SetExtensionParameterL(TUint32, TBool)

IMPORT_C voidSetExtensionParameterL(TUint32aID,
TBoolaValue
)

Sets an extension parameter of type TBool.

Parameters

TUint32 aIDparameter identifier
TBool aValueparameter value

SetExtensionParameterL(TUint32, const TDesC8 &)

IMPORT_C voidSetExtensionParameterL(TUint32aID,
const TDesC8 &aValue
)

Sets an extension parameter that is of descriptor type. Empty descriptor removes the parameter.

Parameters

TUint32 aIDparameter identifier
const TDesC8 & aValueparameter value

SetExtensionParameterL(TUint32, const MDesC8Array &)

IMPORT_C voidSetExtensionParameterL(TUint32aID,
const MDesC8Array &aValue
)

Sets an extension parameters that is of descriptor array type.

Parameters

TUint32 aIDparameter identifier
const MDesC8Array & aValueparameter value

SetIapId(TUint32)

IMPORT_C voidSetIapId(TUint32aIapId)

Sets the IAP ID for the connection

Parameters

TUint32 aIapIda IAP ID

SetId(TUint32)

IMPORT_C voidSetId(TUint32aProfileId)

Sets the profile id

Parameters

TUint32 aProfileIdprofile id

SetLastRegistrationError(TInt)

IMPORT_C voidSetLastRegistrationError(TIntaError)

Sets last occurred error during registration

Parameters

TInt aErroroccurred error code

SetNegotiatedSecurityMechanismL(const TDesC8 &)

IMPORT_C voidSetNegotiatedSecurityMechanismL(const TDesC8 &aMechanism)

Sets the negotiated security mechanism in use

Parameters

const TDesC8 & aMechanismnegotiated security mechanism

SetOutboundProxyL(const TDesC8 &)

voidSetOutboundProxyL(const TDesC8 &aOutboundProxy)[private]

Parameters

const TDesC8 & aOutboundProxy

SetParameterL(RPointerArray< CSIPProfileParameter > *, const TDesC8 &, const TDesC8 &)

voidSetParameterL(RPointerArray< CSIPProfileParameter > *aArray,
const TDesC8 &aName,
const TDesC8 &aValue
)[private]

Parameters

RPointerArray< CSIPProfileParameter > * aArray
const TDesC8 & aName
const TDesC8 & aValue

SetPrivateIdentityL(const TDesC8 &)

IMPORT_C voidSetPrivateIdentityL(const TDesC8 &aPrivateIdentity)

Sets the user's private identity

Parameters

const TDesC8 & aPrivateIdentityuser's private identity

SetProfileType(const TSIPProfileTypeInfo &)

IMPORT_C voidSetProfileType(const TSIPProfileTypeInfo &aProfileType)

Parameters

const TSIPProfileTypeInfo & aProfileType

SetProviderNameL(const TDesC8 &)

IMPORT_C voidSetProviderNameL(const TDesC8 &aProviderName)

Sets the provider's name

Parameters

const TDesC8 & aProviderNameprovider's name

SetRegisteredAORsL(const MDesC8Array &)

IMPORT_C voidSetRegisteredAORsL(const MDesC8Array &aAORs)

Sets dynamically registered AORs for the profile

Parameters

const MDesC8Array & aAORsAORs to set

SetRegistrarL(const TDesC8 &)

voidSetRegistrarL(const TDesC8 &aRegistrar)[private]

Parameters

const TDesC8 & aRegistrar

SetSIPHeadersL(const MDesC8Array &)

IMPORT_C voidSetSIPHeadersL(const MDesC8Array &aHeaders)

Sets extra SIP headers for the profile. Each array element contains one header including the name and the value, for example "HeaderName: value".

Parameters

const MDesC8Array & aHeaders

SetServerExtensionParameterL(TUint32, const TDesC8 &, const TDesC8 &)

IMPORT_C voidSetServerExtensionParameterL(TUint32aServer,
const TDesC8 &aName,
const TDesC8 &aValue
)

Sets a server's extension parameter

Parameters

TUint32 aServerthe type of the server
const TDesC8 & aNamethe parameter's name
const TDesC8 & aValueparameter's value

SetServerL(TUint32, const TDesC8 &)

IMPORT_C voidSetServerL(TUint32aServer,
const TDesC8 &aURI
)

Sets the server's URI

Parameters

TUint32 aServerthe type of the server
const TDesC8 & aURIa server address as a URI

SetServerParameterL(TUint32, TUint32, const TDesC8 &)

IMPORT_C voidSetServerParameterL(TUint32aServer,
TUint32aServerParam,
const TDesC8 &aValue
)

Sets a server's parameter

Parameters

TUint32 aServerthe type of the server
TUint32 aServerParamthe type of the parameter
const TDesC8 & aValueparameter's value

SetStatus(CSIPConcreteProfile::TStatus)

IMPORT_C voidSetStatus(CSIPConcreteProfile::TStatusaStatus)

Sets the status of the profile

Parameters

CSIPConcreteProfile::TStatus aStatusstatus of the profile

SetStorageId(TUint32)

IMPORT_C voidSetStorageId(TUint32aId)

Sets the storage id used when updating the profile to permanent storage

Parameters

TUint32 aIdstorage id

Status()

IMPORT_C CSIPConcreteProfile::TStatusStatus()const

Gets the status of the profile

StorageId()

IMPORT_C TUint32StorageId()const

Gets the storage id used when updating the profile to permanent storage

ValidateProfileParamsL()

IMPORT_C TBoolValidateProfileParamsL()

Validate the profile Parameters on being consistent

operator==(const CSIPConcreteProfile &)

TBool operator==(const CSIPConcreteProfile &aProfile)

Parameters

const CSIPConcreteProfile & aProfile

Member Enumerations Documentation

Enum TComparison

Enumerators

EId = 1
EName = 2
EIAPId = 4
ERegistrar = 8
ERegistrarParameters = 16
ERegistrarExtensionParameters = 32
EOutboundProxy = 64
EOutboundProxyParameters = 128
EOutboundProxyExtensionParameters = 256
EPrivateIdentity = 512
EAOR = 1024
ESigComp = 2048
ESecurityNegotiation = 4096
EAutoRegistration = 8192
ETypeInfo = 16384
EExtensionParameters = 32768
EProxyResolving = 65536
EContactHeaderParams = 131072
ESIPHeaders = 262144

Enum TStatus

Profile states

Enumerators

EUnregistered = 1

Unregistered

EUnregistrationInProgress

Unregistration in progress

ERegistrationInProgress

Registration is in progress

ERegistered

Registered

Member Data Documentation

TUint32 iContextId

TUint32 iContextId[private]

TBool iDefaultProfile

TBool iDefaultProfile[private]

HBufC8 * iDynamicProxy

HBufC8 *iDynamicProxy[private]

TBool iDynamicProxyResolving

TBool iDynamicProxyResolving[private]

RArray< TExtensionBoolParam > iExtensionBoolParams

RArray< TExtensionBoolParam >iExtensionBoolParams[private]

RPointerArray< CExtensionDescrArrayParam > iExtensionDescrArrayParams

RPointerArray< CExtensionDescrArrayParam >iExtensionDescrArrayParams[private]

RPointerArray< CExtensionDescrParam > iExtensionDescrParams

RPointerArray< CExtensionDescrParam >iExtensionDescrParams[private]

RArray< TExtensionIntParam > iExtensionIntParams

RArray< TExtensionIntParam >iExtensionIntParams[private]

TBool iIsEnabled

TBool iIsEnabled[private]

TInt32 iLastComparisonResult

TInt32 iLastComparisonResult[private]

TInt iLastRegistrationError

TInt iLastRegistrationError[private]

CUri8 * iSIPAORUri8

CUri8 *iSIPAORUri8[private]

TBool iSIPAutoRegistered

TBool iSIPAutoRegistered[private]

CDesC8ArrayFlat * iSIPContactHeaderParams

CDesC8ArrayFlat *iSIPContactHeaderParams[private]

CDesC8ArrayFlat * iSIPHeaders

CDesC8ArrayFlat *iSIPHeaders[private]

TUint32 iSIPIAPId

TUint32 iSIPIAPId[private]

HBufC8 * iSIPNegotiatedSecurityMechanism

HBufC8 *iSIPNegotiatedSecurityMechanism[private]

HBufC8 * iSIPOutboundProxy

HBufC8 *iSIPOutboundProxy[private]

RPointerArray< CSIPProfileParameter > iSIPOutboundProxyExtParameter

RPointerArray< CSIPProfileParameter >iSIPOutboundProxyExtParameter[private]

RPointerArray< CSIPProfileParameter > iSIPOutboundProxyParameter

RPointerArray< CSIPProfileParameter >iSIPOutboundProxyParameter[private]

HBufC8 * iSIPPrivateIdentity

HBufC8 *iSIPPrivateIdentity[private]

TUint32 iSIPProfileId

TUint32 iSIPProfileId[private]

TSIPProfileTypeInfo iSIPProfileType

TSIPProfileTypeInfo iSIPProfileType[private]

HBufC8 * iSIPProviderName

HBufC8 *iSIPProviderName[private]

CDesC8ArrayFlat * iSIPRegisteredAORs

CDesC8ArrayFlat *iSIPRegisteredAORs[private]

HBufC8 * iSIPRegistrar

HBufC8 *iSIPRegistrar[private]

RPointerArray< CSIPProfileParameter > iSIPRegistrarExtParameter

RPointerArray< CSIPProfileParameter >iSIPRegistrarExtParameter[private]

RPointerArray< CSIPProfileParameter > iSIPRegistrarParameter

RPointerArray< CSIPProfileParameter >iSIPRegistrarParameter[private]

TBool iSIPSigComp

TBool iSIPSigComp[private]

TBool iSecurityNegotiation

TBool iSecurityNegotiation[private]

TStatus iStatus

TStatus iStatus[private]

TUint32 iStorageId

TUint32 iStorageId[private]