S60 3rd Edition API Reference: CSIPRouteHeader Class Reference

CSIPRouteHeader Class Reference

API published in: S60 2nd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None

#include <siprouteheader.h>

Inherits CSIPRouteHeaderBase.

Detailed Description

PublishedAll
Released
Class for SIP "Route"-header manipulation.

Public Member Functions

IMPORT_C ~CSIPRouteHeader ()
 Destructor, deletes the resources of CSIPRouteHeader.
IMPORT_C CSIPHeaderBase * CloneL () const
 From CSIPHeaderBase CloneL.
IMPORT_C RStringF Name () const
 From CSIPHeaderBase Name.

Static Public Member Functions

static IMPORT_C RPointerArray<
CSIPRouteHeader > 		DecodeL (const TDesC8 &aValue)
 Constructs a CSIPRouteHeader from textual representation of the header's value part.
static IMPORT_C CSIPRouteHeader * NewL (CSIPAddress *aSIPAddress)
 Creates a new instance of CSIPRouteHeader.
static IMPORT_C CSIPRouteHeader * NewLC (CSIPAddress *aSIPAddress)
 Creates a new instance of CSIPRouteHeader and puts it to CleanupStack.
static IMPORT_C CSIPHeaderBase * InternalizeValueL (RReadStream &aReadStream)
 Constructs an instance of a CCSIPRouteHeader from a RReadStream.
static RPointerArray< CSIPHeaderBase > BaseDecodeL (const TDesC8 &aValue)
static CSIPRouteHeader * NewL (const CSIPRouteHeaderBase &aHeader)

Constructor & Destructor Documentation

IMPORT_C CSIPRouteHeader::~CSIPRouteHeader (   ) 
 

Destructor, deletes the resources of CSIPRouteHeader.

Member Function Documentation

static RPointerArray<CSIPHeaderBase> CSIPRouteHeader::BaseDecodeL ( const TDesC8 &  aValue  )  [static]
 
IMPORT_C CSIPHeaderBase* CSIPRouteHeader::CloneL (   )  const [virtual]
 

From CSIPHeaderBase CloneL.

Implements CSIPHeaderBase.

static IMPORT_C RPointerArray<CSIPRouteHeader> CSIPRouteHeader::DecodeL ( const TDesC8 &  aValue  )  [static]
 

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

Parameters:
aValue a value part of a "Route"-header
Returns:
an array containing one to many instances of CSIPRouteHeader
static IMPORT_C CSIPHeaderBase* CSIPRouteHeader::InternalizeValueL ( RReadStream &  aReadStream  )  [static]
 

Constructs an instance of a CCSIPRouteHeader from a RReadStream.

Parameters:
aReadStream a stream containing the value of the externalized object (header name not included).
Returns:
an instance of a CSIPRouteHeader
IMPORT_C RStringF CSIPRouteHeader::Name (   )  const [virtual]
 

From CSIPHeaderBase Name.

Implements CSIPHeaderBase.

static CSIPRouteHeader* CSIPRouteHeader::NewL ( const CSIPRouteHeaderBase &  aHeader  )  [static]
 
static IMPORT_C CSIPRouteHeader* CSIPRouteHeader::NewL ( CSIPAddress *  aSIPAddress  )  [static]
 

Creates a new instance of CSIPRouteHeader.

Precondition:
aSIPAddress != 0
Parameters:
aSIPAddress a name-address, the ownership is transferred
Returns:
a new instance of CSIPRouteHeader
static IMPORT_C CSIPRouteHeader* CSIPRouteHeader::NewLC ( CSIPAddress *  aSIPAddress  )  [static]
 

Creates a new instance of CSIPRouteHeader and puts it to CleanupStack.

Precondition:
aSIPAddress != 0

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

Parameters:
aSIPAddress a name-address, the ownership is transferred
Returns:
a new instance of CSIPRouteHeader
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top