Class CSIPFromHeader

class CSIPFromHeader : public CSIPFromToHeaderBase;

Description

Class provides functions for setting and getting SIP "From" 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"

• CSIPFromToHeaderBase - Class provides functions for setting and getting parameters in SIP "From" and "To" header

• CSIPFromHeader - Class provides functions for setting and getting SIP "From" header

Members

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

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

Inherited from CSIPFromToHeaderBase:
SIPAddress(), SetSIPAddressL(), operator==()

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

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

static IMPORT_C CSIPFromHeader *NewL(CSIPAddress *aSIPAddress);

Pre-Condition

aSIPAddress != 0

Description

Creates a new instance of CSIPFromHeader

Parameters

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

Return value

CSIPFromHeader * a new instance of CSIPFromHeader

static IMPORT_C CSIPFromHeader *NewLC(CSIPAddress *aSIPAddress);

Pre-Condition

aSIPAddress != 0

Description

Creates a new instance of CSIPFromHeader and puts it to CleanupStack

Parameters

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

Return value

CSIPFromHeader * a new instance of CSIPFromHeader

static IMPORT_C CSIPFromHeader *NewL(const CSIPFromToHeaderBase &aHeader);

Description

Creates a deep-copy of a CSIPFromToHeaderBase Note that this function can be used for creating a From-header using an existing To-header.

Parameters

const CSIPFromToHeaderBase &aHeader CSIPFromToHeaderBase to be copied

Return value

CSIPFromHeader * a new instance of CSIPFromHeader

static IMPORT_C CSIPFromHeader *NewLC(const CSIPFromToHeaderBase &aHeader);

Description

Creates a deep-copy of a CSIPFromToHeaderBase and puts it to CleanupStack Note that this function can be used for creating a From-header using an existing To-header.

Parameters

const CSIPFromToHeaderBase &aHeader CSIPFromToHeaderBase to be copied

Return value

CSIPFromHeader * a new instance of CSIPFromHeader

IMPORT_C ~CSIPFromHeader();

Description

Destructor, deletes the resources of CSIPFromHeader.

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

Description

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

Parameters

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

Return value

CSIPFromHeader * a new instance of CSIPFromHeader

static IMPORT_C CSIPHeaderBase *InternalizeValueL(RReadStream &aReadStream);

Description

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

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