CSIPAcceptEncodingHeader Class Reference
#include
<mw/sipacceptencodingheader.h>
Link against: sipcodec.lib
| class CSIPAcceptEncodingHeader : public CSIPParameterHeaderBase |
| 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() |
| | CSIPHeaderBase::CSIPHeaderBase() |
| | CSIPHeaderBase::CompactName()const |
| | CSIPHeaderBase::EncodeMultipleToOneLine()const |
| | CSIPHeaderBase::ExternalizeL(RWriteStream &,TBool)const |
| | CSIPHeaderBase::ExternalizeNameL(RWriteStream &)const |
| | CSIPHeaderBase::ExternalizeSupported()const |
| | CSIPHeaderBase::HasCompactName()const |
| | CSIPHeaderBase::IsExtensionHeader()const |
| | CSIPHeaderBase::PushLC(RPointerArray< CSIPHeaderBase > *) |
| | CSIPHeaderBase::ResetAndDestroy(TAny *) |
| | CSIPHeaderBase::ToTextL()const |
| | CSIPHeaderBase::ToTextLC()const |
| | CSIPHeaderBase::ToTextValueLC()const |
| | CSIPHeaderBase::~CSIPHeaderBase() |
| | CSIPParameterHeaderBase::CSIPParameterHeaderBase(const TChar &) |
| | CSIPParameterHeaderBase::DeleteParam(RStringF) |
| | CSIPParameterHeaderBase::HasParam(RStringF)const |
| | CSIPParameterHeaderBase::Param(TInt,RStringF &)const |
| | CSIPParameterHeaderBase::ParamCount()const |
| | CSIPParameterHeaderBase::ParamInsertionAllowed()const |
| | CSIPParameterHeaderBase::ParamValue(RStringF)const |
| | CSIPParameterHeaderBase::ParseL(const TDesC8 &,TBool,TBool) |
| | CSIPParameterHeaderBase::SetParamL(RStringF) |
| | CSIPParameterHeaderBase::SetParamL(RStringF,RStringF) |
| | CSIPParameterHeaderBase::ToTextValueL()const |
| | CSIPParameterHeaderBase::~CSIPParameterHeaderBase() |
Detailed Description
Class provides functions for setting and getting media types and parameters in SIP "Accept-Encoding" header.
Constructor & Destructor Documentation
~CSIPAcceptEncodingHeader ( )
| IMPORT_C | ~CSIPAcceptEncodingHeader | ( | ) | |
Member Function Documentation
BaseDecodeL ( const TDesC8 & )
Codings ( )
| IMPORT_C const TDesC8 & | Codings | ( | ) | const |
Gets the codings from the "Accept-Encoding" header
DecodeL ( const TDesC8 & )
Constructs a CSIPAcceptEncodingHeader from textual representation of the header's value part. Usage:
#include <featdiscovery.h>
#include <featureinfo.h> // for feature definitions
// replace <featureUIDx> with a real UID )
// If querying only one feature, it is more efficient to use the class
// via the static method, IsFeatureSupportedL().
// When querying more than one feature, it is more efficient to use the
// class by creating an instance and calling the IsSupported() method.
// Static way of using the class:
TBool isSupported = CFeatureDiscovery::IsFeatureSupportedL(<featureUIDx>);
// Dynamic way of using the class using NewL():
// Call NewL() to create an instance of CFeatureDiscovery.
CFeatureDiscovery* testA = CFeatureDiscovery::NewL();
// Call the exported IsSupported() method to query whether features
// are supported in the current environment or not.
TBool usbSupported = testA->IsSupported(<featureUIDx>);
TBool mmcSupported = testA->IsSupported(<featureUIDx>);
// Delete the created instance of CFeatureDiscovery.
delete testA;
// Dynamic way of using the class using NewLC():
// Call NewLC() to create an instance of CFeatureDiscovery.
// The method leaves the instance of the object on the cleanup stack.
CFeatureDiscovery* testB = CFeatureDiscovery::NewLC();
// Call the exported IsSupported() method to query whether features
// are supported in the current environment or not.
TBool wcdmaSupported = testB->IsSupported(<featureUIDx>);
TBool gsmSupported = testB->IsSupported(<featureUIDx>);
// Dynamic way of using multiple feature query. This is preferred
// way to fetch support statuses if there are several features to be
// queried, because it involves less inter-process communication.
TFeatureSet featset;
User::LeaveIfError( featset.Append( <featureUIDx> ) );
User::LeaveIfError( featset.Append( <featureUIDx> ) );
TInt err = testB->FeaturesSupported( featset );
if(!err)
{
TBool uid1Supported = featset.IsFeatureSupported(<featureUIDx>);
TBool uid2Supported = featset.IsFeatureSupported(<featureUIDx>);
// ... or whether all QUERIED features are supported
TBool allSupported = featset.AreAllFeaturesSupported();
}
// featset cleans array up in destructor on scope exit
// Pop and delete the created instance of CFeatureDiscovery.
CleanupStack::PopAndDestroy();
| Parameter | Description | | aValue | a value part of a "Accept-Encoding"-header |
Returns: An array containing one to many CSIPAcceptEncodingHeader instances
InternalizeValueL ( RReadStream & )
| Parameter | Description | | aReadStream | a stream containing the value of the externalized header object (header name not included). |
Returns: An instance of a CSIPAcceptEncodingHeader
MoreThanOneAllowed ( )
|
TBool
| MoreThanOneAllowed | ( | ) | const [virtual] |
NewL ( const TDesC8 & )
| Parameter | Description | | aCodings | a codings to set. |
Returns: a new instance of CSIPAcceptEncodingHeader
NewLC ( const TDesC8 & )
| Parameter | Description | | aCodings | a codings to set. |
Returns: a new instance of CSIPAcceptEncodingHeader
PreferredPlaceInMessage ( )
QParameter ( )
| IMPORT_C TReal | QParameter | ( | ) | const |
Gets the value of "q"-parameter
Returns: the "q"-parameter value
SetCodingsL ( const TDesC8 & )
| IMPORT_C void | SetCodingsL | ( | const TDesC8 & | aCodings | ) | |
Sets the codings in the "Accept-Encoding" header
| Parameter | Description | | aCodings | the codings |
SetQParameterL ( TReal )
| IMPORT_C void | SetQParameterL | ( | TReal | aQValue | ) | |
Sets the "q"-parameter value
| Parameter | Description | | aQValue | a "q"-parameter value to set |