Class CSIPRouteHeader

class CSIPRouteHeader : public CSIPRouteHeaderBase;

Description

Class for SIP "Route"-header manipulation.

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"

• CSIPRouteHeaderBase - A base class for "Route"-, "Record-Route"- and "Service-Route"-headers

• CSIPRouteHeader - Class for SIP "Route"-header manipulation

Members

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

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 CSIPRouteHeaderBase:
SIPAddress(), SetSIPAddressL()

static IMPORT_C CSIPRouteHeader *NewL(CSIPAddress *aSIPAddress);

Pre-Condition

aSIPAddress != 0

Description

Creates a new instance of CSIPRouteHeader

Parameters

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

Return value

CSIPRouteHeader * a new instance of CSIPRouteHeader

static IMPORT_C CSIPRouteHeader *NewLC(CSIPAddress *aSIPAddress);

Pre-Condition

aSIPAddress != 0

aSIPAddress->Address().HostPort().HasHost() == ETrue

Description

Creates a new instance of CSIPRouteHeader and puts it to CleanupStack

Parameters

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

Return value

CSIPRouteHeader * a new instance of CSIPRouteHeader

IMPORT_C ~CSIPRouteHeader();

Description

Destructor, deletes the resources of CSIPRouteHeader.

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

Description

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

Parameters

const TDesC8 &aValue a value part of a "Route"-header

Return value

RPointerArray< CSIPRouteHeader > an array containing one to many instances of CSIPRouteHeader

static IMPORT_C CSIPHeaderBase *InternalizeValueL(RReadStream &aReadStream);

Description

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

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