Symbian^3 Application Developer Library >

CSIPAddress Class Reference

class CSIPAddress : public CBase

Class provides functions for setting and getting parameters in SIP name-addr structure

sipcodec.lib

Inherits from

Public Member Functions
~CSIPAddress ()
IMPORT_C CSIPAddress * DecodeL (const TDesC8 &)
IMPORT_C const TDesC8 & DisplayName ()
IMPORT_C void ExternalizeL ( RWriteStream &)
IMPORT_C CSIPAddress * InternalizeL ( RReadStream &)
IMPORT_C CSIPAddress * NewL ( CUri8 *)
IMPORT_C CSIPAddress * NewL (const TDesC8 &, CUri8 *)
IMPORT_C CSIPAddress * NewL (const CSIPAddress &)
IMPORT_C CSIPAddress * NewLC ( CUri8 *)
IMPORT_C CSIPAddress * NewLC (const TDesC8 &, CUri8 *)
IMPORT_C CSIPAddress * NewLC (const CSIPAddress &)
CSIPAddress * NewLC ( CURIContainer *)
IMPORT_C void SetDisplayNameL (const TDesC8 &)
IMPORT_C void SetUri8L ( CUri8 *)
IMPORT_C HBufC8 * ToTextLC ( TBool )
IMPORT_C CURIContainer & URI ()
IMPORT_C const CURIContainer & URI ()
IMPORT_C const CUri8 & Uri8 ()
IMPORT_C TBool operator== (const CSIPAddress &)
Private Member Functions
CSIPAddress ()
TBool CheckDisplayName (const TDesC8 &)
void ConstructL ()
void ConstructL ( CUri8 *)
void ConstructL (const TDesC8 &, CUri8 *)
void ConstructL (const CSIPAddress &)
void ConstructL ( CURIContainer *)
TBool ContainsSeparators (const TDesC8 &)
void DoInternalizeL ( RReadStream &)
TBool HasDisplayName ()
void ParseURIInAngleBracketsL (const TDesC8 &)
void ParseURIL (const TDesC8 &)
TInt QuotedStringLength (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()
Private Attributes
HBufC8 * iDisplayName
CURIContainer * iURI

Constructor & Destructor Documentation

CSIPAddress()

CSIPAddress ( ) [private]

~CSIPAddress()

IMPORT_C ~CSIPAddress ( )

Destructor, deletes the resources of CSIPAddress .

Member Functions Documentation

CheckDisplayName(const TDesC8 &)

TBool CheckDisplayName ( const TDesC8 & aValue ) [private]

Parameters

const TDesC8 & aValue

ConstructL()

void ConstructL ( ) [private]

ConstructL(CUri8 *)

void ConstructL ( CUri8 * aUri ) [private]

Parameters

CUri8 * aUri

ConstructL(const TDesC8 &, CUri8 *)

void ConstructL ( const TDesC8 & aDisplayName,
CUri8 * aUri
) [private]

Parameters

const TDesC8 & aDisplayName
CUri8 * aUri

ConstructL(const CSIPAddress &)

void ConstructL ( const CSIPAddress & aSIPAddress ) [private]

Parameters

const CSIPAddress & aSIPAddress

ConstructL(CURIContainer *)

void ConstructL ( CURIContainer * aURI ) [private]

Parameters

CURIContainer * aURI

ContainsSeparators(const TDesC8 &)

TBool ContainsSeparators ( const TDesC8 & aValue ) const [private]

Parameters

const TDesC8 & aValue

DecodeL(const TDesC8 &)

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

Constructs a CSIPAddress from textual representation

Parameters

const TDesC8 & aValue SIP name-addr as text

DisplayName()

IMPORT_C const TDesC8 & DisplayName ( ) const

Gets the display name

DoInternalizeL(RReadStream &)

void DoInternalizeL ( RReadStream & aReadStream ) [private]

Parameters

RReadStream & aReadStream

ExternalizeL(RWriteStream &)

IMPORT_C void ExternalizeL ( RWriteStream & aWriteStream )

Writes the object to a RWriteStream

Parameters

RWriteStream & aWriteStream a stream where the object is to be externalized

HasDisplayName()

TBool HasDisplayName ( ) const [private]

InternalizeL(RReadStream &)

IMPORT_C CSIPAddress * InternalizeL ( RReadStream & aReadStream ) [static]

Constructs an instance of a CSIPAddress from a RReadStream

Parameters

RReadStream & aReadStream a stream containing the externalized object

NewL(CUri8 *)

IMPORT_C CSIPAddress * NewL ( CUri8 * aUri8 ) [static]
Creates a new instance of CSIPAddress
Pre-condition
aUri != 0

Parameters

CUri8 * aUri8

NewL(const TDesC8 &, CUri8 *)

IMPORT_C CSIPAddress * NewL ( const TDesC8 & aDisplayName,
CUri8 * aUri8
) [static]
Creates a new instance of CSIPAddress
Pre-condition
aUri != 0

Parameters

const TDesC8 & aDisplayName a SIP token or a SIP quoted-string
CUri8 * aUri8

NewL(const CSIPAddress &)

IMPORT_C CSIPAddress * NewL ( const CSIPAddress & aSIPAddress ) [static]

Creates a deep-copy of a CSIPAddress

Parameters

const CSIPAddress & aSIPAddress the address to be copied

NewLC(CUri8 *)

IMPORT_C CSIPAddress * NewLC ( CUri8 * aUri8 ) [static]
Creates a new instance of CSIPAddress and puts it to CleanupStack
Pre-condition
aUri != 0

Parameters

CUri8 * aUri8

NewLC(const TDesC8 &, CUri8 *)

IMPORT_C CSIPAddress * NewLC ( const TDesC8 & aDisplayName,
CUri8 * aUri8
) [static]
Creates a new instance of CSIPAddress and puts it to CleanupStack
Pre-condition
aUri != 0

Parameters

const TDesC8 & aDisplayName a SIP token or a SIP quoted-string
CUri8 * aUri8

NewLC(const CSIPAddress &)

IMPORT_C CSIPAddress * NewLC ( const CSIPAddress & aSIPAddress ) [static]

Creates a deep-copy of a CSIPAddress and puts it to CleanupStack

Parameters

const CSIPAddress & aSIPAddress the address to be copied

NewLC(CURIContainer *)

CSIPAddress * NewLC ( CURIContainer * aURI ) [static]

Parameters

CURIContainer * aURI

ParseURIInAngleBracketsL(const TDesC8 &)

void ParseURIInAngleBracketsL ( const TDesC8 & aValue ) [private]

Parameters

const TDesC8 & aValue

ParseURIL(const TDesC8 &)

void ParseURIL ( const TDesC8 & aValue ) [private]

Parameters

const TDesC8 & aValue

QuotedStringLength(const TDesC8 &)

TInt QuotedStringLength ( const TDesC8 & aValue ) [private]

Parameters

const TDesC8 & aValue

SetDisplayNameL(const TDesC8 &)

IMPORT_C void SetDisplayNameL ( const TDesC8 & aDisplayName )

Sets the display name

Parameters

const TDesC8 & aDisplayName a SIP token or a SIP quoted-string

SetUri8L(CUri8 *)

IMPORT_C void SetUri8L ( CUri8 * aUri8 )
Sets the URI part of the address
Pre-condition
aUri!= 0

Parameters

CUri8 * aUri8

ToTextLC(TBool)

IMPORT_C HBufC8 * ToTextLC ( TBool aUseAngleBrackets = EFalse ) const

Creates a textual representation and pushes it to CleanupStack

Parameters

TBool aUseAngleBrackets = EFalse if ETrue, sets the anglebrackets

URI()

IMPORT_C CURIContainer & URI ( )

URI()

IMPORT_C const CURIContainer & URI ( ) const

Uri8()

IMPORT_C const CUri8 & Uri8 ( ) const

Gets the URI part of the address as const

operator==(const CSIPAddress &)

IMPORT_C TBool operator== ( const CSIPAddress & aSIPAddress ) const

Compares this object to another instance of CSIPAddress

Parameters

const CSIPAddress & aSIPAddress a CSIPAddress to compare to

Member Data Documentation

HBufC8 * iDisplayName

HBufC8 * iDisplayName [private]

CURIContainer * iURI

CURIContainer * iURI [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.