MHTTPFilter Class Reference

class MHTTPFilter : public MHTTPFilterBase

A HTTP filter

Inherits from

MHTTPFilter
- MHTTPFilterBase

Public Member Functions
IMPORT_C void	MHFLoad(RHTTPSession, THTTPFilterHandle)
IMPORT_C void	MHFUnload(RHTTPSession, THTTPFilterHandle)

Inherited Functions
	MHTTPFilterBase::MHFRunError(TInt,RHTTPTransaction,const THTTPEvent &)
	MHTTPFilterBase::MHFRunL(RHTTPTransaction,const THTTPEvent &)
	MHTTPFilterBase::MHFSessionRunError(TInt,const THTTPSessionEvent &)
	MHTTPFilterBase::MHFSessionRunL(const THTTPSessionEvent &)

Public Member Enumerations
enum	TPositions { EProtocolHandler = 0, ECache = 100, EStatusCodeHandler = 200, EUAProf = 250, ECookies = 300, ETidyUp = 400, EClientFilters = 500, EClient = 1000 }

Member Functions Documentation

MHFLoad(RHTTPSession, THTTPFilterHandle)

IMPORT_C void	MHFLoad	(	RHTTPSession	aSession,
			THTTPFilterHandle	aHandle
		)	[virtual]

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

Parameters

RHTTPSession aSession	The session it's 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

MHFUnload(RHTTPSession, THTTPFilterHandle)

IMPORT_C void	MHFUnload	(	RHTTPSession	aSession,
			THTTPFilterHandle	aHandle
		)	[virtual]

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

Parameters

RHTTPSession aSession	The session it's 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.

Member Enumerations Documentation

Enum TPositions

Default filter positions

Enumerators

EProtocolHandler = 0	The Protocol Handler :- At the base of the filter chain and nearest to the transport layer
ECache = 100	Filters to handle caching behaviours.
EStatusCodeHandler = 200	Filters to handle particular status codes. e.g.Redirection and authentication.
EUAProf = 250	The UAProf filter.
ECookies = 300	The cookie filter, and other filters that don't need to be concerned with resubmitting of transactions due to things like redirection.
ETidyUp = 400	The validation filter and any other final tidy up or initial preprocessing of transactions
EClientFilters = 500	Client filters that assume all standard behaviour is already there.
EClient = 1000	The client :- At the head of the filter chain : No position above this must be used.