S60 3rd Edition API Reference: CSdpKeyField Class Reference

CSdpKeyField Class Reference

API published in: S60 2nd Ed

Link against: sdpcodec.lib

Capability Information

Required Capabilities

None

Exceptions

#include <sdpkeyfield.h>

Detailed Description

PublishedAll
Released
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.


Public Member Functions

IMPORT_C ~CSdpKeyField ()
 Deletes the resources held by the instance.
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.
IMPORT_C CSdpKeyField * CloneL () const
 Creates a new instance that is equal to the target.
IMPORT_C TBool operator== (const CSdpKeyField &aObj) const
 Compares this instance to another for equality.
IMPORT_C RStringF Method () const
 Gets the encryption method.
IMPORT_C const TDesC8 & EncryptionKey () const
 Gets the encryption key.
IMPORT_C void SetL (RStringF aMethod, const TDesC8 &aEncryptionKey)
 Sets the encryption method and key.
void ExternalizeL (RWriteStream &aStream) const
 Externalizes the object to stream.

Static Public Member Functions

static IMPORT_C CSdpKeyField * DecodeL (const TDesC8 &aFieldValue)
 Constructs a new encryption key field.
static IMPORT_C CSdpKeyField * DecodeLC (const TDesC8 &aFieldValue)
 Constructs a new encryption key field and adds the pointer to the cleanup stack.
static IMPORT_C CSdpKeyField * NewL (RStringF aMethod, const TDesC8 &aEncryptionKey)
 Constructs a new encryption key field.
static IMPORT_C CSdpKeyField * NewLC (RStringF aMethod, const TDesC8 &aEncryptionKey)
 Constructs a new encryption key field and adds the pointer to the cleanup stack.
static CSdpKeyField * InternalizeL (RReadStream &aStream)
 Creates object from the stream data.

Constructor & Destructor Documentation

IMPORT_C CSdpKeyField::~CSdpKeyField (   ) 
 

Deletes the resources held by the instance.

Member Function Documentation

IMPORT_C CSdpKeyField* CSdpKeyField::CloneL (   )  const
 

Creates a new instance that is equal to the target.

Returns:
a new instance.
static IMPORT_C CSdpKeyField* CSdpKeyField::DecodeL ( const TDesC8 &  aFieldValue  )  [static]
 

Constructs a new encryption key field.

Parameters:
aFieldValue A string containing a correctly formatted field value terminated by a CRLF.
Returns:
a new instance.
static IMPORT_C CSdpKeyField* CSdpKeyField::DecodeLC ( const TDesC8 &  aFieldValue  )  [static]
 

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

Parameters:
aFieldValue A string containing a correctly formatted field value terminated by a CRLF.
Returns:
a new instance.
Leave:
In error case function leaves.
IMPORT_C void CSdpKeyField::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:
aStream Stream used for output. On return the stream includes correctly formatted key field.
IMPORT_C const TDesC8& CSdpKeyField::EncryptionKey (   )  const
 

Gets the encryption key.

Returns:
The key or an empty descriptor if there is no key part.
void CSdpKeyField::ExternalizeL ( RWriteStream &  aStream  )  const
 

Externalizes the object to stream.

Parameters:
aStream Stream where the object's state will be stored
static CSdpKeyField* CSdpKeyField::InternalizeL ( RReadStream &  aStream  )  [static]
 

Creates object from the stream data.

Parameters:
aStream Stream where the object's state will be read
Returns:
Initialized object
IMPORT_C RStringF CSdpKeyField::Method (   )  const
 

Gets the encryption method.

Returns:
The method.
static IMPORT_C CSdpKeyField* CSdpKeyField::NewL ( RStringF  aMethod,
const TDesC8 &  aEncryptionKey
)  [static]
 

Constructs a new encryption key field.

Parameters:
aMethod Encryption method from the pre-defined SDP string table. User defined values are not accepted.
aEncryptionKey A valid encryption key value or an empty descriptor to omit the key part.
Returns:
a new instance.
static IMPORT_C CSdpKeyField* CSdpKeyField::NewLC ( RStringF  aMethod,
const TDesC8 &  aEncryptionKey
)  [static]
 

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

Parameters:
aMethod Encryption method from the pre-defined SDP string table. User defined values are not accepted.
aEncryptionKey A valid encryption key value or an empty descriptor to omit the key part.
Returns:
a new instance.
IMPORT_C TBool CSdpKeyField::operator== ( const CSdpKeyField &  aObj  )  const
 

Compares this instance to another for equality.

Parameters:
aObj The instance to compare to.
Returns:
ETrue if equal, EFalse if not.
IMPORT_C void CSdpKeyField::SetL ( RStringF  aMethod,
const TDesC8 &  aEncryptionKey
) 
 

Sets the encryption method and key.

Parameters:
aMethod Encryption method from the pre-defined SDP string table. User defined values are not accepted.
aEncryptionKey A valid encryption key value or an empty descriptor to omit the key part.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top