1.1 --- a/epoc32/include/http/mhttpfilterbase.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/http/mhttpfilterbase.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,88 @@
     1.4 -mhttpfilterbase.h
     1.5 +// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +// All rights reserved.
     1.7 +// This component and the accompanying materials are made available
     1.8 +// 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
     1.9 +// which accompanies this distribution, and is available
    1.10 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +//
    1.12 +// Initial Contributors:
    1.13 +// Nokia Corporation - initial contribution.
    1.14 +//
    1.15 +// Contributors:
    1.16 +//
    1.17 +// Description:
    1.18 +//
    1.19 +
    1.20 +
    1.21 +
    1.22 +/**
    1.23 + @file MHTTPFilterBase.h
    1.24 + @warning : This file contains Rose Model ID comments - please do not delete
    1.25 +*/
    1.26 +
    1.27 +#ifndef	__MHTTPFILTERBASE_H__
    1.28 +#define	__MHTTPFILTERBASE_H__ 
    1.29 +
    1.30 +// System includes
    1.31 +#include <e32std.h>
    1.32 +
    1.33 +// Forward declarations
    1.34 +class RHTTPTransaction;
    1.35 +class THTTPEvent;
    1.36 +class THTTPSessionEvent;
    1.37 +
    1.38 +
    1.39 +//##ModelId=3A914DF9034F
    1.40 +class MHTTPFilterBase
    1.41 +/** 
    1.42 +A HTTP Filter. This is the base class for normal filters
    1.43 +(MHTTPFilter) which adds an unload function, and
    1.44 +MHTTPTransactionCallback, which doesn't add an unload function.  
    1.45 +@publishedAll
    1.46 +@released
    1.47 +*/
    1.48 +	{
    1.49 +public:
    1.50 +	/** Called when the filter's registration conditions are satisfied for events that
    1.51 +		occur on a transaction. Any Leaves must be handled by the appropriate MHFRunError.
    1.52 +		Note that this function is not allowed to leave if called with
    1.53 +		certain events. @see THTTPEvent
    1.54 +		@param aTransaction The transaction that the event has occurred on.
    1.55 +		@param aEvent The event that has occurred.
    1.56 +	*/
    1.57 +	//##ModelId=3A914DF9035D
    1.58 +	IMPORT_C virtual void MHFRunL(RHTTPTransaction aTransaction, const THTTPEvent& aEvent);
    1.59 +
    1.60 +	/** Called when the filters registration conditions are satisfied for events that occur
    1.61 +		on the session. Any leaves must be handled by the appropriate MHFRunError.
    1.62 +		@param aEvent The session event that has occured.
    1.63 +	*/
    1.64 +	//##ModelId=3C4C37D401C1
    1.65 +	IMPORT_C virtual void MHFSessionRunL(const THTTPSessionEvent& aEvent);
    1.66 +
    1.67 +	/** Called when RunL leaves from a transaction event. This works in the same
    1.68 +		way as CActve::RunError; return KErrNone if you have handled the error.
    1.69 +		If you don't completely handle the error, a panic will occur.
    1.70 +		@param aError The leave code that RunL left with.
    1.71 +		@param aTransaction The transaction that was being processed.
    1.72 +		@param aEvent The Event that was being processed.
    1.73 +		@return KErrNone if the error has been cancelled or the code
    1.74 +		of the continuing error otherwise.
    1.75 +	*/
    1.76 +	//##ModelId=3A914DF90359
    1.77 +	IMPORT_C virtual TInt MHFRunError(TInt aError, RHTTPTransaction aTransaction, const THTTPEvent& aEvent);
    1.78 +
    1.79 +	/** Called when MHFRunL leaves from a session event. This works in the same
    1.80 +		way as CActve::RunError
    1.81 +		If you don't completely handle the error, a panic will occur.
    1.82 +		@param aError The leave code that RunL left with.
    1.83 +		@param aEvent The Event that was being processed.
    1.84 +		@return KErrNone if the error has been cancelled or the code
    1.85 +		of the continuing error otherwise.	
    1.86 +	*/
    1.87 +	//##ModelId=3C4C37D302C4
    1.88 +	IMPORT_C virtual TInt MHFSessionRunError(TInt aError, const THTTPSessionEvent& aEvent);
    1.89 + 	};
    1.90 +
    1.91 +
    1.92 +#endif //	 __MHTTPFILTERBASE_H__