1 // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
2 // All rights reserved.
3 // This component and the accompanying materials are made available
4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
19 @file MHTTPFilterBase.h
20 @warning : This file contains Rose Model ID comments - please do not delete
23 #ifndef __MHTTPFILTERBASE_H__
24 #define __MHTTPFILTERBASE_H__
29 // Forward declarations
30 class RHTTPTransaction;
32 class THTTPSessionEvent;
35 //##ModelId=3A914DF9034F
38 A HTTP Filter. This is the base class for normal filters
39 (MHTTPFilter) which adds an unload function, and
40 MHTTPTransactionCallback, which doesn't add an unload function.
46 /** Called when the filter's registration conditions are satisfied for events that
47 occur on a transaction. Any Leaves must be handled by the appropriate MHFRunError.
48 Note that this function is not allowed to leave if called with
49 certain events. @see THTTPEvent
50 @param aTransaction The transaction that the event has occurred on.
51 @param aEvent The event that has occurred.
53 //##ModelId=3A914DF9035D
54 IMPORT_C virtual void MHFRunL(RHTTPTransaction aTransaction, const THTTPEvent& aEvent);
56 /** Called when the filters registration conditions are satisfied for events that occur
57 on the session. Any leaves must be handled by the appropriate MHFRunError.
58 @param aEvent The session event that has occured.
60 //##ModelId=3C4C37D401C1
61 IMPORT_C virtual void MHFSessionRunL(const THTTPSessionEvent& aEvent);
63 /** Called when RunL leaves from a transaction event. This works in the same
64 way as CActve::RunError; return KErrNone if you have handled the error.
65 If you don't completely handle the error, a panic will occur.
66 @param aError The leave code that RunL left with.
67 @param aTransaction The transaction that was being processed.
68 @param aEvent The Event that was being processed.
69 @return KErrNone if the error has been cancelled or the code
70 of the continuing error otherwise.
72 //##ModelId=3A914DF90359
73 IMPORT_C virtual TInt MHFRunError(TInt aError, RHTTPTransaction aTransaction, const THTTPEvent& aEvent);
75 /** Called when MHFRunL leaves from a session event. This works in the same
76 way as CActve::RunError
77 If you don't completely handle the error, a panic will occur.
78 @param aError The leave code that RunL left with.
79 @param aEvent The Event that was being processed.
80 @return KErrNone if the error has been cancelled or the code
81 of the continuing error otherwise.
83 //##ModelId=3C4C37D302C4
84 IMPORT_C virtual TInt MHFSessionRunError(TInt aError, const THTTPSessionEvent& aEvent);
88 #endif // __MHTTPFILTERBASE_H__