CSIPTimestampHeader Class Reference

#include <mw/siptimestampheader.h>

Link against: sipcodec.lib

class CSIPTimestampHeader : public CSIPHeaderBase

Inherits from

Public Member Functions
CSIPTimestampHeader(TReal)
~CSIPTimestampHeader()
RPointerArray< CSIPHeaderBase >BaseDecodeL(const TDesC8 &)
virtual IMPORT_C CSIPHeaderBase *CloneL()
IMPORT_C CSIPTimestampHeader *DecodeL(const TDesC8 &)
IMPORT_C TRealDelay()
IMPORT_C TBoolHasDelay()
IMPORT_C CSIPHeaderBase *InternalizeValueL(RReadStream &)
virtual IMPORT_C RStringFName()
virtual TPreferredPlace PreferredPlaceInMessage()
IMPORT_C voidSetDelay(TReal)
IMPORT_C voidSetTimestamp(TReal)
IMPORT_C TRealTimestamp()
virtual IMPORT_C HBufC8 *ToTextValueL()
Inherited Attributes
CSIPHeaderBase::iLink
Inherited Enumerations
CSIPHeaderBase:TPreferredPlace
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CSIPHeaderBase::CSIPHeaderBase()
CSIPHeaderBase::CompactName()const
CSIPHeaderBase::EncodeMultipleToOneLine()const
CSIPHeaderBase::ExternalizeL(RWriteStream &,TBool)const
CSIPHeaderBase::ExternalizeNameL(RWriteStream &)const
CSIPHeaderBase::ExternalizeSupported()const
CSIPHeaderBase::HasCompactName()const
CSIPHeaderBase::IsExtensionHeader()const
CSIPHeaderBase::MoreThanOneAllowed()const
CSIPHeaderBase::PushLC(RPointerArray< CSIPHeaderBase > *)
CSIPHeaderBase::ResetAndDestroy(TAny *)
CSIPHeaderBase::ToTextL()const
CSIPHeaderBase::ToTextLC()const
CSIPHeaderBase::ToTextValueLC()const
CSIPHeaderBase::~CSIPHeaderBase()

Detailed Description

Class for a SIP Timestamp header.

Constructor & Destructor Documentation

CSIPTimestampHeader ( TReal )

IMPORT_CCSIPTimestampHeader(TRealaTimestamp)

Constructor

ParameterDescription
aTimestampa timestamp value to set.

~CSIPTimestampHeader ( )

IMPORT_C~CSIPTimestampHeader()

Destructor

Member Function Documentation

BaseDecodeL ( const TDesC8 & )

RPointerArray< CSIPHeaderBase >BaseDecodeL(const TDesC8 &aValue)[static]

CloneL ( )

IMPORT_C CSIPHeaderBase *CloneL()const [virtual]

From CSIPHeaderBase CloneL

DecodeL ( const TDesC8 & )

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

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

ParameterDescription
aValuea value part of a "Timestamp"-header (e.g. "12 3.4")

Returns: a new instance of CSIPTimestampHeader

Delay ( )

IMPORT_C TRealDelay()const

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

Returns: a delay value or zero if HasDelay() == EFalse

HasDelay ( )

IMPORT_C TBoolHasDelay()const

Check if the delay-part is present

Returns: a delay value.

InternalizeValueL ( RReadStream & )

IMPORT_C CSIPHeaderBase *InternalizeValueL(RReadStream &aReadStream)[static]

Constructs an instance of a CSIPTimestampHeader from a RReadStream

ParameterDescription
aReadStreama stream containing the value of the externalized object (header name not included).

Returns: an instance of a CSIPTimestampHeader

Name ( )

IMPORT_C RStringFName()const [virtual]

Reimplemented from CSIPHeaderBase::Name()const

From CSIPHeaderBase Name

PreferredPlaceInMessage ( )

TPreferredPlace PreferredPlaceInMessage()const [virtual]

SetDelay ( TReal )

IMPORT_C voidSetDelay(TRealaDelay)

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

ParameterDescription
aDelaya delay to set.

SetTimestamp ( TReal )

IMPORT_C voidSetTimestamp(TRealaTimestamp)

Set the timestamp from the "Timestamp" header.

ParameterDescription
aTimestampa timestamp to set.

Timestamp ( )

IMPORT_C TRealTimestamp()const

Gets the timestamp from the "Timestamp" header.

Returns: a timestamp value.

ToTextValueL ( )

IMPORT_C HBufC8 *ToTextValueL()const [virtual]

From CSIPHeaderBase ToTextValueL