Symbian
Developer Library

DEVELOPER LIBRARY

[Index] [Glossary] [Previous] [Next]

 » Developer Library » API Reference » C++ API reference » HTTP Client » MHTTPFilter

Location: http\mhttpfilter.h
Link against: http.lib

Class MHTTPFilter

class MHTTPFilter

Support

Supported from 7.0

Description

Base class for a filter.

This extends MHTTPFilterBase to add further callback functions that are called when the filter is loaded and unloaded.

Derivation

MHTTPFilterBase class for a filter
MHTTPFilterBaseBase class for filters and event callback classes

Defined in MHTTPFilter:
ECache, EClient, EClientFilters, ECookies, EProtocolHandler, EStatusCodeHandler, ETidyUp, MHFLoad(), MHFUnload(), TPositions

Inherited from MHTTPFilterBase:
MHFRunError(), MHFRunL(), MHFSessionRunError(), MHFSessionRunL()

Member Enumerations

Enum TPositions

TPositions

Description

Defines default filter positions, by specifying the general filter behaviour.

EProtocolHandler

The Protocol Handler.

This is at the base of the filter chain and nearest to the transport layer.
ECache

Filters to handle caching behaviours.
EStatusCodeHandler

Filters to handle particular events, e.g. redirection and authentication.

ECookies

The cookie filter, and other filters that don't need to be concerned with resubmitting of transactions due to things like redirection.

ETidyUp

The validation filter and any other final tidy-up or initial preprocessing of transactions.
EClientFilters

Client filters that assume all standard behaviour is already there.
EClient

The client.

This is at the head of the filter chain. No position above this must be used.

[Top]

Member Functions

MHFUnload()

virtual void MHFUnload(RHTTPSession aSession, THTTPFilterHandle aHandle);

Description

Called when the filter is being removed from a session's filter queue.

Parameters

RHTTPSession aSession

The session that it is being removed from
THTTPFilterHandle aHandle

The filter handle. Complex filters may need to refer to this to keep track of which particular registration is being unloaded.

MHFLoad()

virtual void MHFLoad(RHTTPSession aSession, THTTPFilterHandle aHandle);

Description

Called when the filter is being added to the session's filter queue.

Parameters

RHTTPSession aSession

The session that it is being added to.
THTTPFilterHandle aHandle

The filter handle. Complex filters may need to keep track of this, for instance if generating events in response to external stimuli.

©2002 Symbian Ltd.

[Top]