| 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
| Private Member Functions | |
|---|---|
| CSIPConcreteProfile() | |
| void | CloneExtensionParamsL(CSIPConcreteProfile &) |
| CSIPConcreteProfile * | CloneL(TBool) |
| void | ConstructL() |
| HBufC8 * | CreateContactUserNameLC() |
| void | DoInternalizeL(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 > *) |
| void | InternalizeExtensionParamsL(RReadStream &) |
| void | InternalizeProxyL(RReadStream &) |
| void | InternalizeRegistrarL(RReadStream &) |
| const TDesC8 & | Parameter(const RPointerArray< CSIPProfileParameter > *, const TDesC8 &) |
| void | SetOutboundProxyL(const TDesC8 &) |
| void | SetParameterL(RPointerArray< CSIPProfileParameter > *, const TDesC8 &, const TDesC8 &) |
| void | SetRegistrarL(const TDesC8 &) |
| Public Member Enumerations | |
|---|---|
| enum | TComparison { 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 { EUnregistered = 1, EUnregistrationInProgress, ERegistrationInProgress, ERegistered } |
| void | CloneExtensionParamsL | ( | CSIPConcreteProfile & | aNewObject | ) | const [private] |
| CSIPConcreteProfile & aNewObject |
| IMPORT_C CSIPConcreteProfile * | CloneL | ( | ) | const |
Clones profile. All non-dynamic values except profile id are copied.
| CSIPConcreteProfile * | CloneL | ( | TBool | aWithDynamicValues | ) | const [private] |
Clones profile.
| TBool aWithDynamicValues | Should all values be copied |
| IMPORT_C CSIPConcreteProfile * | CloneWithDynamicValuesL | ( | ) | const |
Clones profile. All values are copied.
| IMPORT_C const MDesC8Array & | ContactHeaderParams | ( | ) | const |
Gets all the Contact-header params defined for the profile. Each array element contains one parameter.
| IMPORT_C TUint32 | ContextId | ( | ) | 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.
| CDesC8ArrayFlat * | CopyDesArrayL | ( | const MDesC8Array & | aArray | ) | [static] |
| const MDesC8Array & aArray |
| void | DoInternalizeL | ( | RReadStream & | aReadStream, |
| TBool | aAll = ETrue | |||
| ) | [private] | |||
| RReadStream & aReadStream | |
| TBool aAll = ETrue |
| 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.
| IMPORT_C void | EnableSecurityNegotiation | ( | TBool | aOn = ETrue | ) |
Enables/disables the usage of security negotiation
| TBool aOn = ETrue | ETrue enables security negotiation for the profile, EFalse disables it. |
| IMPORT_C void | EnableSigComp | ( | TBool | aOn = ETrue | ) |
Enables/disables the usage of SigComp
| TBool aOn = ETrue | ETrue enables SigComp for the profile, EFalse disables it |
| TInt | ExtensionBoolParamIndex | ( | TUint32 | aID | ) | const [private] |
| TUint32 aID |
| IMPORT_C TInt | ExtensionBoolParameterCount | ( | ) | const |
Gets extension parameter count of type TBool.
| IMPORT_C TInt | ExtensionDesArrayParameterCount | ( | ) | const |
Gets extension parameter count of type MDesC8Array.
| IMPORT_C TInt | ExtensionDesParameterCount | ( | ) | const |
Gets extension parameter count of type TDesC8.
| TInt | ExtensionDescrArrayParamIndex | ( | TUint32 | aID | ) | const [private] |
| TUint32 aID |
| TInt | ExtensionDescrParamIndex | ( | TUint32 | aID | ) | const [private] |
| TUint32 aID |
| TInt | ExtensionIntParamIndex | ( | TUint32 | aID | ) | const [private] |
| TUint32 aID |
| IMPORT_C TInt | ExtensionIntParameterCount | ( | ) | const |
Gets extension parameter count of type TUint32.
| IMPORT_C TInt | ExtensionParameter | ( | TUint | aID, |
| TUint32 & | aValue | |||
| ) | const | |||
Gets an extension parameter of type TUint32.
| IMPORT_C TInt | ExtensionParameter | ( | TUint | aID, |
| TBool & | aValue | |||
| ) | const | |||
Gets an extension parameter of type TBool.
| IMPORT_C TInt | ExtensionParameter | ( | TUint | aID, |
| TDesC8 const *& | aValue | |||
| ) | const | |||
Gets an extension parameter that is of descriptor type.
| IMPORT_C TInt | ExtensionParameter | ( | TUint | aID, |
| MDesC8Array const *& | aValue | |||
| ) | const | |||
Gets an extension parameter that is of descriptor array type.
| TUint aID | parameter identifier |
| MDesC8Array const *& aValue |
| IMPORT_C TInt | ExtensionParameter | ( | TInt | aIndex, |
| TUint & | aID, | |||
| TUint32 & | aValue | |||
| ) | const | |||
Gets the extension parameter
| IMPORT_C TInt | ExtensionParameter | ( | TInt | aIndex, |
| TUint & | aID, | |||
| TBool & | aValue | |||
| ) | const | |||
Gets the extension parameter
| IMPORT_C TInt | ExtensionParameter | ( | TInt | aIndex, |
| TUint & | aID, | |||
| MDesC8Array const *& | aValue | |||
| ) | const | |||
Gets the extension parameter
| TInt aIndex | parameter's index in the extension array |
| TUint & aID | OUT: parameter's identifier, if found |
| MDesC8Array const *& aValue | OUT: parameter's value, if found |
| IMPORT_C TInt | ExtensionParameter | ( | TInt | aIndex, |
| TUint & | aID, | |||
| TDesC8 const *& | aValue | |||
| ) | const | |||
Gets the extension parameter
| void | ExternalizeDesArrayL | ( | const MDesC8Array & | aArray, |
| RWriteStream & | aWriteStream | |||
| ) | [static] | |||
| const MDesC8Array & aArray | |
| RWriteStream & aWriteStream |
| IMPORT_C void | ExternalizeL | ( | RWriteStream & | aWriteStream, |
| TBool | aAll = ETrue | |||
| ) | const | |||
Serializes the profile to the stream
| RWriteStream & aWriteStream | stream where profile is to be serialized |
| TBool aAll = ETrue | ETrue, if all values serialized, EFalse, if only non-dynamic values |
| IMPORT_C void | ExternalizeRegisteredAORsL | ( | RWriteStream & | aWriteStream | ) | const |
Serialize registered AORs from profile to stream
| RWriteStream & aWriteStream | stream where profile is to be serialized |
| IMPORT_C TUint | ExternalizedRegisteredAORsSizeL | ( | ) | const |
Get size of serialized registered AORs from profile
| IMPORT_C TUint | ExternalizedSizeL | ( | TBool | aAll = ETrue | ) | const |
Gets the size of the serialized profile
| TBool aAll = ETrue | ETrue, if all values serialized, EFalse, if only non-dynamic values |
| TUint32 | FetchIAPIDL | ( | const TDesC8 & | aValue | ) | [private] |
Fetch IAP ID*
| const TDesC8 & aValue | the IAP Name |
| TUint32 | FetchSNAPIDL | ( | const TDesC8 & | aValue | ) | [private] |
Fetch the Snap ID*
| const TDesC8 & aValue | the SNAP Name |
| TUint8 | GetNextBits | ( | const TDesC8 & | aBuf, |
| TInt | aBits, | |||
| TUint & | aCounter | |||
| ) | const [private] | |||
| TInt | IndexOf | ( | const TDesC8 & | aKey, |
| const RPointerArray< CSIPProfileParameter > * | aArray | |||
| ) | const [private] | |||
| const TDesC8 & aKey | |
| const RPointerArray< CSIPProfileParameter > * aArray |
| CDesC8ArrayFlat * | InternalizeDesArrayL | ( | RReadStream & | aReadStream | ) | [static] |
| RReadStream & aReadStream |
| void | InternalizeExtensionParamsL | ( | RReadStream & | aReadStream | ) | [private] |
| RReadStream & aReadStream |
| IMPORT_C CSIPConcreteProfile * | InternalizeL | ( | RReadStream & | aReadStream, |
| TBool | aAll = ETrue | |||
| ) | [static] | |||
Deserializes the profile from the stream
| RReadStream & aReadStream | stream holding serialized profile |
| TBool aAll = ETrue | ETrue, if all values deserialized, EFalse, if only non-dynamic values |
| void | InternalizeProxyL | ( | RReadStream & | aReadStream | ) | [private] |
| RReadStream & aReadStream |
| IMPORT_C void | InternalizeRegisteredAORsL | ( | RReadStream & | aReadStream | ) |
Deserialize registered AORs into profile from stream
| RReadStream & aReadStream | stream holding serialized profile |
| void | InternalizeRegistrarL | ( | RReadStream & | aReadStream | ) | [private] |
| RReadStream & aReadStream |
| IMPORT_C TBool | IsAutoRegistrationEnabled | ( | ) | const |
Checks if the profile is marked for auto-registration
| IMPORT_C TBool | IsEnabled | ( | ) | const |
Checks whether the profile has been enabled by at least one user.
| IMPORT_C TBool | IsSecurityNegotiationEnabled | ( | ) | const |
Checks if the profile uses SIP security negotiation
| IMPORT_C TInt | LastRegistrationError | ( | ) | const |
Gets last occurred error during registration
| IMPORT_C const TDesC8 & | NegotiatedSecurityMechanism | ( | ) | const |
Gets the negotiated security mechanism
| IMPORT_C CSIPConcreteProfile * | NewL | ( | ) | [static] |
Constructs an object of type CSIPConcreteProfile.
| IMPORT_C CSIPConcreteProfile * | NewLC | ( | ) | [static] |
Constructs an object of type CSIPConcreteProfile and adds a pointer to it to the cleanup stack.
| const TDesC8 & | Parameter | ( | const RPointerArray< CSIPProfileParameter > * | aArray, |
| const TDesC8 & | aName | |||
| ) | const [private] | |||
| const RPointerArray< CSIPProfileParameter > * aArray | |
| const TDesC8 & aName |
| IMPORT_C const MDesC8Array & | RegisteredAORs | ( | ) | const |
Gets dynamically registered AORs defined for the profile
| 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".
| IMPORT_C const TDesC8 & | Server | ( | TUint32 | aServer | ) | const |
Gets the server's URI
| TUint32 aServer | the type of the server |
| IMPORT_C const TDesC8 & | ServerExtensionParameter | ( | TUint32 | aServer, |
| const TDesC8 & | aName | |||
| ) | const | |||
Gets a server's extension parameter
| IMPORT_C TInt | ServerExtensionParameter | ( | TUint32 | aServer, |
| TInt | aIndex, | |||
| TDesC8 const *& | aKey, | |||
| TDesC8 const *& | aValue | |||
| ) | const | |||
Gets the server extension parameter
| IMPORT_C TInt | ServerExtensionParameterCount | ( | TUint32 | aServer | ) | const |
Gets server extension parameter count
| TUint32 aServer | the type of the server |
| IMPORT_C const TDesC8 & | ServerParameter | ( | TUint32 | aServer, |
| TUint32 | aServerParam | |||
| ) | const | |||
Gets a server's parameter
| IMPORT_C TInt | ServerParameter | ( | TUint32 | aServer, |
| TInt | aIndex, | |||
| TUint & | aID, | |||
| TDesC8 const *& | aValue | |||
| ) | const | |||
Gets the server parameter
| IMPORT_C TInt | ServerParameterCount | ( | TUint32 | aServer | ) | const |
Gets server parameter count
| TUint32 aServer | the type of the server |
| IMPORT_C void | SetAORL | ( | const TDesC8 & | aAOR | ) |
Sets the AOR (public user identity) used for the profile AORs to bet set
| const TDesC8 & aAOR |
| IMPORT_C void | SetAutoRegistrationEnabled | ( | TBool | aOn = ETrue | ) |
Enables/disables auto registration
| TBool aOn = ETrue | ETrue enables profile auto-registration, EFalse disables it. |
| IMPORT_C void | SetContactHeaderParamsL | ( | const MDesC8Array & | aParams | ) |
Sets Contact-header parameters for the profile. Each array element contains one parameter.
| const MDesC8Array & aParams | parameters to set |
| IMPORT_C void | SetContextId | ( | TUint32 | aId | ) |
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.
| TUint32 aId | context id |
| IMPORT_C void | SetDefault | ( | TBool | aOn = ETrue | ) |
Sets/resets the profile to be the default one.
| TBool aOn = ETrue | ETrue sets the profile as default, EFalse removes the setting |
| IMPORT_C void | SetDynamicProxyL | ( | const TDesC8 & | aDynamicProxy | ) |
Sets the dynamic proxy address in use. Dynamic proxy address is discovered on run-time, for eaxmple using DHCP.
| const TDesC8 & aDynamicProxy | proxy address |
| IMPORT_C void | SetEnabled | ( | TBool | aIsEnabled | ) |
Sets the profile enabled
| TBool aIsEnabled | ETrue if profile is enabled |
| IMPORT_C void | SetExtensionParameterL | ( | TUint32 | aID, |
| TUint32 | aValue | |||
| ) | ||||
Sets an extension parameter of type TUint32.
| IMPORT_C void | SetExtensionParameterL | ( | TUint32 | aID, |
| TBool | aValue | |||
| ) | ||||
Sets an extension parameter of type TBool.
| IMPORT_C void | SetExtensionParameterL | ( | TUint32 | aID, |
| const TDesC8 & | aValue | |||
| ) | ||||
Sets an extension parameter that is of descriptor type. Empty descriptor removes the parameter.
| IMPORT_C void | SetExtensionParameterL | ( | TUint32 | aID, |
| const MDesC8Array & | aValue | |||
| ) | ||||
Sets an extension parameters that is of descriptor array type.
| TUint32 aID | parameter identifier |
| const MDesC8Array & aValue | parameter value |
| IMPORT_C void | SetIapId | ( | TUint32 | aIapId | ) |
Sets the IAP ID for the connection
| TUint32 aIapId | a IAP ID |
| IMPORT_C void | SetId | ( | TUint32 | aProfileId | ) |
Sets the profile id
| TUint32 aProfileId | profile id |
| IMPORT_C void | SetLastRegistrationError | ( | TInt | aError | ) |
Sets last occurred error during registration
| TInt aError | occurred error code |
| IMPORT_C void | SetNegotiatedSecurityMechanismL | ( | const TDesC8 & | aMechanism | ) |
Sets the negotiated security mechanism in use
| const TDesC8 & aMechanism | negotiated security mechanism |
| void | SetOutboundProxyL | ( | const TDesC8 & | aOutboundProxy | ) | [private] |
| const TDesC8 & aOutboundProxy |
| void | SetParameterL | ( | RPointerArray< CSIPProfileParameter > * | aArray, |
| const TDesC8 & | aName, | |||
| const TDesC8 & | aValue | |||
| ) | [private] | |||
| RPointerArray< CSIPProfileParameter > * aArray | |
| const TDesC8 & aName | |
| const TDesC8 & aValue |
| IMPORT_C void | SetPrivateIdentityL | ( | const TDesC8 & | aPrivateIdentity | ) |
Sets the user's private identity
| const TDesC8 & aPrivateIdentity | user's private identity |
| IMPORT_C void | SetProfileType | ( | const TSIPProfileTypeInfo & | aProfileType | ) |
| const TSIPProfileTypeInfo & aProfileType |
| IMPORT_C void | SetProviderNameL | ( | const TDesC8 & | aProviderName | ) |
Sets the provider's name
| const TDesC8 & aProviderName | provider's name |
| IMPORT_C void | SetRegisteredAORsL | ( | const MDesC8Array & | aAORs | ) |
Sets dynamically registered AORs for the profile
| const MDesC8Array & aAORs | AORs to set |
| void | SetRegistrarL | ( | const TDesC8 & | aRegistrar | ) | [private] |
| const TDesC8 & aRegistrar |
| IMPORT_C void | SetSIPHeadersL | ( | 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".
| const MDesC8Array & aHeaders |
| IMPORT_C void | SetServerExtensionParameterL | ( | TUint32 | aServer, |
| const TDesC8 & | aName, | |||
| const TDesC8 & | aValue | |||
| ) | ||||
Sets a server's extension parameter
| IMPORT_C void | SetServerL | ( | TUint32 | aServer, |
| const TDesC8 & | aURI | |||
| ) | ||||
Sets the server's URI
| IMPORT_C void | SetServerParameterL | ( | TUint32 | aServer, |
| TUint32 | aServerParam, | |||
| const TDesC8 & | aValue | |||
| ) | ||||
Sets a server's parameter
| IMPORT_C void | SetStatus | ( | CSIPConcreteProfile::TStatus | aStatus | ) |
Sets the status of the profile
| CSIPConcreteProfile::TStatus aStatus | status of the profile |
| IMPORT_C void | SetStorageId | ( | TUint32 | aId | ) |
Sets the storage id used when updating the profile to permanent storage
| TUint32 aId | storage id |
| IMPORT_C TUint32 | StorageId | ( | ) | const |
Gets the storage id used when updating the profile to permanent storage
| IMPORT_C TBool | ValidateProfileParamsL | ( | ) |
Validate the profile Parameters on being consistent
| TBool | operator== | ( | const CSIPConcreteProfile & | aProfile | ) |
| const CSIPConcreteProfile & aProfile |
| 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 |
Profile states
| EUnregistered = 1 |
Unregistered |
| EUnregistrationInProgress |
Unregistration in progress |
| ERegistrationInProgress |
Registration is in progress |
| ERegistered |
Registered |
| RArray< TExtensionBoolParam > | iExtensionBoolParams | [private] |
| RPointerArray< CExtensionDescrArrayParam > | iExtensionDescrArrayParams | [private] |
| RPointerArray< CExtensionDescrParam > | iExtensionDescrParams | [private] |
| RArray< TExtensionIntParam > | iExtensionIntParams | [private] |
| RPointerArray< CSIPProfileParameter > | iSIPOutboundProxyExtParameter | [private] |
| RPointerArray< CSIPProfileParameter > | iSIPOutboundProxyParameter | [private] |
| RPointerArray< CSIPProfileParameter > | iSIPRegistrarExtParameter | [private] |
| RPointerArray< CSIPProfileParameter > | iSIPRegistrarParameter | [private] |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.