S60 3rd Edition API Reference: CSIPExtensionHeader Class Reference

CSIPExtensionHeader Class Reference

API published in: S60 2nd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None

#include <sipextensionheader.h>

Inherits CSIPHeaderBase.

Detailed Description

PublishedAll
Released
The class stores unknown and extension headers that are either not supported by the current SIP codec implementation or not specified in current SIP RFC or both.

Public Member Functions

IMPORT_C ~CSIPExtensionHeader ()
 Destructor, deletes the resources of CSIPExtensionHeader.
IMPORT_C void SetValueL (const TDesC8 &aValue)
 Sets the header value.
IMPORT_C const TDesC8 & Value () const
 Gets the header value.
IMPORT_C CSIPHeaderBase * CloneL () const
 From CSIPHeaderBase CloneL.
IMPORT_C RStringF Name () const
 From CSIPHeaderBase Name.
IMPORT_C HBufC8 * ToTextValueL () const
 From CSIPHeaderBase ToTextValueL.
IMPORT_C TBool ExternalizeSupported () const
 From CSIPHeaderBase ExternalizeSupported.
void SetNameL (const TDesC8 &aName)
TBool IsExtensionHeader () const
TBool EncodeMultipleToOneLine () const
TBool MoreThanOneAllowed () const
TBool HasCompactName () const
RStringF CompactName () const
TPreferredPlace PreferredPlaceInMessage () const

Static Public Member Functions

static IMPORT_C CSIPExtensionHeader * NewL (const TDesC8 &aName, const TDesC8 &aValue)
 Creates a new instance of CSIPExtensionHeader.
static IMPORT_C CSIPExtensionHeader * NewLC (const TDesC8 &aName, const TDesC8 &aValue)
 Creates a new instance of CSIPExtensionHeader and puts it to CleanupStack.
static IMPORT_C CSIPExtensionHeader * InternalizeValueL (RReadStream &aReadStream)
 Constructs an instance of a CSIPExtensionHeader from a RReadStream.

Constructor & Destructor Documentation

IMPORT_C CSIPExtensionHeader::~CSIPExtensionHeader (   ) 
 

Destructor, deletes the resources of CSIPExtensionHeader.

Member Function Documentation

IMPORT_C CSIPHeaderBase* CSIPExtensionHeader::CloneL (   )  const [virtual]
 

From CSIPHeaderBase CloneL.

Implements CSIPHeaderBase.

RStringF CSIPExtensionHeader::CompactName (   )  const [virtual]
 

Reimplemented from CSIPHeaderBase.

TBool CSIPExtensionHeader::EncodeMultipleToOneLine (   )  const [virtual]
 

Reimplemented from CSIPHeaderBase.

IMPORT_C TBool CSIPExtensionHeader::ExternalizeSupported (   )  const [virtual]
 

From CSIPHeaderBase ExternalizeSupported.

Reimplemented from CSIPHeaderBase.

TBool CSIPExtensionHeader::HasCompactName (   )  const [virtual]
 

Reimplemented from CSIPHeaderBase.

static IMPORT_C CSIPExtensionHeader* CSIPExtensionHeader::InternalizeValueL ( RReadStream &  aReadStream  )  [static]
 

Constructs an instance of a CSIPExtensionHeader from a RReadStream.

Parameters:
aReadStream a stream containing the value of the externalized header object (header name not included).
Returns:
an instance of a CSIPExtensionHeader
TBool CSIPExtensionHeader::IsExtensionHeader (   )  const [virtual]
 

Reimplemented from CSIPHeaderBase.

TBool CSIPExtensionHeader::MoreThanOneAllowed (   )  const [virtual]
 

Reimplemented from CSIPHeaderBase.

IMPORT_C RStringF CSIPExtensionHeader::Name (   )  const [virtual]
 

From CSIPHeaderBase Name.

Implements CSIPHeaderBase.

static IMPORT_C CSIPExtensionHeader* CSIPExtensionHeader::NewL ( const TDesC8 &  aName,
const TDesC8 &  aValue
)  [static]
 

Creates a new instance of CSIPExtensionHeader.

Parameters:
aName the full or compact name of the header
aValue the value of the header
Returns:
a new instance of CSIPExtensionHeader
static IMPORT_C CSIPExtensionHeader* CSIPExtensionHeader::NewLC ( const TDesC8 &  aName,
const TDesC8 &  aValue
)  [static]
 

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

Parameters:
aName the full or compact name of the header
aValue the value of the header
Returns:
a new instance of CSIPExtensionHeader
TPreferredPlace CSIPExtensionHeader::PreferredPlaceInMessage (   )  const [virtual]
 

Implements CSIPHeaderBase.

void CSIPExtensionHeader::SetNameL ( const TDesC8 &  aName  ) 
 
IMPORT_C void CSIPExtensionHeader::SetValueL ( const TDesC8 &  aValue  ) 
 

Sets the header value.

Parameters:
aValue the header value to be set
IMPORT_C HBufC8* CSIPExtensionHeader::ToTextValueL (   )  const [virtual]
 

From CSIPHeaderBase ToTextValueL.

Implements CSIPHeaderBase.

IMPORT_C const TDesC8& CSIPExtensionHeader::Value (   )  const
 

Gets the header value.

Returns:
the header value
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top