Symbian
 Developer Library

DEVELOPER LIBRARY

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



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

Class MHTTPFilterBase

class MHTTPFilterBase

Support

Supported from 7.0

Description

Base class for filters and event callback classes.

This is the base class for the filter base class, MHTTPFilter, the transaction event callback base class, MHTTPTransactionCallback, and the session event callback base class, MHTTPSessionEventCallback.

Defined in MHTTPFilterBase:
MHFRunError(), MHFRunL(), MHFSessionRunError(), MHFSessionRunL()

See also:


Member Functions


MHFRunL()

virtual void MHFRunL(RHTTPTransaction aTransaction, const THTTPEvent& aEvent);

Description

Called when the filter's registration conditions are satisfied for events that occur on a transaction.

Note that this function is not allowed to leave if called with certain events.

Parameters

RHTTPTransaction aTransaction

The transaction that the event has occurred on

const THTTPEvent& aEvent

The event that has occurred

Leave codes

Error in processing the event. Performing a leave results in MHFRunError() being called, which must handle the leave.


MHFSessionRunL()

virtual void MHFSessionRunL(const THTTPSessionEvent& aEvent);

Description

Called when the filter's registration conditions are satisfied for events that occur on the session.

Parameters

const THTTPSessionEvent& aEvent

The session event that has occured

Leave codes

Error in processing the event. Performing a leave results in MHFSessionRunError() being called, which must handle the leave.


MHFRunError()

virtual TInt MHFRunError(TInt aError, RHTTPTransaction aTransaction, const THTTPEvent& aEvent);

Description

Called when a leave occurs in handling a transaction event.

If you don't handle the error, a panic will occur.

The function is similiar in principal to CActive::RunError().

Parameters

TInt aError

The leave code

RHTTPTransaction aTransaction

The transaction that was being processed

const THTTPEvent& aEvent

The event that was being processed

Return value

TInt

KErrNone if the error has been handled, or the code of the continuing error otherwise


MHFSessionRunError()

virtual TInt MHFSessionRunError(TInt aError, const THTTPSessionEvent& aEvent);

Description

Called when a leave occurs in handling a session event.

If you don't handle the error, a panic will occur.

The function is similiar in principal to CActive::RunError().

Parameters

TInt aError

The leave code

const THTTPSessionEvent& aEvent

The event that was being processed.

Return value

TInt

KErrNone if the error has been handled, or the code of the continuing error otherwise