S60 3rd Edition API Reference: CSdpBandwidthField Class Reference

CSdpBandwidthField Class Reference

API published in: S60 2nd Ed

Link against: sdpcodec.lib

Capability Information

Required Capabilities

None

Exceptions

#include <sdpbandwidthfield.h>

Detailed Description

PublishedAll
Released
This class encapsulates the bandwidth 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 ~CSdpBandwidthField ()
 Deletes the resources held by the instance.
IMPORT_C void EncodeL (RWriteStream &aStream) const
 Outputs the field formatted according to SDP syntax and including the terminating CRLF.
IMPORT_C CSdpBandwidthField * CloneL () const
 Creates a new instance that is equal to the target.
IMPORT_C TBool operator== (const CSdpBandwidthField &aObj) const
 Compares this instance to another for equality.
IMPORT_C RStringF Modifier () const
 Gets the bandwidth modifier.
IMPORT_C void SetModifier (RStringF aModifier)
 Sets the bandwidth modifier.
IMPORT_C TUint32 Value () const
 Gets the bandwidth value.
IMPORT_C void SetValue (TUint32 aValue)
 Sets the bandwidth value.
void ExternalizeL (RWriteStream &aStream) const
 Externalize the instance in a memory optimized format.

Static Public Member Functions

static IMPORT_C CSdpBandwidthField * DecodeL (const TDesC8 &aText)
 Constructs a new bandwidth field.
static IMPORT_C CSdpBandwidthField * DecodeLC (const TDesC8 &aText)
 Constructs a new bandwidth field and adds the pointer to the cleanup stack.
static IMPORT_C CSdpBandwidthField * NewL (RStringF aModifier, TUint32 aValue)
 Constructs a new bandwidth field.
static IMPORT_C CSdpBandwidthField * NewLC (RStringF aModifier, TUint32 aValue)
 Constructs a new bandwidth field and adds the pointer to the cleanup stack.
static CSdpBandwidthField * InternalizeL (RReadStream &aStream)
 Create a new instance from value created with ExternalizeL().

Constructor & Destructor Documentation

IMPORT_C CSdpBandwidthField::~CSdpBandwidthField (   ) 
 

Deletes the resources held by the instance.

Member Function Documentation

IMPORT_C CSdpBandwidthField* CSdpBandwidthField::CloneL (   )  const
 

Creates a new instance that is equal to the target.

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

Constructs a new bandwidth field.

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

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

Parameters:
aText A string containing a correctly formatted field value terminated by a CRLF.
Returns:
a new instance.
IMPORT_C void CSdpBandwidthField::EncodeL ( RWriteStream &  aStream  )  const
 

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

Parameters:
aStream Stream used for output. On return the stream includes correctly formatted bandwidth field.
void CSdpBandwidthField::ExternalizeL ( RWriteStream &  aStream  )  const
 

Externalize the instance in a memory optimized format.

Parameters:
aStream The stream used for externalization.
static CSdpBandwidthField* CSdpBandwidthField::InternalizeL ( RReadStream &  aStream  )  [static]
 

Create a new instance from value created with ExternalizeL().

Parameters:
aStream The stream used for internalization.
Returns:
The new instance.
IMPORT_C RStringF CSdpBandwidthField::Modifier (   )  const
 

Gets the bandwidth modifier.

Returns:
The modifier that can be pre-defined in the SDP string table or defined by the user.
static IMPORT_C CSdpBandwidthField* CSdpBandwidthField::NewL ( RStringF  aModifier,
TUint32  aValue
)  [static]
 

Constructs a new bandwidth field.

Parameters:
aModifier Bandwidth modifier.
aValue Bandwidth value.
Returns:
a new instance.
static IMPORT_C CSdpBandwidthField* CSdpBandwidthField::NewLC ( RStringF  aModifier,
TUint32  aValue
)  [static]
 

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

Parameters:
aModifier Bandwidth modifier.
aValue Bandwidth value.
Returns:
a new instance.
IMPORT_C TBool CSdpBandwidthField::operator== ( const CSdpBandwidthField &  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 CSdpBandwidthField::SetModifier ( RStringF  aModifier  ) 
 

Sets the bandwidth modifier.

Parameters:
aModifier A valid bandwidth modifier name.
IMPORT_C void CSdpBandwidthField::SetValue ( TUint32  aValue  ) 
 

Sets the bandwidth value.

Parameters:
aValue The Value.
IMPORT_C TUint32 CSdpBandwidthField::Value (   )  const
 

Gets the bandwidth value.

Returns:
The value.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top