Class CSdpKeyField

class CSdpKeyField : public CBase;

Description

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

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CSdpKeyField - This class encapsulates the encryption key field of the Session Description Protocol

Members

Defined in CSdpKeyField:
CloneL(), DecodeL(), DecodeLC(), EncodeL(), EncryptionKey(), Method(), NewL(), NewLC(), SetL(), operator==(), ~CSdpKeyField()

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

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

Description

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.

Return value

CSdpKeyField * a new instance.

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

Description

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.

Return value

CSdpKeyField * a new instance.

IMPORT_C ~CSdpKeyField();

Description

Deletes the resources held by the instance.

static IMPORT_C CSdpKeyField *DecodeL(const TDesC8 &aFieldValue);

Description

Constructs a new encryption key field.

Parameters

const TDesC8 &aFieldValue A string containing a correctly formatted field value terminated by a CRLF.

Return value

CSdpKeyField * a new instance.

static IMPORT_C CSdpKeyField *DecodeLC(const TDesC8 &aFieldValue);

Description

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

Parameters

const TDesC8 &aFieldValue A string containing a correctly formatted field value terminated by a CRLF.

Return value

CSdpKeyField * a new instance.

Leave codes

In error case function leaves.

IMPORT_C void EncodeL(RWriteStream &aStream) const;

Description

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.

IMPORT_C CSdpKeyField *CloneL() const;

Description

Creates a new instance that is equal to the target.

Return value

CSdpKeyField * a new instance.

IMPORT_C TBool operator==(const CSdpKeyField &aObj) const;

Description

Compares this instance to another for equality.

Parameters

const CSdpKeyField &aObj The instance to compare to.

Return value

TBool ETrue if equal, EFalse if not.

IMPORT_C RStringF Method() const;

Description

Gets the encryption method.

Return value

RStringF The method.

IMPORT_C const TDesC8 &EncryptionKey() const;

Description

Gets the encryption key.

Return value

const TDesC8 & The key or an empty descriptor if there is no key part.

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

Description

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.