Symbian^3 Application Developer Library >

CSIPURI Class Reference

class CSIPURI : public CBase

Class provides functions for setting and getting fields and parameters in the SIP-URI or SIPS-URI structure.

sipcodec.lib

Inherits from

Public Member Functions
~CSIPURI ()
IMPORT_C void AddURIHeaderL (const TDesC8 &, const TDesC8 &)
IMPORT_C CSIPURI * DecodeL (const TDesC8 &)
void DeleteAllURIHeaders ()
IMPORT_C void DeleteParam ( RStringF )
IMPORT_C void DeletePassword ()
IMPORT_C void DeleteUserInfo ()
IMPORT_C TBool HasParam ( RStringF )
IMPORT_C TBool HasParams ()
IMPORT_C TBool HasURIHeaders (const TDesC8 &)
IMPORT_C const CSIPHostPort & HostPort ()
IMPORT_C CSIPHostPort & HostPort ()
IMPORT_C TBool IsSIPSURI ()
IMPORT_C RStringF ParamValue ( RStringF )
IMPORT_C const TDesC8 & Password ()
IMPORT_C void SetHostPortL ( CSIPHostPort *)
IMPORT_C void SetParamL ( RStringF )
IMPORT_C void SetParamL ( RStringF , RStringF )
IMPORT_C void SetPasswordL (const TDesC8 &)
IMPORT_C void SetSIPS ( TBool )
IMPORT_C void SetTtlParamL ( TInt )
IMPORT_C void SetUserL (const TDesC8 &)
IMPORT_C HBufC8 * ToTextL ()
IMPORT_C TInt TtlParam ()
IMPORT_C CPtrC8Array * URIHeaderValuesL (const TDesC8 &)
IMPORT_C const TDesC8 & User ()
IMPORT_C TBool operator== (const CSIPURI &)
Private Member Functions
CSIPURI ( TBool )
void ConstructL ()
void ConstructL (const CSIPURI &)
void LocateSeparatorL (const TDesC8 &, TChar , TInt &)
CSIPURI * NewL ()
CSIPURI * NewL (const CSIPURI &)
CSIPURI * NewLC ()
CSIPURI * NewLC (const CSIPURI &)
void ParseL (const TDesC8 &)
TPtrC8 ParseSipSchemeL (const TDesC8 &)
void ParseUserInfoL (const TDesC8 &)
void SetURIHeaders ( CSIPURIHeaders *)
void SetURIParams ( CSIPURIParams *)
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()
Private Attributes
TBool iHasPassword
TBool iHasUser
CSIPHostPort * iHostPort
TBool iIsSIPSURI
HBufC8 * iPassword
CSIPURIHeaders * iURIHeaders
CSIPURIParams * iURIParams
HBufC8 * iUser

Constructor & Destructor Documentation

CSIPURI(TBool)

CSIPURI ( TBool aIsSIPSUri = EFalse ) [private]

Parameters

TBool aIsSIPSUri = EFalse

~CSIPURI()

IMPORT_C ~CSIPURI ( )

Destructor, deletes the resources of CSIPURI .

Member Functions Documentation

AddURIHeaderL(const TDesC8 &, const TDesC8 &)

IMPORT_C void AddURIHeaderL ( const TDesC8 & aName,
const TDesC8 & aValue
)

Adds a new URI header

Parameters

const TDesC8 & aName the name of a URI header
const TDesC8 & aValue the value of a URI header

ConstructL()

void ConstructL ( ) [private]

ConstructL(const CSIPURI &)

void ConstructL ( const CSIPURI & aSIPURI ) [private]

Parameters

const CSIPURI & aSIPURI

DecodeL(const TDesC8 &)

IMPORT_C CSIPURI * DecodeL ( const TDesC8 & aValue ) [static]

Constructs a CSIPURI from textual representation

Parameters

const TDesC8 & aValue SIP-URI or SIPS-URI as text

DeleteAllURIHeaders()

void DeleteAllURIHeaders ( )

DeleteParam(RStringF)

IMPORT_C void DeleteParam ( RStringF aName )

Deletes a URI parameter

Parameters

RStringF aName

DeletePassword()

IMPORT_C void DeletePassword ( )

Deletes the password part of userinfo structure

DeleteUserInfo()

IMPORT_C void DeleteUserInfo ( )

Deletes the userinfo (user+password)

HasParam(RStringF)

IMPORT_C TBool HasParam ( RStringF aName ) const

Checks if a URI parameter is present

Parameters

RStringF aName the name of the URI parameter

HasParams()

IMPORT_C TBool HasParams ( ) const

Checks if any parameters are present

HasURIHeaders(const TDesC8 &)

IMPORT_C TBool HasURIHeaders ( const TDesC8 & aName ) const

Checks if named URI headers are present

Parameters

const TDesC8 & aName the name of the URI headers

HostPort()

IMPORT_C const CSIPHostPort & HostPort ( ) const

Gets the hostport as const

HostPort()

IMPORT_C CSIPHostPort & HostPort ( )

Gets the hostport

IsSIPSURI()

IMPORT_C TBool IsSIPSURI ( ) const

Checks the scheme of this CSIPURI

