MHTTPFilter Class Reference

#include <mw/http/mhttpfilter.h>

Link against: http.lib

class MHTTPFilter : public MHTTPFilterBase

Inherits from

Detailed Description

A HTTP filter

Member Enumeration Documentation

Enum TPositions

Default filter positions

EnumeratorValueDescription
EProtocolHandler0

The Protocol Handler :- At the base of the filter chain and nearest to the transport layer

ECache100

Filters to handle caching behaviours.

EStatusCodeHandler200

Filters to handle particular status codes. e.g.Redirection and authentication.

EUAProf250

The UAProf filter.

ECookies300

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

ETidyUp400

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

EClientFilters500

Client filters that assume all standard behaviour is already there.

EClient1000

The client :- At the head of the filter chain : No position above this must be used.

Member Function Documentation

MHFLoad ( RHTTPSession, THTTPFilterHandle )

IMPORT_C voidMHFLoad(RHTTPSessionaSession,
THTTPFilterHandleaHandle
)[virtual]

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

ParameterDescription
aSessionThe session it's being added to.
aHandleThe filter handle. Complex filters may need to keep track of this, for instance if generating events in response to external stimuli

MHFUnload ( RHTTPSession, THTTPFilterHandle )

IMPORT_C voidMHFUnload(RHTTPSessionaSession,
THTTPFilterHandleaHandle
)[virtual]

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

ParameterDescription
aSessionThe session it's being removed from
aHandleThe filter handle. Complex filters may need to refer to this to keep track of which particular registration is being unloaded.