S60 3rd Edition API Reference: CSIPTimestampHeader Class Reference

CSIPTimestampHeader Class Reference

API published in: S60 3rd Ed

Link against: sipcodec.lib

Capability Information

Required Capabilities

None

#include <siptimestampheader.h>

Inherits CSIPHeaderBase.

Detailed Description

PublishedAll
Released
Class for a SIP Timestamp header.

Public Member Functions

IMPORT_C CSIPTimestampHeader (TReal aTimestamp)
 Constructor.
IMPORT_C ~CSIPTimestampHeader ()
 Destructor.
IMPORT_C void SetTimestamp (TReal aTimestamp)
 Set the timestamp from the "Timestamp" header.
IMPORT_C TReal Timestamp () const
 Gets the timestamp from the "Timestamp" header.
IMPORT_C TBool HasDelay () const
 Check if the delay-part is present.
IMPORT_C void SetDelay (TReal aDelay)
 Set the delay-part of the "Timestamp" header.
IMPORT_C TReal Delay () const
 Gets the delay-part of the "Timestamp" header, if delay-part is present.
IMPORT_C CSIPHeaderBase * CloneL () const
 From CSIPHeaderBase CloneL.
IMPORT_C RStringF Name () const
 From CSIPHeaderBase Name.
IMPORT_C HBufC8 * ToTextValueL () const
 From CSIPHeaderBase ToTextValueL.
TPreferredPlace PreferredPlaceInMessage () const

Static Public Member Functions

static IMPORT_C CSIPTimestampHeader * DecodeL (const TDesC8 &aValue)
 Constructs a CSIPTimestampHeader from textual representation of the header's value part.
static IMPORT_C CSIPHeaderBase * InternalizeValueL (RReadStream &aReadStream)
 Constructs an instance of a CSIPTimestampHeader from a RReadStream.
static RPointerArray< CSIPHeaderBase > BaseDecodeL (const TDesC8 &aValue)

Constructor & Destructor Documentation

IMPORT_C CSIPTimestampHeader::CSIPTimestampHeader ( TReal  aTimestamp  ) 
 

Constructor.

Parameters:
aTimestamp a timestamp value to set.
aDealy a delay value to set.
IMPORT_C CSIPTimestampHeader::~CSIPTimestampHeader (   ) 
 

Destructor.

Member Function Documentation

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

From CSIPHeaderBase CloneL.

Implements CSIPHeaderBase.

static IMPORT_C CSIPTimestampHeader* CSIPTimestampHeader::DecodeL ( const TDesC8 &  aValue  )  [static]
 

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

Parameters:
aValue a value part of a "Timestamp"-header (e.g. "12 3.4")
Returns:
a new instance of CSIPTimestampHeader
IMPORT_C TReal CSIPTimestampHeader::Delay (   )  const
 

Gets the delay-part of the "Timestamp" header, if delay-part is present.

Returns:
a delay value or zero if HasDelay() == EFalse
IMPORT_C TBool CSIPTimestampHeader::HasDelay (   )  const
 

Check if the delay-part is present.

Returns:
a delay value.
static IMPORT_C CSIPHeaderBase* CSIPTimestampHeader::InternalizeValueL ( RReadStream &  aReadStream  )  [static]
 

Constructs an instance of a CSIPTimestampHeader from a RReadStream.

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

From CSIPHeaderBase Name.

Implements CSIPHeaderBase.

TPreferredPlace CSIPTimestampHeader::PreferredPlaceInMessage (   )  const [virtual]
 

Implements CSIPHeaderBase.

IMPORT_C void CSIPTimestampHeader::SetDelay ( TReal  aDelay  ) 
 

Set the delay-part of the "Timestamp" header.

Parameters:
aDelay a delay to set.
IMPORT_C void CSIPTimestampHeader::SetTimestamp ( TReal  aTimestamp  ) 
 

Set the timestamp from the "Timestamp" header.

Parameters:
aTimestamp a timestamp to set.
IMPORT_C TReal CSIPTimestampHeader::Timestamp (   )  const
 

Gets the timestamp from the "Timestamp" header.

Returns:
a timestamp value.
IMPORT_C HBufC8* CSIPTimestampHeader::ToTextValueL (   )  const [virtual]
 

From CSIPHeaderBase ToTextValueL.

Implements CSIPHeaderBase.

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