LocateSeparatorL(const TDesC8 &, TChar, TInt &)

void LocateSeparatorL ( const TDesC8 & aValue,
TChar aSeparator,
TInt & aPosition
) const [private]

Parameters

const TDesC8 & aValue
TChar aSeparator
TInt & aPosition

NewL()

CSIPURI * NewL ( ) [private, static]

NewL(const CSIPURI &)

CSIPURI * NewL ( const CSIPURI & aSIPURI ) [private, static]

Parameters

const CSIPURI & aSIPURI

NewLC()

CSIPURI * NewLC ( ) [private, static]

NewLC(const CSIPURI &)

CSIPURI * NewLC ( const CSIPURI & aSIPURI ) [private, static]

Parameters

const CSIPURI & aSIPURI

ParamValue(RStringF)

IMPORT_C RStringF ParamValue ( RStringF aName ) const
Gets the value of a URI parameter
Pre-condition
HasParam(aName) == ETrue

Parameters

RStringF aName

ParseL(const TDesC8 &)

void ParseL ( const TDesC8 & aValue ) [private]

Parameters

const TDesC8 & aValue

ParseSipSchemeL(const TDesC8 &)

TPtrC8 ParseSipSchemeL ( const TDesC8 & aValue ) [private]

Parameters

const TDesC8 & aValue

ParseUserInfoL(const TDesC8 &)

void ParseUserInfoL ( const TDesC8 & aValue ) [private]

Parameters

const TDesC8 & aValue

Password()

IMPORT_C const TDesC8 & Password ( ) const

Gets the password part of userinfo structure

SetHostPortL(CSIPHostPort *)

IMPORT_C void SetHostPortL ( CSIPHostPort * aHostPort )
Sets the hostport
Pre-condition
aHostPort != 0

Parameters

CSIPHostPort * aHostPort the ownership is transferred

SetParamL(RStringF)

IMPORT_C void SetParamL ( RStringF aName )

Sets a new URI parameter that does not have a value

Parameters

RStringF aName the name of a URI parameter

SetParamL(RStringF, RStringF)

IMPORT_C void SetParamL ( RStringF aName,
RStringF aValue
)

Sets a new URI parameter with a name and a value

Parameters

RStringF aName the name of a URI parameter
RStringF aValue the value of a URI parameter

SetPasswordL(const TDesC8 &)

IMPORT_C void SetPasswordL ( const TDesC8 & aPassword )

Sets the password part of userinfo structure

Parameters

const TDesC8 & aPassword the password to set

SetSIPS(TBool)

IMPORT_C void SetSIPS ( TBool aSIPS )

Sets the URI scheme to "sips"

Parameters

TBool aSIPS If ETrue the scheme is set to "sips", if EFalse the scheme is set to "sip".

SetTtlParamL(TInt)

IMPORT_C void SetTtlParamL ( TInt aValue )
Sets the value of the "ttl" parameter
Pre-condition
aValue >= 0

Parameters

TInt aValue the value of the "ttl" parameter

SetURIHeaders(CSIPURIHeaders *)

void SetURIHeaders ( CSIPURIHeaders * aURIHeaders ) [private]

Parameters

CSIPURIHeaders * aURIHeaders

SetURIParams(CSIPURIParams *)

void SetURIParams ( CSIPURIParams * aURIParams ) [private]

Parameters

CSIPURIParams * aURIParams

SetUserL(const TDesC8 &)

IMPORT_C void SetUserL ( const TDesC8 & aUser )

Sets the user part of userinfo structure

Parameters

const TDesC8 & aUser the user to set

ToTextL()

IMPORT_C HBufC8 * ToTextL ( ) const

Encodes the object into a textual representation.

TtlParam()

IMPORT_C TInt TtlParam ( ) const

Gets the value of the "ttl" parameter

URIHeaderValuesL(const TDesC8 &)

IMPORT_C CPtrC8Array * URIHeaderValuesL ( const TDesC8 & aName ) const

Returns an array of URI headers with the given name. The header values are copies of the actual header values in the SIP-URI thus the actual values cannot be modified through the given array. Note that removing a header value from the array does NOT remove it from the SIP URI.

Parameters

const TDesC8 & aName the name of the URI headers

User()

IMPORT_C const TDesC8 & User ( ) const

Gets the user part of userinfo structure

operator==(const CSIPURI &)

IMPORT_C TBool operator== ( const CSIPURI & aURI ) const

Compares this object to another instance of CSIPURI

Parameters

const CSIPURI & aURI a SIP URI to compare to

Member Data Documentation

TBool iHasPassword

TBool iHasPassword [private]

TBool iHasUser

TBool iHasUser [private]

CSIPHostPort * iHostPort

CSIPHostPort * iHostPort [private]

TBool iIsSIPSURI

TBool iIsSIPSURI [private]

HBufC8 * iPassword

HBufC8 * iPassword [private]

CSIPURIHeaders * iURIHeaders

CSIPURIHeaders * iURIHeaders [private]

CSIPURIParams * iURIParams

CSIPURIParams * iURIParams [private]

HBufC8 * iUser

HBufC8 * iUser [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.