Class CSIPReferToHeader

class CSIPReferToHeader : public CSIPAddressHeaderBase;

Description

Class provides functions for setting and getting parameters in SIP "Refer-To" header.

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"

• CSIPAddressHeaderBase - A base class for SIP headers having syntax ( name-addr/ addr-spec ) *(generic-param)

• CSIPReferToHeader - Class provides functions for setting and getting parameters in SIP "Refer-To" header

Members

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

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

Inherited from CSIPAddressHeaderBase:
SIPAddress(), SetSIPAddressL()

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

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

static IMPORT_C CSIPReferToHeader *NewL(CSIPAddress *aSIPAddress);

Pre-Condition

aSIPAddress != 0

Description

Creates a new instance of CSIPReferToHeader

Parameters

CSIPAddress *aSIPAddress a name-address, the ownership is transferred.

Return value

CSIPReferToHeader * a new instance of CSIPReferToHeader

static IMPORT_C CSIPReferToHeader *NewLC(CSIPAddress *aSIPAddress);

Pre-Condition

aSIPAddress != 0

Description

Creates a new instance of CSIPReferToHeader and puts it to CleanupStack

Parameters

CSIPAddress *aSIPAddress a name-address, the ownership is transferred,

Return value

CSIPReferToHeader * a new instance of CSIPReferToHeader

virtual IMPORT_C ~CSIPReferToHeader();

Description

Destructor, deletes the resources of CSIPReferToHeader.

static IMPORT_C CSIPReferToHeader *DecodeL(const TDesC8 &aValue);

Description

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

Parameters

const TDesC8 &aValue a value part of a "Refer-To"-header (e.g. "User <user@host>")

Return value

CSIPReferToHeader * a new instance of CSIPReferToHeader

static IMPORT_C CSIPHeaderBase *InternalizeValueL(RReadStream &aReadStream);

Description

Constructs an instance of a CSIPReferToHeader 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 CSIPReferToHeader

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