CSIPHeaderBase Class Reference

#include <mw/sipheaderbase.h>

Link against: sipcodec.lib

class CSIPHeaderBase : public CBase

Inherits from

CSIPHeaderBase
- CBase

Public Attributes
TSglQueLink	iLink

Public Member Enumerations
enum	TPreferredPlace { ETop, EMiddleTop, EMiddle, EMiddleBottom, EBottom }

Public Member Functions
virtual	~CSIPHeaderBase()
pure virtual IMPORT_C CSIPHeaderBase *	CloneL()
virtual RStringF	CompactName()
virtual TBool	EncodeMultipleToOneLine()
IMPORT_C void	ExternalizeL(RWriteStream &, TBool)
virtual IMPORT_C TBool	ExternalizeSupported()
virtual TBool	HasCompactName()
virtual TBool	IsExtensionHeader()
virtual TBool	MoreThanOneAllowed()
pure virtual IMPORT_C RStringF	Name()
pure virtual TPreferredPlace	PreferredPlaceInMessage()
IMPORT_C void	PushLC(RPointerArray< CSIPHeaderBase > *)
IMPORT_C HBufC8 *	ToTextL()
IMPORT_C HBufC8 *	ToTextLC()
pure virtual IMPORT_C HBufC8 *	ToTextValueL()
IMPORT_C HBufC8 *	ToTextValueLC()

Protected Member Functions
	CSIPHeaderBase()
void	ExternalizeNameL(RWriteStream &)
virtual void	ExternalizeValueL(RWriteStream &)
void	ResetAndDestroy(TAny *)

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()

Detailed Description

Class provides a generic interface for all the SIP headers.

Member Attribute Documentation

iLink

TSglQueLink

iLink

Member Enumeration Documentation

Enum TPreferredPlace

Enumerator	Value	Description
ETop
EMiddleTop
EMiddle
EMiddleBottom
EBottom

Constructor & Destructor Documentation

CSIPHeaderBase ( )

CSIPHeaderBase

(

)

[protected]

~CSIPHeaderBase ( )

IMPORT_C

~CSIPHeaderBase

(

)

[virtual]

Destructor, deletes the resources of CSIPHeaderBase.

Member Function Documentation

CloneL ( )

IMPORT_C CSIPHeaderBase *

CloneL

(

)

const [pure virtual]

Creates a deep-copy of this CSIPHeaderBase object. The function has to be implemented in each of the sub-classes.

Return Value: the deep-copied object, the ownership is transferred.

CompactName ( )

RStringF

CompactName

(

)

const [virtual]

EncodeMultipleToOneLine ( )

TBool

EncodeMultipleToOneLine

(

)

const [virtual]

ExternalizeL ( RWriteStream &, TBool )

IMPORT_C void	ExternalizeL	(	RWriteStream &	aWriteStream,
			TBool	aAddName = ETrue
		)	const

Writes the object to a RWriteStream

Parameters
aWriteStream	a stream where the object is to be externalized
aAddName	if ETrue the name of the header is also written to the stream

ExternalizeNameL ( RWriteStream & )

void

ExternalizeNameL

(

RWriteStream &

aWriteStream

)

const [protected]

ExternalizeSupported ( )

IMPORT_C TBool

ExternalizeSupported

(

)

const [virtual]

Checks, if the header supports serialization. In practice all the headers part of the API support it.

Return Value: ETrue, if the header supports serialization, otherwise EFalse

ExternalizeValueL ( RWriteStream & )

void

ExternalizeValueL

(

RWriteStream &

aWriteStream

)

const [protected, virtual]

HasCompactName ( )

TBool

HasCompactName

(

)

const [virtual]

IsExtensionHeader ( )

TBool

IsExtensionHeader

(

)

const [virtual]

MoreThanOneAllowed ( )

TBool

MoreThanOneAllowed

(

)

const [virtual]

Name ( )

IMPORT_C RStringF

Name

(

)

const [pure virtual]

Gets the full name of the header The function is implemented in each of the sub-classes.

Return Value: the full name of the header for example "From"

PreferredPlaceInMessage ( )

TPreferredPlace

PreferredPlaceInMessage

(

)

const [pure virtual]

PushLC ( RPointerArray< CSIPHeaderBase > * )

IMPORT_C void

PushLC

(

RPointerArray< CSIPHeaderBase > *

aArray

)

[static]

Can be used when a RPointerArray<CSIPHeaderBase> needs to be pushed to the CleanupStack for ResetAndDestroy.

Parameters
aArray	an array of CSIPHeaderBase pointers, the ownership of the array is transferred

ResetAndDestroy ( TAny * )

void

ResetAndDestroy

(

TAny *

anArray

)

[protected, static]

ToTextL ( )

IMPORT_C HBufC8 *

ToTextL

(

)

const

Encodes the header (name and value) into its textual representation.

Return Value: a textual representation of the complete header, the ownership is transferred

ToTextLC ( )

IMPORT_C HBufC8 *

ToTextLC

(

)

const

Encodes the header (name and value) into its textual representation and pushes it to the CleanupStack.

Return Value: a textual representation of the complete header, the ownership is transferred

ToTextValueL ( )

IMPORT_C HBufC8 *

ToTextValueL

(

)

const [pure virtual]

Encodes the header's value into its textual representation.

Return Value: a textual representation of the header's value, the ownership is transferred

ToTextValueLC ( )

IMPORT_C HBufC8 *

ToTextValueLC

(

)

const

Encodes the header's value into its textual representation and pushes it to the CleanupStack.

Return Value: a textual representation of the header's value, the ownership is transferred