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