Class CSIPAcceptEncodingHeader

class CSIPAcceptEncodingHeader : public CSIPParameterHeaderBase;

Description

Class provides functions for setting and getting media types and parameters in SIP "Accept-Encoding" header.

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

• CSIPParameterHeaderBase - A base class for SIP headers that have structure "mandatory part"delimiter"parameters"

• CSIPAcceptEncodingHeader - Class provides functions for setting and getting media types and parameters in SIP "Accept-Encoding" header

Members

Defined in CSIPAcceptEncodingHeader:
CloneL(), Codings(), DecodeL(), InternalizeValueL(), Name(), NewL(), NewLC(), QParameter(), SetCodingsL(), SetQParameterL(), ~CSIPAcceptEncodingHeader()

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

Inherited from CSIPHeaderBase:
ExternalizeL(), ExternalizeSupported(), PushLC(), ToTextL(), ToTextLC(), ToTextValueLC()

Inherited from CSIPParameterHeaderBase:
DeleteParam(), HasParam(), Param(), ParamCount(), ParamValue(), SetParamL(), ToTextValueL()

static IMPORT_C CSIPAcceptEncodingHeader *NewL(const TDesC8 &aCodings);

Description

Creates a new instance of CSIPAcceptEncodingHeader

Parameters

const TDesC8 &aCodings a codings to set.

Return value

CSIPAcceptEncodingHeader * a new instance of CSIPAcceptEncodingHeader

static IMPORT_C CSIPAcceptEncodingHeader *NewLC(const TDesC8 &aCodings);

Description

Creates a new instance of CSIPAcceptEncodingHeader and puts it onto the cleanup stack

Parameters

const TDesC8 &aCodings a codings to set.

Return value

CSIPAcceptEncodingHeader * a new instance of CSIPAcceptEncodingHeader

IMPORT_C ~CSIPAcceptEncodingHeader();

Description

Destructor, deletes the resources of CSIPAcceptEncodingHeader.

static IMPORT_C RPointerArray< CSIPAcceptEncodingHeader > DecodeL(const TDesC8 &aValue);

Description

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

Parameters

const TDesC8 &aValue a value part of a "Accept-Encoding"-header

Return value

RPointerArray< CSIPAcceptEncodingHeader > An array containing one to many CSIPAcceptEncodingHeader instances

IMPORT_C const TDesC8 &Codings() const;

Description

Gets the codings from the "Accept-Encoding" header

Return value

const TDesC8 & codings

IMPORT_C void SetCodingsL(const TDesC8 &aCodings);

Description

Sets the codings in the "Accept-Encoding" header

Parameters

const TDesC8 &aCodings the codings

IMPORT_C TReal QParameter() const;

Description

Gets the value of "q"-parameter

Return value

TReal the "q"-parameter value

IMPORT_C void SetQParameterL(TReal aQValue);

Description

Sets the "q"-parameter value

Parameters

TReal aQValue a "q"-parameter value to set´

static IMPORT_C CSIPHeaderBase *InternalizeValueL(RReadStream &aReadStream);

Description

Constructs an instance of a CSIPAcceptEncodingHeader from a RReadStream

Parameters

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

Return value

CSIPHeaderBase * An instance of a CSIPAcceptEncodingHeader

virtual IMPORT_C CSIPHeaderBase *CloneL() const;

Description

From CSIPHeaderBase CloneL

Return value

CSIPHeaderBase *

virtual IMPORT_C RStringF Name() const;

Description

From CSIPHeaderBase Name

Return value

RStringF