Class CSIPSecurityClientHeader

class CSIPSecurityClientHeader : public CSIPSecurityHeaderBase;

Description

Class provides functions for setting and getting SIP "Security-Client" header fields.

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

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

• CSIPSecurityHeaderBase - A base class for Security-Client, Security-Server and Security-Verify

• CSIPSecurityClientHeader - Class provides functions for setting and getting SIP "Security-Client" header fields

Members

Defined in CSIPSecurityClientHeader:
CloneL(), DecodeL(), InternalizeValueL(), Name(), NewL(), NewLC(), ~CSIPSecurityClientHeader()

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

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

Inherited from CSIPParameterHeaderBase:
DeleteParam(), HasParam(), Param(), ParamCount(), ParamValue(), SetParamL(), ToTextValueL()

Inherited from CSIPSecurityHeaderBase:
MechanismName(), PreferenceParam(), SetMechanismNameL(), SetPreferenceParamL()

static IMPORT_C CSIPSecurityClientHeader *NewL(const TDesC8 &aMechanism);

Description

Creates a new instance of CSIPSecurityClientHeader

Parameters

const TDesC8 &aMechanism a Mechanism-Name parameter in the "Security-Client" header

Return value

CSIPSecurityClientHeader * a new instance of CSIPSecurityClientHeader

static IMPORT_C CSIPSecurityClientHeader *NewLC(const TDesC8 &aMechanism);

Description

Creates a new instance of CSIPSecurityClientHeader and puts it to CleanupStack

Parameters

const TDesC8 &aMechanism a Mechanism-Name parameter in the "Security-Client" header

Return value

CSIPSecurityClientHeader * a new instance of CSIPSecurityClientHeader

IMPORT_C ~CSIPSecurityClientHeader();

Description

Destructor, deletes the resources of CSIPSecurityClientHeader.

static IMPORT_C RPointerArray< CSIPSecurityClientHeader > DecodeL(const TDesC8 &aValue);

Description

Constructs a CSIPSecurityClientHeader from textual representation of the header's value part.

Parameters

const TDesC8 &aValue a value part of a "Security-Client"-header

Return value

RPointerArray< CSIPSecurityClientHeader > an array containing 1..n instances of CSIPSecurityClientHeader

static IMPORT_C CSIPHeaderBase *InternalizeValueL(RReadStream &aReadStream);

Description

Constructs an instance of a CSIPSecurityClientHeader from a RReadStream

Parameters

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

Return value

CSIPHeaderBase * an instance of a CSIPSecurityClientHeader

virtual IMPORT_C CSIPHeaderBase *CloneL() const;

Description

From CSIPHeaderBase CloneL

Return value

CSIPHeaderBase *

virtual IMPORT_C RStringF Name() const;

Description

From CSIPHeaderBase Name

Return value

RStringF