Collapse all Symbian^3 Product Developer Library

CSdpKeyField Class Reference

class CSdpKeyField : public CBase

This class encapsulates the encryption key 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

CSdpKeyField
- CBase

Public Member Functions
	~CSdpKeyField()
IMPORT_C CSdpKeyField *	CloneL()
IMPORT_C CSdpKeyField *	DecodeL(const TDesC8 &)
IMPORT_C CSdpKeyField *	DecodeLC(const TDesC8 &)
IMPORT_C void	EncodeL(RWriteStream &)
IMPORT_C const TDesC8 &	EncryptionKey()
void	ExternalizeL(RWriteStream &)
CSdpKeyField *	InternalizeL(RReadStream &)
IMPORT_C RStringF	Method()
IMPORT_C CSdpKeyField *	NewL(RStringF, const TDesC8 &)
IMPORT_C CSdpKeyField *	NewLC(RStringF, const TDesC8 &)
IMPORT_C void	SetL(RStringF, const TDesC8 &)
IMPORT_C TBool	operator==(const CSdpKeyField &)

Private Member Functions
	CSdpKeyField()
void	ConstructL(const TDesC8 &)
void	ConstructL(RStringF, const TDesC8 &)
void	DoInternalizeL(RReadStream &)
RArray< TPtrC8 >	GetElementsFromLineL(TLex8 &)
void	SetMethodAndKeyL(RStringF, const TDesC8 &, TBool)
void	SetMethodBase64AndKeyL(RStringF, const TDesC8 &)
void	SetMethodClearAndKeyL(RStringF, const TDesC8 &)
void	SetMethodPromptL(RStringF, const TDesC8 &)
void	SetMethodUriAndKeyL(RStringF, const TDesC8 &)
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
HBufC8 *	iEncryptionKey
RStringF	iMethod
TBool	iMethodOpen
RStringPool	iStringPool

Constructor & Destructor Documentation

CSdpKeyField()

CSdpKeyField

(

)

[private]

~CSdpKeyField()

IMPORT_C

~CSdpKeyField

(

)

Deletes the resources held by the instance.

Member Functions Documentation

CloneL()

IMPORT_C CSdpKeyField *

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(RStringF, const TDesC8 &)

void	ConstructL	(	RStringF	aMethod,
			const TDesC8 &	aEncryptionKey
		)	[private]

Parameters

RStringF aMethod
const TDesC8 & aEncryptionKey

DecodeL(const TDesC8 &)

IMPORT_C CSdpKeyField *

DecodeL

(

const TDesC8 &

aFieldValue

)

[static]

Constructs a new encryption key field.

Parameters

const TDesC8 & aFieldValue

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

DecodeLC(const TDesC8 &)

IMPORT_C CSdpKeyField *

DecodeLC

(

const TDesC8 &

aFieldValue

)

[static]

Constructs a new encryption key field and adds the pointer to the cleanup stack.

leave: In error case function leaves.

Parameters

const TDesC8 & aFieldValue

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

DoInternalizeL(RReadStream &)

void

DoInternalizeL

(

RReadStream &

aStream

)

[private]

Parameters

RReadStream & aStream

EncodeL(RWriteStream &)

IMPORT_C void

EncodeL

(

RWriteStream &

aStream

)

const

Writes the instance as a complete SDP field encoded as UTF-8 and formatted as defined in draft-ietf-mmusic-sdp-new-14.

Parameters

RWriteStream & aStream

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

EncryptionKey()

IMPORT_C const TDesC8 &

EncryptionKey

(

)

const

Gets the encryption key.

ExternalizeL(RWriteStream &)

void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalizes the object to stream

Parameters

RWriteStream & aStream

Stream where the object's state will be stored

GetElementsFromLineL(TLex8 &)

RArray< TPtrC8 >

GetElementsFromLineL

(

TLex8 &

aLexer

)

[private]

Parameters

TLex8 & aLexer

InternalizeL(RReadStream &)

CSdpKeyField *

InternalizeL

(

RReadStream &

aStream

)

[static]

Creates object from the stream data

Parameters

RReadStream & aStream

Stream where the object's state will be read

Method()

IMPORT_C RStringF

Method

(

)

const

Gets the encryption method.

NewL(RStringF, const TDesC8 &)

IMPORT_C CSdpKeyField *	NewL	(	RStringF	aMethod,
			const TDesC8 &	aEncryptionKey
		)	[static]

Constructs a new encryption key field.

Parameters

RStringF aMethod	Encryption method from the pre-defined SDP string table. User defined values are not accepted.
const TDesC8 & aEncryptionKey	A valid encryption key value or an empty descriptor to omit the key part.

NewLC(RStringF, const TDesC8 &)

IMPORT_C CSdpKeyField *	NewLC	(	RStringF	aMethod,
			const TDesC8 &	aEncryptionKey
		)	[static]

Constructs a new encryption key field and adds the pointer to the cleanup stack.

Parameters

RStringF aMethod	Encryption method from the pre-defined SDP string table. User defined values are not accepted.
const TDesC8 & aEncryptionKey	A valid encryption key value or an empty descriptor to omit the key part.

SetL(RStringF, const TDesC8 &)

IMPORT_C void	SetL	(	RStringF	aMethod,
			const TDesC8 &	aEncryptionKey
		)

Sets the encryption method and key.

Parameters

RStringF aMethod	Encryption method from the pre-defined SDP string table. User defined values are not accepted.
const TDesC8 & aEncryptionKey	A valid encryption key value or an empty descriptor to omit the key part.

SetMethodAndKeyL(RStringF, const TDesC8 &, TBool)

void	SetMethodAndKeyL	(	RStringF	aMethod,
			const TDesC8 &	aEncryptionKey,
			TBool	aAllowEmptyKeyValue
		)	[private]

Parameters

RStringF aMethod
const TDesC8 & aEncryptionKey
TBool aAllowEmptyKeyValue

SetMethodBase64AndKeyL(RStringF, const TDesC8 &)

void	SetMethodBase64AndKeyL	(	RStringF	aMethod,
			const TDesC8 &	aText
		)	[private]

Parameters

RStringF aMethod
const TDesC8 & aText

SetMethodClearAndKeyL(RStringF, const TDesC8 &)

void	SetMethodClearAndKeyL	(	RStringF	aMethod,
			const TDesC8 &	aEncryptionKey
		)	[private]

Parameters

RStringF aMethod
const TDesC8 & aEncryptionKey

SetMethodPromptL(RStringF, const TDesC8 &)

void	SetMethodPromptL	(	RStringF	aMethod,
			const TDesC8 &	aText
		)	[private]

Parameters

RStringF aMethod
const TDesC8 & aText

SetMethodUriAndKeyL(RStringF, const TDesC8 &)

void	SetMethodUriAndKeyL	(	RStringF	aMethod,
			const TDesC8 &	aText
		)	[private]

Parameters

RStringF aMethod
const TDesC8 & aText

__DbgTestInvariant()

void

__DbgTestInvariant

(

)

const [private]

operator==(const CSdpKeyField &)

IMPORT_C TBool

operator==

(

const CSdpKeyField &

aObj

)

const

Compares this instance to another for equality.

Parameters

const CSdpKeyField & aObj

The instance to compare to.

Member Data Documentation

HBufC8 * iEncryptionKey

HBufC8 *

iEncryptionKey

[private]

RStringF iMethod

RStringF

iMethod

[private]

TBool iMethodOpen

TBool

iMethodOpen

[private]

RStringPool iStringPool

RStringPool

iStringPool

[private]