1 /*

     2 * Copyright (c) 2003 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:  Incoming transaction handling interface.

    15 *                Defines a protocol between Presence Engine server

    16 *                and concrete transaction handlers to process

    17 *                incoming XML from network.

    18 *

    19 */

    20 

    21 #ifndef __MPENGINCOMINGTRANSACTIONHANDLER_H__

    22 #define __MPENGINCOMINGTRANSACTIONHANDLER_H__

    23 

    24 

    25 //  INCLUDES

    26 #include <e32std.h>

    27 

    28 

    29 

    30 

    31 // CLASS DECLARATION

    32 /**

    33  * Incoming transaction handling interface.

    34  *

    35  * Defines a protocol between Presence Engine server

    36  * and concrete transaction handlers to process

    37  * incoming XML from network.

    38  *

    39  * Methods listed here are in their "calling order".

    40  *

    41  * @since 2.1

    42  */

    43 class MPEngIncomingTransactionHandler

    44     {

    45     public: // New functions

    46 

    47         /**

    48          *  Process the incoming request.

    49          *

    50          *  This method is called to process incoming XML request

    51          *  from network server.

    52          *  Request can be processed either in synchronous way

    53          *  there passed TRequestStatus is not touched by the handler

    54          *  or when state is changed to pending, and handler will not be

    55          *  deleted till its completion.

    56          *

    57          *

    58          *  @since 3.0

    59          *  @param aRequest buffer containing incoming XML request.

    60          *  @param aStatus status where transaction signals completion

    61          */

    62         virtual void ProcessRequestL( const TDesC8& aRequest,

    63                                       TRequestStatus& aStatus ) = 0;

    64 

    65         /**

    66          *  Cancels asynchronous processing of the request

    67          *

    68          *  When processing of the request is not asynchronous

    69          *  this function does nothing

    70          *

    71          *  @since 3.0

    72          *  @param

    73          *  @return

    74          */

    75         virtual void CancelProcessing( void ) = 0;

    76 

    77     public:  //Destructor

    78         /**

    79          * Virtual inline destructor.

    80          *

    81          * Concrete transaction handlers can be

    82          * destroyed using this interface.

    83          */

    84         virtual ~MPEngIncomingTransactionHandler() {};

    85 

    86     };

    87 #endif      //  __MPENGINCOMINGTRANSACTIONHANDLER_H__

    88 

    89 

    90 //  End of File

    91