epoc32/include/http/mhttptransactioncallback.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     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".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 
    17 
    18 /**
    19  @file MHTTPTransactionCallback.h
    20  @warning : This file contains Rose Model ID comments - please do not delete
    21 */
    22 
    23 #ifndef	__MHTTPTRANSACTIONCALLBACK_H__
    24 #define __MHTTPTRANSACTIONCALLBACK_H__
    25 
    26 // System includes
    27 #include <e32std.h>
    28 #include <http/rhttptransaction.h>
    29 #include <http/thttpevent.h>
    30 
    31 
    32 //##ModelId=3C4C1886022B
    33 class MHTTPTransactionCallback
    34 /** 
    35 The per-transaction callback for receiving HTTP events.
    36 @publishedAll
    37 @released
    38 */
    39 	{
    40 public:	// Methods
    41 
    42 	/** Called when the filter's registration conditions are satisfied for events that
    43 		occur on a transaction.
    44 		Note that this function is not allowed to leave if called with
    45 		certain events. @see THTTPEvent
    46 		@param aTransaction The transaction that the event has occurred on.
    47 		@param aEvent The event that has occurred.
    48 		@leave Any Leaves must be handled by the appropriate MHFRunError.
    49 	*/
    50 	//##ModelId=3C4C1886024C
    51 	virtual void MHFRunL(RHTTPTransaction aTransaction, const THTTPEvent& aEvent) =0;
    52 
    53 	/** Called when RunL leaves from a transaction event. This works in the same
    54 		way as CActve::RunError; return KErrNone if you have handled the error.
    55 		If you don't completely handle the error, a panic will occur.
    56 		@param aError The leave code that RunL left with.
    57 		@param aTransaction The transaction that was being processed.
    58 		@param aEvent The Event that was being processed.
    59 		@return KErrNone if the error has been cancelled or the code
    60 		of the continuing error otherwise.
    61 	*/
    62 	//##ModelId=3C4C1886023F
    63 	virtual TInt MHFRunError(TInt aError, RHTTPTransaction aTransaction, const THTTPEvent& aEvent) =0;
    64 
    65 	}; 
    66 
    67 #endif //	__MHTTPTRANSACTIONCALLBACK_H__