CSIPHeaderBase Class Reference

class CSIPHeaderBase : public CBase

Class provides a generic interface for all the SIP headers.

sipcodec.lib

Inherits from

Constructor & Destructor Documentation

CSIPHeaderBase()

CSIPHeaderBase ( ) [protected]

~CSIPHeaderBase()

IMPORT_C ~CSIPHeaderBase ( ) [virtual]

Destructor, deletes the resources of CSIPHeaderBase .

Member Functions 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.

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

RWriteStream & aWriteStream a stream where the object is to be externalized
TBool aAddName = ETrue if ETrue the name of the header is also written to the stream

ExternalizeNameL(RWriteStream &)

void ExternalizeNameL ( RWriteStream & aWriteStream ) const [protected]

Parameters

RWriteStream & aWriteStream

ExternalizeSupported()

IMPORT_C TBool ExternalizeSupported ( ) const [virtual]

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

ExternalizeValueL(RWriteStream &)

void ExternalizeValueL ( RWriteStream & aWriteStream ) const [protected, virtual]

Parameters

RWriteStream & aWriteStream

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.

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

RPointerArray < CSIPHeaderBase > * aArray an array of CSIPHeaderBase pointers, the ownership of the array is transferred

ResetAndDestroy(TAny *)

void ResetAndDestroy ( TAny * anArray ) [protected, static]

Parameters

TAny * anArray

ToTextL()

IMPORT_C HBufC8 * ToTextL ( ) const

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

ToTextLC()

IMPORT_C HBufC8 * ToTextLC ( ) const

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

ToTextValueL()

IMPORT_C HBufC8 * ToTextValueL ( ) const [pure virtual]

Encodes the header's value into its textual representation.

ToTextValueLC()

IMPORT_C HBufC8 * ToTextValueLC ( ) const

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

Member Enumerations Documentation

Enum TPreferredPlace

Enumerators

ETop
EMiddleTop
EMiddle
EMiddleBottom
EBottom

Member Data Documentation

TSglQueLink iLink

TSglQueLink iLink