Symbian
Symbian Developer Library

SYMBIAN OS V9.4

Feedback

[Index] [Previous] [Next]

#include <CEComFilter.h>

Class CEComFilter

class CEComFilter : public CBase;

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.

Derivation

Members

Defined in CEComFilter:

Inherited from CBase:


Construction and destruction


~CEComFilter()

inline ~CEComFilter();

Pre-Condition

The object identified by the destructor key in iEcomDtorID exists

Description

Intended Usage: Virtual destructor

Post-Condition

The object is destroyed

[Top]


Member functions


InstallFilterL(RHTTPSession,const TUid)

static inline CEComFilter* InstallFilterL(RHTTPSession aSession, const TUid aEComFilterUid);

Pre-Condition

The session had already been setup

Description

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.

Post-Condition

The filter(s) have been installed

Parameters

RHTTPSession aSession

A handle to the transport session

const TUid aEComFilterUid

The implementation UID of the plugin

Return value

CEComFilter *

Pointer to the newly installed plugin


InstallFilterL(RHTTPSession,const TDesC8 &)

static inline CEComFilter* InstallFilterL(RHTTPSession aSession, const TDesC8 &aEComFilterDataType);

Pre-Condition

The session had already been setup

Description

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.

Post-Condition

The filter(s) have been installed

Parameters

RHTTPSession aSession

A handle to the transport session

const TDesC8 &aEComFilterDataType

A descriptor containing the datatype of the filter to load

Return value

CEComFilter *

Pointer to the newly installed plugin