CSIPAuthHeaderBase Class Reference

#include <mw/sipauthheaderbase.h>

Link against: sipcodec.lib

class CSIPAuthHeaderBase : public CSIPHeaderBase

Inherits from

CSIPAuthHeaderBase
- CSIPHeaderBase
  - CBase

Public Member Functions
virtual	~CSIPAuthHeaderBase()
IMPORT_C RStringF	AuthScheme()
IMPORT_C void	DeleteParam(RStringF)
IMPORT_C const TDesC8 &	DesParamValue(RStringF)
virtual TBool	EncodeMultipleToOneLine()
virtual IMPORT_C TBool	ExternalizeSupported()
IMPORT_C TBool	HasParam(RStringF)
virtual TBool	MoreThanOneAllowed()
IMPORT_C RStringF	ParamValue(RStringF)
virtual TPreferredPlace	PreferredPlaceInMessage()
IMPORT_C void	SetDesParamL(RStringF, const TDesC8 &)
IMPORT_C void	SetParamAndAddQuotesL(RStringF, const TDesC8 &)
IMPORT_C void	SetParamL(RStringF, RStringF)
virtual HBufC8 *	ToTextValueL()

Protected Member Functions
	CSIPAuthHeaderBase()
void	ConstructL(RStringF)
pure virtual const CSIPParamContainerBase &	Params()
pure virtual CSIPParamContainerBase &	Params()
void	ParseL(const TDesC8 &)
void	SetAuthSchemeL(const TDesC8 &)

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::ExternalizeL(RWriteStream &,TBool)const
	CSIPHeaderBase::ExternalizeNameL(RWriteStream &)const
	CSIPHeaderBase::ExternalizeValueL(RWriteStream &)const
	CSIPHeaderBase::HasCompactName()const
	CSIPHeaderBase::IsExtensionHeader()const
	CSIPHeaderBase::Name()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 Authorization-, Proxy-Authenticate-, Proxy-Authorization- and WWW-Authenticate-headers

Constructor & Destructor Documentation

CSIPAuthHeaderBase ( )

CSIPAuthHeaderBase

(

)

[protected]

~CSIPAuthHeaderBase ( )

IMPORT_C

~CSIPAuthHeaderBase

(

)

[virtual]

Destructor.

Member Function Documentation

AuthScheme ( )

IMPORT_C RStringF

AuthScheme

(

)

const

Return Value: the value of the auth-scheme

ConstructL ( RStringF )

void

ConstructL

(

RStringF

aAuthScheme

)

[protected]

DeleteParam ( RStringF )

IMPORT_C void

DeleteParam

(

RStringF

aName

)

Deletes a parameter

Parameters
aName	the parameter name to delete

DesParamValue ( RStringF )

IMPORT_C const TDesC8 &

DesParamValue

(

RStringF

aName

)

const

Gets a parameter value stored as a descriptor

Pre-condition: HasParam(aName) == ETrue

Parameters
aName	the name of the parameter

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

EncodeMultipleToOneLine ( )

TBool

EncodeMultipleToOneLine

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::EncodeMultipleToOneLine()const

ExternalizeSupported ( )

IMPORT_C TBool

ExternalizeSupported

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::ExternalizeSupported()const

From CSIPHeaderBase ExternalizeSupported

HasParam ( RStringF )

IMPORT_C TBool

HasParam

(

RStringF

aName

)

const

Checks if a parameter is present

Parameters
aName	the name of the parameter

Return Value: ETrue if present, otherwise EFalse

MoreThanOneAllowed ( )

TBool

MoreThanOneAllowed

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::MoreThanOneAllowed()const

ParamValue ( RStringF )

IMPORT_C RStringF

ParamValue

(

RStringF

aName

)

const

Gets a parameter value

Pre-condition: HasParam(aName) == ETrue

Parameters
aName	the name of the parameter

Return Value: 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 & )

void

ParseL

(

const TDesC8 &

aValue

)

[protected]

PreferredPlaceInMessage ( )

TPreferredPlace

PreferredPlaceInMessage

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::PreferredPlaceInMessage()const

SetAuthSchemeL ( const TDesC8 & )

void

SetAuthSchemeL

(

const TDesC8 &

aAuthScheme

)

[protected]

SetDesParamL ( RStringF, const TDesC8 & )

IMPORT_C void	SetDesParamL	(	RStringF	aName,
			const TDesC8 &	aValue
		)

Sets a parameter with a value. Takes copies of the name so if the RStringF have been dynamically allocated, they can be closed if necessary after the function returns. Stores the parameter value as a descriptor, so that the case-sensitivity is not lost in RStringF-descriptor conversions.

Pre-condition: HasParam(aName) == EFalse

Parameters
aName	the name of the parameter
aValue	the parameter value to set

SetParamAndAddQuotesL ( RStringF, const TDesC8 & )

IMPORT_C void	SetParamAndAddQuotesL	(	RStringF	aName,
			const TDesC8 &	aValue
		)

Sets a parameter with a value and adds double quotes as the first and the last character in the 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
aName	the name of the parameter
aValue	the parameter value to which the double quotes will be added

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
aName	the name of the parameter
aValue	the parameter value to set

ToTextValueL ( )

HBufC8 *

ToTextValueL

(

)

const [virtual]

Reimplemented from CSIPHeaderBase::ToTextValueL()const

Encodes the header's value into its textual representation.

Return Value: a textual representation of the header's value, the ownership is transferred