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