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