CSIPAcceptEncodingHeader Class Reference

#include <mw/sipacceptencodingheader.h>

Link against: sipcodec.lib

class CSIPAcceptEncodingHeader : public CSIPParameterHeaderBase

Inherits from

CSIPAcceptEncodingHeader
- CSIPParameterHeaderBase
  - CSIPHeaderBase
    - CBase

Public Member Functions
	~CSIPAcceptEncodingHeader()
RPointerArray< CSIPHeaderBase >	BaseDecodeL(const TDesC8 &)
virtual IMPORT_C CSIPHeaderBase *	CloneL()
IMPORT_C const TDesC8 &	Codings()
IMPORT_C RPointerArray< CSIPAcceptEncodingHeader >	DecodeL(const TDesC8 &)
IMPORT_C CSIPHeaderBase *	InternalizeValueL(RReadStream &)
virtual TBool	MoreThanOneAllowed()
virtual IMPORT_C RStringF	Name()
IMPORT_C CSIPAcceptEncodingHeader *	NewL(const TDesC8 &)
IMPORT_C CSIPAcceptEncodingHeader *	NewLC(const TDesC8 &)
virtual TPreferredPlace	PreferredPlaceInMessage()
IMPORT_C TReal	QParameter()
IMPORT_C void	SetCodingsL(const TDesC8 &)
IMPORT_C void	SetQParameterL(TReal)

Inherited Attributes
	CSIPHeaderBase::iLink

Inherited Enumerations
	CSIPHeaderBase:TPreferredPlace

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()
	CSIPHeaderBase::CSIPHeaderBase()
	CSIPHeaderBase::CompactName()const
	CSIPHeaderBase::EncodeMultipleToOneLine()const
	CSIPHeaderBase::ExternalizeL(RWriteStream &,TBool)const
	CSIPHeaderBase::ExternalizeNameL(RWriteStream &)const
	CSIPHeaderBase::ExternalizeSupported()const
	CSIPHeaderBase::HasCompactName()const
	CSIPHeaderBase::IsExtensionHeader()const
	CSIPHeaderBase::PushLC(RPointerArray< CSIPHeaderBase > *)
	CSIPHeaderBase::ResetAndDestroy(TAny *)
	CSIPHeaderBase::ToTextL()const
	CSIPHeaderBase::ToTextLC()const
	CSIPHeaderBase::ToTextValueLC()const
	CSIPHeaderBase::~CSIPHeaderBase()
	CSIPParameterHeaderBase::CSIPParameterHeaderBase(const TChar &)
	CSIPParameterHeaderBase::DeleteParam(RStringF)
	CSIPParameterHeaderBase::HasParam(RStringF)const
	CSIPParameterHeaderBase::Param(TInt,RStringF &)const
	CSIPParameterHeaderBase::ParamCount()const
	CSIPParameterHeaderBase::ParamInsertionAllowed()const
	CSIPParameterHeaderBase::ParamValue(RStringF)const
	CSIPParameterHeaderBase::ParseL(const TDesC8 &,TBool,TBool)
	CSIPParameterHeaderBase::SetParamL(RStringF)
	CSIPParameterHeaderBase::SetParamL(RStringF,RStringF)
	CSIPParameterHeaderBase::ToTextValueL()const
	CSIPParameterHeaderBase::~CSIPParameterHeaderBase()

Detailed Description

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

Constructor & Destructor Documentation

~CSIPAcceptEncodingHeader ( )

IMPORT_C

~CSIPAcceptEncodingHeader

(

)

Destructor, deletes the resources of CSIPAcceptEncodingHeader.

Member Function Documentation

BaseDecodeL ( const TDesC8 & )

RPointerArray< CSIPHeaderBase >

BaseDecodeL

(

const TDesC8 &

aValue

)

[static]

CloneL ( )

IMPORT_C CSIPHeaderBase *

CloneL

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::CloneL()const

From CSIPHeaderBase CloneL

Codings ( )

IMPORT_C const TDesC8 &

Codings

(

)

const

Gets the codings from the "Accept-Encoding" header

Return Value: codings

DecodeL ( const TDesC8 & )

IMPORT_C RPointerArray< CSIPAcceptEncodingHeader >

DecodeL

(

const TDesC8 &

aValue

)

[static]

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

Parameters
aValue	a value part of a "Accept-Encoding"-header

Return Value: An array containing one to many CSIPAcceptEncodingHeader instances

InternalizeValueL ( RReadStream & )

IMPORT_C CSIPHeaderBase *

InternalizeValueL

(

RReadStream &

aReadStream

)

[static]

Constructs an instance of a CSIPAcceptEncodingHeader from a RReadStream

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

Return Value: An instance of a CSIPAcceptEncodingHeader

MoreThanOneAllowed ( )

TBool

MoreThanOneAllowed

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::MoreThanOneAllowed()const

Name ( )

IMPORT_C RStringF

Name

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::Name()const

From CSIPHeaderBase Name

NewL ( const TDesC8 & )

IMPORT_C CSIPAcceptEncodingHeader *

NewL

(

const TDesC8 &

aCodings

)

[static]

Creates a new instance of CSIPAcceptEncodingHeader

Parameters
aCodings	a codings to set.

Return Value: a new instance of CSIPAcceptEncodingHeader

NewLC ( const TDesC8 & )

IMPORT_C CSIPAcceptEncodingHeader *

NewLC

(

const TDesC8 &

aCodings

)

[static]

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

Parameters
aCodings	a codings to set.

Return Value: a new instance of CSIPAcceptEncodingHeader

PreferredPlaceInMessage ( )

TPreferredPlace

PreferredPlaceInMessage

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::PreferredPlaceInMessage()const

QParameter ( )

IMPORT_C TReal

QParameter

(

)

const

Gets the value of "q"-parameter

Return Value: the "q"-parameter value

SetCodingsL ( const TDesC8 & )

IMPORT_C void

SetCodingsL

(

const TDesC8 &

aCodings

)

Sets the codings in the "Accept-Encoding" header

Parameters
aCodings	the codings

SetQParameterL ( TReal )

IMPORT_C void

SetQParameterL

(

TReal

aQValue

)

Sets the "q"-parameter value

Parameters
aQValue	a "q"-parameter value to set