MHTTPFilterBase Class Reference

#include <mw/http/mhttpfilterbase.h>

class MHTTPFilterBase
Public Member Functions
virtual IMPORT_C TIntMHFRunError(TInt, RHTTPTransaction, const THTTPEvent &)
virtual IMPORT_C voidMHFRunL(RHTTPTransaction, const THTTPEvent &)
virtual IMPORT_C TIntMHFSessionRunError(TInt, const THTTPSessionEvent &)
virtual IMPORT_C voidMHFSessionRunL(const THTTPSessionEvent &)

Detailed Description

A HTTP Filter. This is the base class for normal filters (MHTTPFilter) which adds an unload function, and MHTTPTransactionCallback, which doesn't add an unload function.

Member Function Documentation

MHFRunError ( TInt, RHTTPTransaction, const THTTPEvent & )

IMPORT_C TIntMHFRunError(TIntaError,
RHTTPTransactionaTransaction,
const THTTPEvent &aEvent
)[virtual]

Called when RunL leaves from a transaction event. This works in the same way as CActve::RunError; return KErrNone if you have handled the error. If you don't completely handle the error, a panic will occur.

Parameters
aErrorThe leave code that RunL left with.
aTransactionThe transaction that was being processed.
aEventThe Event that was being processed.
Return Value
KErrNone if the error has been cancelled or the code of the continuing error otherwise.

MHFRunL ( RHTTPTransaction, const THTTPEvent & )

IMPORT_C voidMHFRunL(RHTTPTransactionaTransaction,
const THTTPEvent &aEvent
)[virtual]

Called when the filter's registration conditions are satisfied for events that occur on a transaction. Any Leaves must be handled by the appropriate MHFRunError. Note that this function is not allowed to leave if called with certain events.

See also: THTTPEvent

Most Filters will be either a transaction filter or a session event filter. Default implementations of all MHTTPFilterBase functions are provided so filter implementors only have to override the functions they need

Parameters
aTransactionThe transaction that the event has occurred on.
aEventThe event that has occurred.

MHFSessionRunError ( TInt, const THTTPSessionEvent & )

IMPORT_C TIntMHFSessionRunError(TIntaError,
const THTTPSessionEvent &aEvent
)[virtual]

Called when MHFRunL leaves from a session event. This works in the same way as CActve::RunError If you don't completely handle the error, a panic will occur.

Parameters
aErrorThe leave code that RunL left with.
aEventThe Event that was being processed.
Return Value
KErrNone if the error has been cancelled or the code of the continuing error otherwise.

MHFSessionRunL ( const THTTPSessionEvent & )

IMPORT_C voidMHFSessionRunL(const THTTPSessionEvent &aEvent)[virtual]

Called when the filters registration conditions are satisfied for events that occur on the session. Any leaves must be handled by the appropriate MHFRunError.

Parameters
aEventThe session event that has occured.