williamr@2: // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: // All rights reserved.
williamr@2: // This component and the accompanying materials are made available
williamr@2: // 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
williamr@2: // which accompanies this distribution, and is available
williamr@2: // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: //
williamr@2: // Initial Contributors:
williamr@2: // Nokia Corporation - initial contribution.
williamr@2: //
williamr@2: // Contributors:
williamr@2: //
williamr@2: // Description:
williamr@2: //
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: /**
williamr@2:  @file MHTTPFilterBase.h
williamr@2:  @warning : This file contains Rose Model ID comments - please do not delete
williamr@2: */
williamr@2: 
williamr@2: #ifndef	__MHTTPFILTERBASE_H__
williamr@2: #define	__MHTTPFILTERBASE_H__ 
williamr@2: 
williamr@2: // System includes
williamr@2: #include <e32std.h>
williamr@2: 
williamr@2: // Forward declarations
williamr@2: class RHTTPTransaction;
williamr@2: class THTTPEvent;
williamr@2: class THTTPSessionEvent;
williamr@2: 
williamr@2: 
williamr@2: //##ModelId=3A914DF9034F
williamr@2: class MHTTPFilterBase
williamr@2: /** 
williamr@2: A HTTP Filter. This is the base class for normal filters
williamr@2: (MHTTPFilter) which adds an unload function, and
williamr@2: MHTTPTransactionCallback, which doesn't add an unload function.  
williamr@2: @publishedAll
williamr@2: @released
williamr@2: */
williamr@2: 	{
williamr@2: public:
williamr@2: 	/** Called when the filter's registration conditions are satisfied for events that
williamr@2: 		occur on a transaction. Any Leaves must be handled by the appropriate MHFRunError.
williamr@2: 		Note that this function is not allowed to leave if called with
williamr@2: 		certain events. @see THTTPEvent
williamr@2: 		@param aTransaction The transaction that the event has occurred on.
williamr@2: 		@param aEvent The event that has occurred.
williamr@2: 	*/
williamr@2: 	//##ModelId=3A914DF9035D
williamr@2: 	IMPORT_C virtual void MHFRunL(RHTTPTransaction aTransaction, const THTTPEvent& aEvent);
williamr@2: 
williamr@2: 	/** Called when the filters registration conditions are satisfied for events that occur
williamr@2: 		on the session. Any leaves must be handled by the appropriate MHFRunError.
williamr@2: 		@param aEvent The session event that has occured.
williamr@2: 	*/
williamr@2: 	//##ModelId=3C4C37D401C1
williamr@2: 	IMPORT_C virtual void MHFSessionRunL(const THTTPSessionEvent& aEvent);
williamr@2: 
williamr@2: 	/** Called when RunL leaves from a transaction event. This works in the same
williamr@2: 		way as CActve::RunError; return KErrNone if you have handled the error.
williamr@2: 		If you don't completely handle the error, a panic will occur.
williamr@2: 		@param aError The leave code that RunL left with.
williamr@2: 		@param aTransaction The transaction that was being processed.
williamr@2: 		@param aEvent The Event that was being processed.
williamr@2: 		@return KErrNone if the error has been cancelled or the code
williamr@2: 		of the continuing error otherwise.
williamr@2: 	*/
williamr@2: 	//##ModelId=3A914DF90359
williamr@2: 	IMPORT_C virtual TInt MHFRunError(TInt aError, RHTTPTransaction aTransaction, const THTTPEvent& aEvent);
williamr@2: 
williamr@2: 	/** Called when MHFRunL leaves from a session event. This works in the same
williamr@2: 		way as CActve::RunError
williamr@2: 		If you don't completely handle the error, a panic will occur.
williamr@2: 		@param aError The leave code that RunL left with.
williamr@2: 		@param aEvent The Event that was being processed.
williamr@2: 		@return KErrNone if the error has been cancelled or the code
williamr@2: 		of the continuing error otherwise.	
williamr@2: 	*/
williamr@2: 	//##ModelId=3C4C37D302C4
williamr@2: 	IMPORT_C virtual TInt MHFSessionRunError(TInt aError, const THTTPSessionEvent& aEvent);
williamr@2:  	};
williamr@2: 
williamr@2: 
williamr@2: #endif //	 __MHTTPFILTERBASE_H__