applayerprotocols/httpexamples/nwsswsptrhnd/MNwssOomHandler.h
changeset 0 b16258d2340f
equal deleted inserted replaced
-1:000000000000 0:b16258d2340f
       
     1 // Copyright (c) 2002-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 MNwssOomHandler.h
       
    18  @warning : This file contains Rose Model ID comments - please do not delete
       
    19 */
       
    20 #ifndef __MNWSSOOMHANDLER_H__
       
    21 #define __MNWSSOOMHANDLER_H__
       
    22 
       
    23 // System includes
       
    24 #include <wapcli.h>
       
    25 #include <wsp/mwspcomethodcallback.h>
       
    26 
       
    27 /**
       
    28 	@since			7.0
       
    29 	This interface provides callback mechanisms used to abort methods or disconnect a session in
       
    30 	in out-of-memory situation in the NWSS WSP Transport Handler.
       
    31  */
       
    32 //##ModelId=3C9B095502F7
       
    33 class MNwssOomHandler
       
    34 	{
       
    35 public:	// Methods
       
    36 
       
    37 /**Used as an asynchronous callback, in an OOM situation, to cause the method that
       
    38 					couldn't complete at the moment of OOM, to be cleanly aborted for the client.
       
    39 	@param			aMethodToAbort	(in) The method which is to be aborted due to the OOM situation
       
    40 	@param			aAbortOnStack	(in) Flag indicating whether the method must be aborted on the
       
    41 										 WAP stack as well.
       
    42 	@since			7.0
       
    43  */
       
    44 	//##ModelId=3C9B09550321
       
    45 	virtual void SendOomMethodAbort(MWspCOMethodCallback& aMethodToAbort, TBool aAbortOnStack) = 0;
       
    46 
       
    47 /**Used as an asynchronous callback, in an OOM situation, to cause the method that
       
    48 					couldn't complete at the moment of OOM, to be cleanly aborted for the client.
       
    49 	@param			aTransId		(in) A WAP stack transaction ID that identifies the method which
       
    50 										 is to be aborted due to the OOM situation
       
    51 	@param			aAbortOnStack	(in) Flag indicating whether the method must be aborted on the
       
    52 										 WAP stack as well.
       
    53 	@since			7.0
       
    54  */
       
    55 	//##ModelId=3C9B09550324
       
    56 	virtual void SendOomMethodAbort(RWSPCOTrans::TTransID aTransId, TBool aAbortOnStack) = 0;
       
    57 
       
    58 /**Used as an asynchronous callback, in an OOM situation, to cause the session that
       
    59 					couldn't connect at the moment of OOM, to be cleanly disconnected for the client.
       
    60 	@param			aDisconnectOnStack	(in) Flag indicating whether the session must be disconnected
       
    61 											 on the WAP stack as well.
       
    62 	@since			7.0
       
    63  */
       
    64 	//##ModelId=3C9B0955031F
       
    65 	virtual void SendOomDisconnect(TBool aDisconnectOnStack) = 0;
       
    66 	};
       
    67 
       
    68 #endif	// __MNWSSOOMHANDLER_H__