TSdpTypedTime Class Reference

#include <mw/sdptypedtime.h>

Link against: sdpcodec.lib

class TSdpTypedTime
Public Attributes
TInt iUnit
TInt64 iValue
Public Member Enumerations
enumTUnit { ETimeUnitDays, ETimeUnitHours, ETimeUnitMinutes, ETimeUnitSeconds, ETimeUnitNone }
Public Member Functions
TSdpTypedTime()
TSdpTypedTime(TInt64, TUnit)
TSdpTypedTime DecodeL(const TDesC8 &)
voidEncodeL(RWriteStream &)
voidExternalizeL(RWriteStream &)
TSdpTypedTime InternalizeL(RReadStream &)
IMPORT_C voidSetValue(TInt64, TUnit)
IMPORT_C TBooloperator==(const TSdpTypedTime &)

Detailed Description

This class implements the typed time element of the Session Description Protocol.

The normative reference for correct formatting and values is draft-ietf-mmusic-sdp-new-14 unless specified otherwise in member documentation. The implementation supports this normative reference, but does not enforce it fully.

Member Attribute Documentation

iUnit

TInt iUnit

iValue

TInt64 iValue

Member Enumeration Documentation

Enum TUnit

Time units.

EnumeratorValueDescription
ETimeUnitDays
ETimeUnitHours

d

ETimeUnitMinutes

h

ETimeUnitSeconds

m

ETimeUnitNone

s

Constructor & Destructor Documentation

TSdpTypedTime ( )

IMPORT_CTSdpTypedTime()

Constructs a typed time equal to zero and with no time unit set.

TSdpTypedTime ( TInt64, TUnit )

IMPORT_CTSdpTypedTime(TInt64aValue,
TUnitaUnit
)

Constructs a typed time equal to specified value and time unit.

ParameterDescription
aValueTime value.
aUnitTime unit.

Member Function Documentation

DecodeL ( const TDesC8 & )

TSdpTypedTime DecodeL(const TDesC8 &aText)[static]

Construct a new origin field.

ParameterDescription
aTextA string containing a correctly formatted field value terminated by a CRLF.

Returns: The new instance.

EncodeL ( RWriteStream & )

voidEncodeL(RWriteStream &aStream)const

Output the field formatted according to SDP syntax and including the terminating CRLF.

ParameterDescription
aStreamStream used for output.

ExternalizeL ( RWriteStream & )

voidExternalizeL(RWriteStream &aStream)const

Externalizes the object to stream

ParameterDescription
aStreamStream where the object's state will be stored

InternalizeL ( RReadStream & )

TSdpTypedTime InternalizeL(RReadStream &aStream)[static]

Creates object from the stream data

ParameterDescription
aStreamStream where the object's state will be read

Returns: Initialized object

SetValue ( TInt64, TUnit )

IMPORT_C voidSetValue(TInt64aValue,
TUnitaUnit
)

Sets the typed time value.

ParameterDescription
aValueTime value.
aUnitTime unit.

operator== ( const TSdpTypedTime & )

IMPORT_C TBooloperator==(const TSdpTypedTime &aObj)const

Compares this instance to another for equality.

ParameterDescription
aObjAnother instance to compare with.

Returns: ETrue if equal, EFalse if not.

© Nokia 2011.