1 /*

     2 * Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies). 

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Request handler abstract interface

    15 *				 Defines basic functionality must be implemented

    16 *  				 by request handler

    17 *

    18 */

    19 

    20 

    21 

    22 #ifndef __MPENGREQUESTHANDLER_H__

    23 #define __MPENGREQUESTHANDLER_H__

    24 

    25 //  INCLUDES

    26 

    27 #include <e32def.h>

    28 

    29 // FORWARD DECLARATION

    30 class RPEngMessage;

    31 

    32 /**

    33  *  Request handler abstract interface

    34  *  Defines basic functionality must be implemented

    35  *  by request handler

    36  *

    37  *  @lib PEngServer2

    38  *  @since 3.0

    39  */

    40 class MPEngRequestHandler

    41     {

    42     public: // New functions

    43 

    44         /**

    45          *	Return Session Id

    46          *	Returns Session Id from which request was issued

    47          *	This is used to track from which connected client request came

    48          *

    49          *	@since 3.0

    50          *	@return session ID

    51          */

    52         virtual TInt32 SessionId( ) const = 0;

    53 

    54         /**

    55          *	Return Sub Session Id

    56          *	Returns Sub Session Id from which request was issued

    57          *	This is used to track from which connect client request came

    58          *

    59          *	@since 3.0

    60          *	@return sub-session Id

    61          */

    62         virtual TInt SubSessionId( ) const = 0;

    63 

    64         /**

    65          *	Return Request function

    66          *	returns Request function of the request handler

    67          *

    68          *	@since 3.0

    69          *	@return request function

    70          */

    71         virtual TInt RequestFunction( ) const = 0;

    72 

    73         /**

    74          *	Cancel Request

    75          *

    76          *	Canceles asynchronous Request processing, request is

    77          *	completed to the client side and request handler

    78          *	is deleted

    79          *

    80          *

    81          *	@since 3.0

    82          */

    83         virtual void CancelRequestD( ) = 0;

    84 

    85         /**

    86          * Set message handler

    87          *

    88          * @since 3.0

    89          */

    90         virtual void SetMessage( const RPEngMessage& aMessage ) = 0;

    91 

    92     public:  //Destructor

    93 

    94         /**

    95           * Virtual inline destructor.

    96           *

    97           * Concrete Request Handler can be

    98           * destroyed using this interface.

    99           */

   100         virtual ~MPEngRequestHandler() {};

   101 

   102     };

   103 

   104 #endif      // __MPENGREQUESTHANDLER_H__

   105 

   106 // End of File