Collapse all Symbian^3 Application Developer Library

CSdpRepeatField Class Reference

class CSdpRepeatField : public CBase

This class encapsulates the repeat times field 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.

sdpcodec.lib

Inherits from

CSdpRepeatField
- CBase

Public Member Functions
	~CSdpRepeatField ()
IMPORT_C const TSdpTypedTime	ActiveDuration ()
IMPORT_C CSdpRepeatField *	CloneL ()
IMPORT_C CSdpRepeatField *	DecodeL (const TDesC8 &)
IMPORT_C CSdpRepeatField *	DecodeLC (const TDesC8 &)
IMPORT_C void	EncodeL ( RWriteStream &)
void	ExternalizeL ( RWriteStream &)
CSdpRepeatField *	InternalizeL ( RReadStream &)
IMPORT_C CSdpRepeatField *	NewL (const TSdpTypedTime , const TSdpTypedTime , const RArray < TSdpTypedTime > &)
IMPORT_C CSdpRepeatField *	NewLC (const TSdpTypedTime , const TSdpTypedTime , const RArray < TSdpTypedTime > &)
IMPORT_C const TSdpTypedTime	RepeatInterval ()
IMPORT_C void	SetActiveDuration (const TSdpTypedTime )
IMPORT_C void	SetRepeatIntervalL (const TSdpTypedTime )
IMPORT_C void	SetTimeOffsetsL (const RArray < TSdpTypedTime > &)
IMPORT_C const RArray < TSdpTypedTime > &	TimeOffsets ()
IMPORT_C TBool	operator== (const CSdpRepeatField &)

Private Member Functions
	CSdpRepeatField (const TSdpTypedTime , const TSdpTypedTime )
	CSdpRepeatField ()
void	ConstructL (const TDesC8 &)
void	ConstructL (const RArray < TSdpTypedTime > &)
void	__DbgTestInvariant ()

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()

Private Attributes
TSdpTypedTime	iActiveDuration
RStringPool	iPool
TSdpTypedTime	iRepeatInterval
RArray < TSdpTypedTime >	iTimeOffsets

Constructor & Destructor Documentation

CSdpRepeatField(const TSdpTypedTime, const TSdpTypedTime)

CSdpRepeatField	(	const TSdpTypedTime	aRepeatInterval,
		const TSdpTypedTime	aActiveDuration
	)	[private]

Parameters

const TSdpTypedTime aRepeatInterval
const TSdpTypedTime aActiveDuration

CSdpRepeatField()

CSdpRepeatField

(

)

[private]

~CSdpRepeatField()

IMPORT_C

~CSdpRepeatField

(

)

Deletes the resources held by the instance.

Member Functions Documentation

ActiveDuration()

IMPORT_C const TSdpTypedTime

ActiveDuration

(

)

const

Gets the active duration..

CloneL()

IMPORT_C CSdpRepeatField *

CloneL

(

)

const

Creates a new instance that is equal to the target.

ConstructL(const TDesC8 &)

void

ConstructL

(

const TDesC8 &

aText

)

[private]

Parameters

const TDesC8 & aText

ConstructL(const RArray< TSdpTypedTime > &)

void

ConstructL

(

const RArray < TSdpTypedTime > &

aOffsets

)

[private]

Parameters

const RArray < TSdpTypedTime > & aOffsets

DecodeL(const TDesC8 &)

IMPORT_C CSdpRepeatField *

DecodeL

(

const TDesC8 &

aText

)

[static]

Constructs a new repeat times field.

Parameters

const TDesC8 & aText

A string containing a correctly formatted field value terminated by a CRLF.

DecodeLC(const TDesC8 &)

IMPORT_C CSdpRepeatField *

DecodeLC

(

const TDesC8 &

aText

)

[static]

Constructs a new repeat times field and adds the pointer to the cleanup stack.

Parameters

const TDesC8 & aText

A string containing a correctly formatted field value terminated by a CRLF.

EncodeL(RWriteStream &)

IMPORT_C void

EncodeL

(

RWriteStream &

aStream

)

const

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

Parameters

RWriteStream & aStream

Stream used for output. On return the stream includes correctly formatted repeat field.

ExternalizeL(RWriteStream &)

void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalizes the object to stream

Parameters

RWriteStream & aStream

Stream where the object's state will be stored

InternalizeL(RReadStream &)

CSdpRepeatField *

InternalizeL

(

RReadStream &

aStream

)

[static]

Creates object from the stream data

Parameters

RReadStream & aStream

Stream where the object's state will be read

NewL(const TSdpTypedTime, const TSdpTypedTime, const RArray< TSdpTypedTime > &)

IMPORT_C CSdpRepeatField *	NewL	(	const TSdpTypedTime	aRepeatInterval,
			const TSdpTypedTime	aActiveDuration,
			const RArray < TSdpTypedTime > &	aOffsets
		)	[static]

Constructs a new repeat times field.

Parameters

const TSdpTypedTime aRepeatInterval	Repeat interval value greater than zero.
const TSdpTypedTime aActiveDuration	Active duration.
const RArray < TSdpTypedTime > & aOffsets	At least one time offset.

NewLC(const TSdpTypedTime, const TSdpTypedTime, const RArray< TSdpTypedTime > &)

IMPORT_C CSdpRepeatField *	NewLC	(	const TSdpTypedTime	aRepeatInterval,
			const TSdpTypedTime	aActiveDuration,
			const RArray < TSdpTypedTime > &	aOffsets
		)	[static]

Constructs a new repeat times field and adds the pointer to the cleanup stack.

Parameters

const TSdpTypedTime aRepeatInterval	Repeat interval value greater than zero.
const TSdpTypedTime aActiveDuration	Active duration.
const RArray < TSdpTypedTime > & aOffsets	At least one time offset.

RepeatInterval()

IMPORT_C const TSdpTypedTime

RepeatInterval

(

)

const

Gets the repeat interval.

SetActiveDuration(const TSdpTypedTime)

IMPORT_C void

SetActiveDuration

(

const TSdpTypedTime

aValue

)

Sets the active duration.

Parameters

const TSdpTypedTime aValue

SetRepeatIntervalL(const TSdpTypedTime)

IMPORT_C void

SetRepeatIntervalL

(

const TSdpTypedTime

aValue

)

Sets the repeat interval.

leave: KErrSdpCodecRepeatField if aValue is not positive integer value.

Parameters

const TSdpTypedTime aValue

Repeat interval value greater than zero.

SetTimeOffsetsL(const RArray< TSdpTypedTime > &)

IMPORT_C void

SetTimeOffsetsL

(

const RArray < TSdpTypedTime > &

aValue

)

Sets the time offsets.

Parameters

const RArray < TSdpTypedTime > & aValue

TimeOffsets()

IMPORT_C const RArray < TSdpTypedTime > &

TimeOffsets

(

)

const

Gets the array of time offsets. This array is used directly for element insertion and removal.

__DbgTestInvariant()

void

__DbgTestInvariant

(

)

const [private]

operator==(const CSdpRepeatField &)

IMPORT_C TBool

operator==

(

const CSdpRepeatField &

aObj

)

const

Compares this instance to another for equality.

Parameters

const CSdpRepeatField & aObj

The instance to compare to.

Member Data Documentation

TSdpTypedTime iActiveDuration

TSdpTypedTime

iActiveDuration

[private]

RStringPool iPool

RStringPool

iPool

[private]

TSdpTypedTime iRepeatInterval

TSdpTypedTime

iRepeatInterval

[private]

RArray< TSdpTypedTime > iTimeOffsets

RArray < TSdpTypedTime >

iTimeOffsets

[private]