CEComFilter Class Reference

#include <mw/http/cecomfilter.h>

class CEComFilter : public CBase

Inherits from

Public Member Functions
~CEComFilter()
CEComFilter *InstallFilterL(RHTTPSession, const TUid)
CEComFilter *InstallFilterL(RHTTPSession, const TDesC8 &)
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()

Detailed Description

This class serves as the base class for ECom filter plugins. It provides minimal functionality to simply install and destroy filters specified by their UID or data type. The RHTTPSession passed in is passed onto the filter as a TAny* pointer and therefore must be casted back to an RHTTPSession pointer by the filter.

Constructor & Destructor Documentation

~CEComFilter ( )

~CEComFilter()[inline]
Intended Usage: Virtual destructor
Pre-condition
The object identified by the destructor key in iEcomDtorID exists
Post-condition
The object is destroyed

Member Function Documentation

InstallFilterL ( RHTTPSession, const TUid )

CEComFilter *InstallFilterL(RHTTPSessionaSession,
const TUidaEComFilterUid
)[static, inline]
Intended Usage: This method is used to install filters to the filter queue. The implementation UID of the filter plugin is passed to identify the plugin that is required. The returned pointer is not owned as the filters must be self-destroying when they are unloaded.
Pre-condition
The session had already been setup
Post-condition
The filter(s) have been installed
Parameters
aSessionA handle to the transport session
aEComFilterUidThe implementation UID of the plugin
Return Value
Pointer to the newly installed plugin

InstallFilterL ( RHTTPSession, const TDesC8 & )

CEComFilter *InstallFilterL(RHTTPSessionaSession,
const TDesC8 &aEComFilterDataType
)[static, inline]
Intended Usage: This method is used to install filters to the filter queue. The implementation UID of the filter plugin is passed to identify the plugin that is required. The returned pointer is not owned as the filters must be self-destroying when they are unloaded.
Pre-condition
The session had already been setup
Post-condition
The filter(s) have been installed
Parameters
aSessionA handle to the transport session
aEComFilterDataTypeA descriptor containing the datatype of the filter to load
Return Value
Pointer to the newly installed plugin
© Nokia 2005.