Class CSIPHeaderBase

class CSIPHeaderBase : public CBase;

Description

Class provides a generic interface for all the SIP headers.

sipcodec.lib

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CSIPHeaderBase - Class provides a generic interface for all the SIP headers

Members

Defined in CSIPHeaderBase:
CloneL(), ExternalizeL(), ExternalizeSupported(), Name(), PushLC(), ToTextL(), ToTextLC(), ToTextValueL(), ToTextValueLC(), ~CSIPHeaderBase()

Inherited from CBase:
Delete(), Extension_(), operator new()

virtual IMPORT_C ~CSIPHeaderBase();

Description

Destructor, deletes the resources of CSIPHeaderBase.

virtual IMPORT_C CSIPHeaderBase *CloneL() const=0;

Description

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

Return value

CSIPHeaderBase * the deep-copied object, the ownership is transferred.

virtual IMPORT_C RStringF Name() const=0;

Description

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

Return value

RStringF the full name of the header for example "From"

IMPORT_C HBufC8 *ToTextL() const;

Description

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

Return value

HBufC8 * a textual representation of the complete header, the ownership is transferred

IMPORT_C HBufC8 *ToTextLC() const;

Description

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

Return value

HBufC8 * a textual representation of the complete header, the ownership is transferred

virtual IMPORT_C HBufC8 *ToTextValueL() const=0;

Description

Encodes the header's value into its textual representation.

Return value

HBufC8 * a textual representation of the header's value, the ownership is transferred

IMPORT_C HBufC8 *ToTextValueLC() const;

Description

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

Return value

HBufC8 * a textual representation of the header's value, the ownership is transferred

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

Description

Writes the object to a RWriteStream

Parameters

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

virtual IMPORT_C TBool ExternalizeSupported() const;

Description

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

Return value

TBool ETrue, if the header supports serialization, otherwise EFalse

static IMPORT_C void PushLC(RPointerArray< CSIPHeaderBase > *aArray);

Description

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