Collapse all Symbian^3 Product Developer Library

CSIPParameterHeaderBase Class Reference

class CSIPParameterHeaderBase : public CSIPHeaderBase

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

This is an abstract class and cannot be instantiated.

sipcodec.lib

Inherits from

CSIPParameterHeaderBase
- CSIPHeaderBase
  - CBase

Public Member Functions
	~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)
IMPORT_C HBufC8 *	ToTextValueL()

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

Private Member Functions
	CSIPParameterHeaderBase()

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()

Inherited Enumerations
	CSIPHeaderBase:TPreferredPlace

Private Attributes
TChar	iSeparator

Inherited Attributes
	CSIPHeaderBase::iLink

Constructor & Destructor Documentation

CSIPParameterHeaderBase(const TChar &)

CSIPParameterHeaderBase

(

const TChar &

aSeparator

)

[protected]

Parameters

const TChar & aSeparator

CSIPParameterHeaderBase()

CSIPParameterHeaderBase

(

)

[private]

~CSIPParameterHeaderBase()

IMPORT_C

~CSIPParameterHeaderBase

(

)

[virtual]

Destructor, deletes the resources of CSIPParameterHeaderBase.

Member Functions Documentation

DeleteParam(RStringF)

IMPORT_C void

DeleteParam

(

RStringF

aName

)

Deletes a parameter

Parameters

RStringF aName

the parameter name to delete

HasParam(RStringF)

IMPORT_C TBool

HasParam

(

RStringF

aName

)

const

Checks if a parameter is present

Parameters

RStringF aName

the name of the parameter

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.

Parameters

TInt aIndex	the index of the parameter
RStringF & aName	copy of the parameter name that must be closed by the caller.

ParamCount()

IMPORT_C TInt

ParamCount

(

)

const

Gets the 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

Parameters

RStringF aName

the name of the parameter

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]

Parameters

const TDesC8 & aValue
TBool aIgnoreParenthesis = ETrue
TBool aSkipSeparatorsBeforeAt = EFalse

ParseMandatoryPartL(const TDesC8 &)

void

ParseMandatoryPartL

(

const TDesC8 &

aMandatoryPart

)

[protected, pure virtual]

Parameters

const TDesC8 & aMandatoryPart

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

Parameters

RStringF aName	the name of the parameter
RStringF 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

Parameters

RStringF aName

the parameter name to set

ToTextMandatoryPartLC()

HBufC8 *

ToTextMandatoryPartLC

(

)

const [protected, pure virtual]

ToTextValueL()

IMPORT_C HBufC8 *

ToTextValueL

(

)

const [virtual]

From CSIPHeaderBase ToTextValueL

Member Data Documentation

TChar iSeparator

TChar

iSeparator

[private]