CSIPAcceptHeader Class Reference

#include <mw/sipacceptheader.h>

Link against: sipcodec.lib

class CSIPAcceptHeader : public CSIPParameterHeaderBase

Inherits from

CSIPAcceptHeader
- CSIPParameterHeaderBase
  - CSIPHeaderBase

Public Member Functions
	~CSIPAcceptHeader()
RPointerArray< CSIPHeaderBase >	BaseDecodeL(const TDesC8 &)
virtual IMPORT_C CSIPHeaderBase *	CloneL()
IMPORT_C RPointerArray< CSIPAcceptHeader >	DecodeL(const TDesC8 &)
IMPORT_C CSIPHeaderBase *	InternalizeValueL(RReadStream &)
IMPORT_C TBool	IsEmpty()
IMPORT_C const TDesC8 &	MediaSubtype()
IMPORT_C const TDesC8 &	MediaType()
virtual TBool	MoreThanOneAllowed()
virtual IMPORT_C RStringF	Name()
IMPORT_C CSIPAcceptHeader *	NewL(const TDesC8 &, const TDesC8 &)
IMPORT_C CSIPAcceptHeader *	NewLC(const TDesC8 &, const TDesC8 &)
virtual TPreferredPlace	PreferredPlaceInMessage()
IMPORT_C TReal	QParameter()
IMPORT_C void	SetMediaSubtypeL(const TDesC8 &)
IMPORT_C void	SetMediaTypeL(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" header.

Constructor & Destructor Documentation

~CSIPAcceptHeader ( )

IMPORT_C

~CSIPAcceptHeader

(

)

Destructor, deletes the resources of CSIPAcceptHeader.

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

DecodeL ( const TDesC8 & )

IMPORT_C RPointerArray< CSIPAcceptHeader >

DecodeL

(

const TDesC8 &

aValue

)

[static]

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.

Parameter	Description
aValue	a value part of a "Accept"-header

Returns: an array containing one to many instances of CSIPAcceptHeader.

InternalizeValueL ( RReadStream & )

IMPORT_C CSIPHeaderBase *

InternalizeValueL

(

RReadStream &

aReadStream

)

[static]

Constructs an instance of a CSIPAcceptHeader from a RReadStream

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

Returns: An instance of a CSIPAcceptHeader

IsEmpty ( )

IMPORT_C TBool

IsEmpty

(

)

const

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

Returns: ETrue if empty, EFalse otherwise.

MediaSubtype ( )

IMPORT_C const TDesC8 &

MediaSubtype

(

)

const

Gets the media subtype from the "Accept" header

Returns: a media subtype

MediaType ( )

IMPORT_C const TDesC8 &

MediaType

(

)

const

Gets the media type from the "Accept" header

Returns: a media type

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 &, const TDesC8 & )

IMPORT_C CSIPAcceptHeader *	NewL	(	const TDesC8 &	aMediaType,
			const TDesC8 &	aMediaSubtype
		)	[static]

Creates a new instance of CSIPAcceptHeader

Parameter	Description
aMediaType	a media type to set. For example "application"
aMediaSubtype	a media subtype to set. For example "sdp"

Returns: a new instance of CSIPAcceptHeader

NewLC ( const TDesC8 &, const TDesC8 & )

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

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

Parameter	Description
aMediaType	a media type to set. For example "application"
aMediaSubtype	a media subtype to set. For example "sdp"

Returns: a new instance of CSIPAcceptHeader

PreferredPlaceInMessage ( )

TPreferredPlace

PreferredPlaceInMessage

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::PreferredPlaceInMessage()const

QParameter ( )

IMPORT_C TReal

QParameter

(

)

const

Gets the value of "q"-parameter

Returns: the "q"-parameter value

SetMediaSubtypeL ( const TDesC8 & )

IMPORT_C void

SetMediaSubtypeL

(

const TDesC8 &

aMediaSubtype

)

Sets the media subtype in the "Accept" header

Pre-condition: IsEmpty() == EFalse

Parameter	Description
aMediaSubtype	a media subtype

SetMediaTypeL ( const TDesC8 & )

IMPORT_C void

SetMediaTypeL

(

const TDesC8 &

aMediaType

)

Sets the media type in the "Accept" header

Pre-condition: IsEmpty() == EFalse

Parameter	Description
aMediaType	a media type

SetQParameterL ( TReal )

IMPORT_C void

SetQParameterL

(

TReal

aQValue

)

Sets the "q"-parameter value

Parameter	Description
aQValue	a "q"-parameter value to set