#include <mw/http/mhttpfilterbase.h>
| class MHTTPFilterBase |
| Public Member Functions | |
|---|---|
| virtual IMPORT_C TInt | MHFRunError(TInt, RHTTPTransaction, const THTTPEvent &) |
| virtual IMPORT_C void | MHFRunL(RHTTPTransaction, const THTTPEvent &) |
| virtual IMPORT_C TInt | MHFSessionRunError(TInt, const THTTPSessionEvent &) |
| virtual IMPORT_C void | MHFSessionRunL(const THTTPSessionEvent &) |
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.
| IMPORT_C TInt | MHFRunError | ( | TInt | aError, |
| RHTTPTransaction | aTransaction, | |||
| 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.
| Parameter | Description |
|---|---|
| aError | The leave code that RunL left with. |
| aTransaction | The transaction that was being processed. |
| aEvent | The Event that was being processed. |
Returns: KErrNone if the error has been cancelled or the code of the continuing error otherwise.
| IMPORT_C void | MHFRunL | ( | RHTTPTransaction | aTransaction, |
| 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
| Parameter | Description |
|---|---|
| aTransaction | The transaction that the event has occurred on. |
| aEvent | The event that has occurred. |
| IMPORT_C TInt | MHFSessionRunError | ( | TInt | aError, |
| 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.
| Parameter | Description |
|---|---|
| aError | The leave code that RunL left with. |
| aEvent | The Event that was being processed. |
Returns: KErrNone if the error has been cancelled or the code of the continuing error otherwise.
| IMPORT_C void | MHFSessionRunL | ( | 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.
| Parameter | Description |
|---|---|
| aEvent | The session event that has occured. |