Class CSIPAcceptHeader

class CSIPAcceptHeader : public CSIPParameterHeaderBase;

Description

Class provides functions for setting and getting media types and parameters in SIP "Accept" 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"

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

Members

Defined in CSIPAcceptHeader:
CloneL(), DecodeL(), InternalizeValueL(), IsEmpty(), MediaSubtype(), MediaType(), Name(), NewL(), NewLC(), QParameter(), SetMediaSubtypeL(), SetMediaTypeL(), SetQParameterL(), ~CSIPAcceptHeader()

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 CSIPAcceptHeader *NewL(const TDesC8 &aMediaType, const TDesC8 &aMediaSubtype);

Description

Creates a new instance of CSIPAcceptHeader

Parameters

const TDesC8 &aMediaType a media type to set. For example "application" const TDesC8 &aMediaSubtype a media subtype to set. For example "sdp"

Return value

CSIPAcceptHeader * a new instance of CSIPAcceptHeader

static IMPORT_C CSIPAcceptHeader *NewLC(const TDesC8 &aMediaType, const TDesC8 &aMediaSubtype);

Description

Creates a new instance of CSIPAcceptHeader and puts it into the cleanup stack

Parameters

const TDesC8 &aMediaType a media type to set. For example "application" const TDesC8 &aMediaSubtype a media subtype to set. For example "sdp"

Return value

CSIPAcceptHeader * a new instance of CSIPAcceptHeader

IMPORT_C ~CSIPAcceptHeader();

Description

Destructor, deletes the resources of CSIPAcceptHeader.

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

Description

Constructs a CSIPAcceptHeader from textual representation of the header's value part. An empty Accept-header can be created using this function by passing a KNullDesC8 as a parameter.

Parameters

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

Return value

RPointerArray< CSIPAcceptHeader > an array containing one to many instances of CSIPAcceptHeader.

IMPORT_C TBool IsEmpty() const;

Description

Check if the header is empty. If so, the other getters will not return a meaningful value.

Return value

TBool ETrue if empty, EFalse otherwise.

IMPORT_C const TDesC8 &MediaType() const;

Description

Gets the media type from the "Accept" header

Return value

const TDesC8 & a media type

IMPORT_C void SetMediaTypeL(const TDesC8 &aMediaType);

Pre-Condition

IsEmpty() == EFalse

Description

Sets the media type in the "Accept" header

Parameters

const TDesC8 &aMediaType a media type

IMPORT_C const TDesC8 &MediaSubtype() const;

Description

Gets the media subtype from the "Accept" header

Return value

const TDesC8 & a media subtype

IMPORT_C void SetMediaSubtypeL(const TDesC8 &aMediaSubtype);

Pre-Condition

IsEmpty() == EFalse

Description

Sets the media subtype in the "Accept" header

Parameters

const TDesC8 &aMediaSubtype a media subtype

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 CSIPAcceptHeader 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 CSIPAcceptHeader

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