Class CSIPTimestampHeader

class CSIPTimestampHeader : public CSIPHeaderBase;

Description

Class for a SIP Timestamp header.

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

• CSIPTimestampHeader - Class for a SIP Timestamp header

Members

Defined in CSIPTimestampHeader:
CSIPTimestampHeader(), CloneL(), DecodeL(), Delay(), HasDelay(), InternalizeValueL(), Name(), SetDelay(), SetTimestamp(), Timestamp(), ToTextValueL(), ~CSIPTimestampHeader()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CSIPHeaderBase:
ExternalizeL(), ExternalizeSupported(), PushLC(), ToTextL(), ToTextLC(), ToTextValueLC()

IMPORT_C CSIPTimestampHeader(TReal aTimestamp);

Description

Constructor

Parameters

TReal aTimestamp a timestamp value to set.

IMPORT_C ~CSIPTimestampHeader();

Description

Destructor

static IMPORT_C CSIPTimestampHeader *DecodeL(const TDesC8 &aValue);

Description

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

Parameters

const TDesC8 &aValue a value part of a "Timestamp"-header (e.g. "12 3.4")

Return value

CSIPTimestampHeader * a new instance of CSIPTimestampHeader

IMPORT_C void SetTimestamp(TReal aTimestamp);

Description

Set the timestamp from the "Timestamp" header.

Parameters

TReal aTimestamp a timestamp to set.

IMPORT_C TReal Timestamp() const;

Description

Gets the timestamp from the "Timestamp" header.

Return value

TReal a timestamp value.

IMPORT_C TBool HasDelay() const;

Description

Check if the delay-part is present

Return value

TBool a delay value.

IMPORT_C void SetDelay(TReal aDelay);

Description

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

Parameters

TReal aDelay a delay to set.

IMPORT_C TReal Delay() const;

Description

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

Return value

TReal a delay value or zero if HasDelay() == EFalse

static IMPORT_C CSIPHeaderBase *InternalizeValueL(RReadStream &aReadStream);

Description

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

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

virtual IMPORT_C HBufC8 *ToTextValueL() const;

Description

From CSIPHeaderBase ToTextValueL

Return value

HBufC8 *