CSIPParameterHeaderBase Class Reference

#include <mw/sipparameterheaderbase.h>

Link against: sipcodec.lib

class CSIPParameterHeaderBase : public CSIPHeaderBase

Inherits from

CSIPParameterHeaderBase
- CSIPHeaderBase

Public Member Functions
virtual	~CSIPParameterHeaderBase()
IMPORT_C void	DeleteParam(RStringF)
IMPORT_C TBool	HasParam(RStringF)
IMPORT_C TInt	Param(TInt, RStringF &)
IMPORT_C TInt	ParamCount()
IMPORT_C RStringF	ParamValue(RStringF)
IMPORT_C void	SetParamL(RStringF, RStringF)
IMPORT_C void	SetParamL(RStringF)
virtual IMPORT_C HBufC8 *	ToTextValueL()

Protected Member Functions
	CSIPParameterHeaderBase(const TChar &)
virtual TBool	ParamInsertionAllowed()
pure virtual const CSIPParamContainerBase &	Params()
pure virtual CSIPParamContainerBase &	Params()
void	ParseL(const TDesC8 &, TBool, TBool)
pure virtual void	ParseMandatoryPartL(const TDesC8 &)
pure virtual HBufC8 *	ToTextMandatoryPartLC()

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::CloneL()const
	CSIPHeaderBase::CompactName()const
	CSIPHeaderBase::EncodeMultipleToOneLine()const
	CSIPHeaderBase::ExternalizeL(RWriteStream &,TBool)const
	CSIPHeaderBase::ExternalizeNameL(RWriteStream &)const
	CSIPHeaderBase::ExternalizeSupported()const
	CSIPHeaderBase::ExternalizeValueL(RWriteStream &)const
	CSIPHeaderBase::HasCompactName()const
	CSIPHeaderBase::IsExtensionHeader()const
	CSIPHeaderBase::MoreThanOneAllowed()const
	CSIPHeaderBase::Name()const
	CSIPHeaderBase::PreferredPlaceInMessage()const
	CSIPHeaderBase::PushLC(RPointerArray< CSIPHeaderBase > *)
	CSIPHeaderBase::ResetAndDestroy(TAny *)
	CSIPHeaderBase::ToTextL()const
	CSIPHeaderBase::ToTextLC()const
	CSIPHeaderBase::ToTextValueLC()const
	CSIPHeaderBase::~CSIPHeaderBase()

Detailed Description

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

This is an abstract class and cannot be instantiated.

Constructor & Destructor Documentation

CSIPParameterHeaderBase ( const TChar & )

CSIPParameterHeaderBase

(

const TChar &

aSeparator

)

[protected]

~CSIPParameterHeaderBase ( )

IMPORT_C

~CSIPParameterHeaderBase

(

)

[virtual]

Destructor, deletes the resources of CSIPParameterHeaderBase.

Member Function Documentation

DeleteParam ( RStringF )

IMPORT_C void

DeleteParam

(

RStringF

aName

)

Deletes a parameter

Parameter	Description
aName	the parameter name to delete

HasParam ( RStringF )

IMPORT_C TBool

HasParam

(

RStringF

aName

)

const

Checks if a parameter is present

Parameter	Description
aName	the name of the parameter

Returns: ETrue if present, otherwise EFalse

Param ( TInt, RStringF & )

IMPORT_C TInt	Param	(	TInt	aIndex,
			RStringF &	aName
		)	const

Gets a header parameter name by index. This function can be used when looping through all the header parameters.

Parameter	Description
aIndex	the index of the parameter
aName	copy of the parameter name that must be closed by the caller.

Returns: KErrNotFound if aIndex is invalid. Otherwise EFalse.

ParamCount ( )

IMPORT_C TInt

ParamCount

(

)

const

Gets the count of header parameters

Returns: count of header parameters

ParamInsertionAllowed ( )

TBool

ParamInsertionAllowed

(

)

const [protected, virtual]

ParamValue ( RStringF )

IMPORT_C RStringF

ParamValue

(

RStringF

aName

)

const

Gets a parameter value

Pre-condition: HasParam(aName) == ETrue

Parameter	Description
aName	the name of the parameter

Returns: the parameter value if present, otherwise a zero-length length value.

Params ( )

const CSIPParamContainerBase &

Params

(

)

const [protected, pure virtual]

Params ( )

CSIPParamContainerBase &

Params

(

)

[protected, pure virtual]

ParseL ( const TDesC8 &, TBool, TBool )

void	ParseL	(	const TDesC8 &	aValue,
			TBool	aIgnoreParenthesis = ETrue,
			TBool	aSkipSeparatorsBeforeAt = EFalse
		)	[protected]

ParseMandatoryPartL ( const TDesC8 & )

void

ParseMandatoryPartL

(

const TDesC8 &

aMandatoryPart

)

[protected, pure virtual]

SetParamL ( RStringF, RStringF )

IMPORT_C void	SetParamL	(	RStringF	aName,
			RStringF	aValue
		)

Sets a parameter with a value. Takes copies of the name and value, so if the RStringFs have been dynamically allocated, they can be closed if necessary after the function returns.

Pre-condition: HasParam(aName) == EFalse

Parameter	Description
aName	the name of the parameter
aValue	the parameter value to set

SetParamL ( RStringF )

IMPORT_C void

SetParamL

(

RStringF

aName

)

Sets a parameter without a value Takes copy of the name, so if the RStringF has been dynamically allocated, it can be closed if necessary after the function returns.

Pre-condition: HasParam(aName) == EFalse

Parameter	Description
aName	the parameter name to set

ToTextMandatoryPartLC ( )

HBufC8 *

ToTextMandatoryPartLC

(

)

const [protected, pure virtual]

ToTextValueL ( )

IMPORT_C HBufC8 *

ToTextValueL

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::ToTextValueL()const

From CSIPHeaderBase ToTextValueL