CSIPToHeader Class Reference

#include <mw/siptoheader.h>

Link against: sipcodec.lib

class CSIPToHeader : public CSIPFromToHeaderBase

Inherits from

CSIPToHeader
- CSIPFromToHeaderBase
  - CSIPParameterHeaderBase
    - CSIPHeaderBase
      - CBase

Public Member Functions
	~CSIPToHeader()
RPointerArray< CSIPHeaderBase >	BaseDecodeL(const TDesC8 &)
virtual IMPORT_C CSIPHeaderBase *	CloneL()
virtual RStringF	CompactName()
IMPORT_C CSIPToHeader *	DecodeL(const TDesC8 &)
IMPORT_C CSIPHeaderBase *	InternalizeValueL(RReadStream &)
virtual IMPORT_C RStringF	Name()
IMPORT_C CSIPToHeader *	NewL(CSIPAddress *)
IMPORT_C CSIPToHeader *	NewL(const CSIPFromToHeaderBase &)
IMPORT_C CSIPToHeader *	NewLC(CSIPAddress *)
IMPORT_C CSIPToHeader *	NewLC(const CSIPFromToHeaderBase &)

Inherited Attributes
	CSIPHeaderBase::iLink

Inherited Enumerations
	CSIPHeaderBase:TPreferredPlace

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()
	CSIPFromToHeaderBase::CSIPFromToHeaderBase()
	CSIPFromToHeaderBase::ConstructL()
	CSIPFromToHeaderBase::ConstructL(CSIPAddress *)
	CSIPFromToHeaderBase::ConstructL(CSIPAddress *,const TDesC8 &)
	CSIPFromToHeaderBase::ConstructL(const CSIPFromToHeaderBase &)
	CSIPFromToHeaderBase::DoInternalizeValueL(RReadStream &)
	CSIPFromToHeaderBase::HasCompactName()const
	CSIPFromToHeaderBase::PreferredPlaceInMessage()const
	CSIPFromToHeaderBase::SIPAddress()
	CSIPFromToHeaderBase::SIPAddress()const
	CSIPFromToHeaderBase::SetSIPAddressL(CSIPAddress *)
	CSIPFromToHeaderBase::operator==(const CSIPFromToHeaderBase &)const
	CSIPFromToHeaderBase::~CSIPFromToHeaderBase()
	CSIPHeaderBase::CSIPHeaderBase()
	CSIPHeaderBase::EncodeMultipleToOneLine()const
	CSIPHeaderBase::ExternalizeL(RWriteStream &,TBool)const
	CSIPHeaderBase::ExternalizeNameL(RWriteStream &)const
	CSIPHeaderBase::ExternalizeSupported()const
	CSIPHeaderBase::IsExtensionHeader()const
	CSIPHeaderBase::MoreThanOneAllowed()const
	CSIPHeaderBase::PushLC(RPointerArray< CSIPHeaderBase > *)
	CSIPHeaderBase::ResetAndDestroy(TAny *)
	CSIPHeaderBase::ToTextL()const
	CSIPHeaderBase::ToTextLC()const
	CSIPHeaderBase::ToTextValueLC()const
	CSIPHeaderBase::~CSIPHeaderBase()
	CSIPParameterHeaderBase::CSIPParameterHeaderBase(const TChar &)
	CSIPParameterHeaderBase::DeleteParam(RStringF)
	CSIPParameterHeaderBase::HasParam(RStringF)const
	CSIPParameterHeaderBase::Param(TInt,RStringF &)const
	CSIPParameterHeaderBase::ParamCount()const
	CSIPParameterHeaderBase::ParamInsertionAllowed()const
	CSIPParameterHeaderBase::ParamValue(RStringF)const
	CSIPParameterHeaderBase::ParseL(const TDesC8 &,TBool,TBool)
	CSIPParameterHeaderBase::SetParamL(RStringF)
	CSIPParameterHeaderBase::SetParamL(RStringF,RStringF)
	CSIPParameterHeaderBase::ToTextValueL()const
	CSIPParameterHeaderBase::~CSIPParameterHeaderBase()

Detailed Description

Class provides functions for setting and getting SIP "To" header fields.

Constructor & Destructor Documentation

~CSIPToHeader ( )

IMPORT_C

~CSIPToHeader

(

)

Destructor, deletes the resources of CSIPToHeader.

Member Function Documentation

BaseDecodeL ( const TDesC8 & )

RPointerArray< CSIPHeaderBase >

BaseDecodeL

(

const TDesC8 &

aValue

)

[static]

CloneL ( )

IMPORT_C CSIPHeaderBase *

CloneL

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::CloneL()const

From CSIPHeaderBase CloneL

CompactName ( )

RStringF

CompactName

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::CompactName()const

DecodeL ( const TDesC8 & )

IMPORT_C CSIPToHeader *

DecodeL

(

const TDesC8 &

aValue

)

[static]

Constructs a CSIPToHeader from textual representation of the header's value part.

Parameters
aValue	a value part of a "To"-header (e.g. "User <user@host>")

Return Value: a new instance of CSIPToHeader

InternalizeValueL ( RReadStream & )

IMPORT_C CSIPHeaderBase *

InternalizeValueL

(

RReadStream &

aReadStream

)

[static]

Constructs an instance of a CSIPToHeader from a RReadStream

Parameters
aReadStream	a stream containing the value of the externalized object (header name not included).

Return Value: an instance of a CSIPToHeader

Name ( )

IMPORT_C RStringF

Name

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::Name()const

From CSIPHeaderBase Name

NewL ( CSIPAddress * )

IMPORT_C CSIPToHeader *

NewL

(

CSIPAddress *

aSIPAddress

)

[static]

Creates a new instance of CSIPToHeader

Pre-condition: aSIPAddress != 0

Parameters
aSIPAddress	a name-address, the ownership is transferred,

Return Value: a new instance of CSIPToHeader

NewL ( const CSIPFromToHeaderBase & )

IMPORT_C CSIPToHeader *

NewL

(

const CSIPFromToHeaderBase &

aHeader

)

[static]

Creates a deep-copy of a CSIPFromToHeaderBase Note that this function can be used for creating a To-header using an existing From-header.

Parameters
aHeader	CSIPFromToHeaderBase to be copied

Return Value: a new instance of CSIPToHeader

NewLC ( CSIPAddress * )

IMPORT_C CSIPToHeader *

NewLC

(

CSIPAddress *

aSIPAddress

)

[static]

Creates a new instance of CSIPToHeader and puts it to CleanupStack

Pre-condition: aSIPAddress != 0

Parameters
aSIPAddress	a name-address, the ownership is transferred,

Return Value: a new instance of CSIPToHeader

NewLC ( const CSIPFromToHeaderBase & )

IMPORT_C CSIPToHeader *

NewLC

(

const CSIPFromToHeaderBase &

aHeader

)

[static]

Creates a deep-copy of a CSIPFromToHeaderBase and puts it to CleanupStack Note that this function can be used for creating a To-header using an existing From-header.

Parameters
aHeader	CSIPFromToHeaderBaseto to be copied

Return Value: a new instance of CSIPToHeader