CSIPFromToHeaderBase Class Reference

#include <mw/sipfromtoheaderbase.h>

Link against: sipcodec.lib

class CSIPFromToHeaderBase : public CSIPParameterHeaderBase

Inherits from

CSIPFromToHeaderBase
- CSIPParameterHeaderBase
  - CSIPHeaderBase
    - CBase

Public Member Functions
virtual	~CSIPFromToHeaderBase()
virtual TBool	HasCompactName()
virtual TPreferredPlace	PreferredPlaceInMessage()
IMPORT_C const CSIPAddress &	SIPAddress()
IMPORT_C CSIPAddress &	SIPAddress()
IMPORT_C void	SetSIPAddressL(CSIPAddress *)
IMPORT_C TBool	operator==(const CSIPFromToHeaderBase &)

Protected Member Functions
	CSIPFromToHeaderBase()
void	ConstructL()
void	ConstructL(CSIPAddress *)
void	ConstructL(CSIPAddress *, const TDesC8 &)
void	ConstructL(const CSIPFromToHeaderBase &)
void	DoInternalizeValueL(RReadStream &)

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()
	CSIPHeaderBase::CSIPHeaderBase()
	CSIPHeaderBase::CloneL()const
	CSIPHeaderBase::CompactName()const
	CSIPHeaderBase::EncodeMultipleToOneLine()const
	CSIPHeaderBase::ExternalizeL(RWriteStream &,TBool)const
	CSIPHeaderBase::ExternalizeNameL(RWriteStream &)const
	CSIPHeaderBase::ExternalizeSupported()const
	CSIPHeaderBase::IsExtensionHeader()const
	CSIPHeaderBase::MoreThanOneAllowed()const
	CSIPHeaderBase::Name()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 parameters in SIP "From" and "To" header.

This is an abstract class and cannot be instantiated.

Constructor & Destructor Documentation

CSIPFromToHeaderBase ( )

CSIPFromToHeaderBase

(

)

[protected]

~CSIPFromToHeaderBase ( )

IMPORT_C

~CSIPFromToHeaderBase

(

)

[virtual]

Destructor, deletes the resources of CSIPFromToHeaderBase.

Member Function Documentation

ConstructL ( )

void

ConstructL

(

)

[protected]

ConstructL ( CSIPAddress * )

void

ConstructL

(

CSIPAddress *

aSIPAddress

)

[protected]

ConstructL ( CSIPAddress *, const TDesC8 & )

void	ConstructL	(	CSIPAddress *	aSIPAddress,
			const TDesC8 &	aTag
		)	[protected]

ConstructL ( const CSIPFromToHeaderBase & )

void

ConstructL

(

const CSIPFromToHeaderBase &

aSIPFromToHeaderBase

)

[protected]

DoInternalizeValueL ( RReadStream & )

void

DoInternalizeValueL

(

RReadStream &

aReadStream

)

[protected]

HasCompactName ( )

TBool

HasCompactName

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::HasCompactName()const

PreferredPlaceInMessage ( )

TPreferredPlace

PreferredPlaceInMessage

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::PreferredPlaceInMessage()const

SIPAddress ( )

IMPORT_C const CSIPAddress &

SIPAddress

(

)

const

Gets the name-address as const

Return Value: name-address object

SIPAddress ( )

IMPORT_C CSIPAddress &

SIPAddress

(

)

Gets the name-address

Return Value: name-address object

SetSIPAddressL ( CSIPAddress * )

IMPORT_C void

SetSIPAddressL

(

CSIPAddress *

aSIPAddress

)

Sets the name-address

Pre-condition: aSIPAddress != 0

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

operator== ( const CSIPFromToHeaderBase & )

IMPORT_C TBool

operator==

(

const CSIPFromToHeaderBase &

aHeader

)

const

Compares this instance to another "From" or "To" header object

Parameters
aHeader	a header to compare to

Return Value: ETrue, if the objects are equal otherwise EFalse