Class CSIPAuthHeaderBase

class CSIPAuthHeaderBase : public CSIPHeaderBase;

Description

A base class for SIP Authorization-, Proxy-Authenticate-, Proxy-Authorization- and WWW-Authenticate-headers

sipcodec.lib

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CSIPHeaderBase - Class provides a generic interface for all the SIP headers

• CSIPAuthHeaderBase - A base class for SIP Authorization-, Proxy-Authenticate-, Proxy-Authorization- and WWW-Authenticate-headers

Members

Defined in CSIPAuthHeaderBase:
AuthScheme(), DeleteParam(), DesParamValue(), ExternalizeSupported(), HasParam(), ParamValue(), Params(), Params(), SetDesParamL(), SetParamAndAddQuotesL(), SetParamL(), ToTextValueL(), ~CSIPAuthHeaderBase()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CSIPHeaderBase:
CloneL(), ExternalizeL(), Name(), PushLC(), ToTextL(), ToTextLC(), ToTextValueLC()

virtual IMPORT_C ~CSIPAuthHeaderBase();

Description

Destructor.

IMPORT_C RStringF AuthScheme() const;

Description

Return value

RStringF the value of the auth-scheme

IMPORT_C TBool HasParam(RStringF aName) const;

Description

Checks if a parameter is present

Parameters

RStringF aName the name of the parameter

Return value

TBool ETrue if present, otherwise EFalse

IMPORT_C RStringF ParamValue(RStringF aName) const;

Pre-Condition

HasParam(aName) == ETrue

Description

Gets a parameter value

Parameters

RStringF aName the name of the parameter

Return value

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

IMPORT_C const TDesC8 &DesParamValue(RStringF aName) const;

Pre-Condition

HasParam(aName) == ETrue

Description

Gets a parameter value stored as a descriptor

Parameters

RStringF aName the name of the parameter

Return value

const TDesC8 & the parameter value if present, otherwise a zero-length length value.

IMPORT_C void SetParamL(RStringF aName, RStringF aValue);

Pre-Condition

HasParam(aName) == EFalse

Description

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.

Parameters

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

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

Pre-Condition

HasParam(aName) == EFalse

Description

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.

Parameters

RStringF aName the name of the parameter const TDesC8 &aValue the parameter value to set

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

Pre-Condition

HasParam(aName) == EFalse

Description

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.

Parameters

RStringF aName the name of the parameter const TDesC8 &aValue the parameter value to which the double quotes will be added

IMPORT_C void DeleteParam(RStringF aName);

Description

Deletes a parameter

Parameters

RStringF aName the parameter name to delete

virtual IMPORT_C TBool ExternalizeSupported() const;

Description

From CSIPHeaderBase ExternalizeSupported

Return value

TBool

virtual HBufC8 *ToTextValueL() const;

Description

Encodes the header's value into its textual representation.

Return value

HBufC8 * a textual representation of the header's value, the ownership is transferred

protected: virtual const CSIPParamContainerBase &Params() const=0;

Description

Return value

const CSIPParamContainerBase &

protected: virtual CSIPParamContainerBase &Params()=0;

Description

Return value

CSIPParamContainerBase &