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

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

voidConstructL(const TDesC8 &aText)[private]

Parameters

const TDesC8 & aText

ConstructL(RStringF, const TDesC8 &)

voidConstructL(RStringFaMethod,
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 & aFieldValueA 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 & aFieldValueA string containing a correctly formatted field value terminated by a CRLF.

DoInternalizeL(RReadStream &)

voidDoInternalizeL(RReadStream &aStream)[private]

Parameters

RReadStream & aStream

EncodeL(RWriteStream &)

IMPORT_C voidEncodeL(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 & aStreamStream 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 &)

voidExternalizeL(RWriteStream &aStream)const

Externalizes the object to stream

Parameters

RWriteStream & aStreamStream 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 & aStreamStream where the object's state will be read

Method()

IMPORT_C RStringFMethod()const

Gets the encryption method.

NewL(RStringF, const TDesC8 &)

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

Constructs a new encryption key field.

Parameters

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

NewLC(RStringF, const TDesC8 &)

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

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

Parameters

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

SetL(RStringF, const TDesC8 &)

IMPORT_C voidSetL(RStringFaMethod,
const TDesC8 &aEncryptionKey
)

Sets the encryption method and key.

Parameters

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

SetMethodAndKeyL(RStringF, const TDesC8 &, TBool)

voidSetMethodAndKeyL(RStringFaMethod,
const TDesC8 &aEncryptionKey,
TBoolaAllowEmptyKeyValue
)[private]

Parameters

RStringF aMethod
const TDesC8 & aEncryptionKey
TBool aAllowEmptyKeyValue

SetMethodBase64AndKeyL(RStringF, const TDesC8 &)

voidSetMethodBase64AndKeyL(RStringFaMethod,
const TDesC8 &aText
)[private]

Parameters

RStringF aMethod
const TDesC8 & aText

SetMethodClearAndKeyL(RStringF, const TDesC8 &)

voidSetMethodClearAndKeyL(RStringFaMethod,
const TDesC8 &aEncryptionKey
)[private]

Parameters

RStringF aMethod
const TDesC8 & aEncryptionKey

SetMethodPromptL(RStringF, const TDesC8 &)

voidSetMethodPromptL(RStringFaMethod,
const TDesC8 &aText
)[private]

Parameters

RStringF aMethod
const TDesC8 & aText

SetMethodUriAndKeyL(RStringF, const TDesC8 &)

voidSetMethodUriAndKeyL(RStringFaMethod,
const TDesC8 &aText
)[private]

Parameters

RStringF aMethod
const TDesC8 & aText

__DbgTestInvariant()

void__DbgTestInvariant()const [private]

operator==(const CSdpKeyField &)

IMPORT_C TBooloperator==(const CSdpKeyField &aObj)const

Compares this instance to another for equality.

Parameters

const CSdpKeyField & aObjThe 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]