PECengine/PresenceServer2/ServerSrc/MPEngHandlerSendData.h
changeset 0 094583676ce7
equal deleted inserted replaced
-1:000000000000 0:094583676ce7
       
     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:  Abstract interface of the send data handler
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef __MPENGHANDLERSENDDATA_H__
       
    21 #define __MPENGHANDLERSENDDATA_H__
       
    22 
       
    23 //  INCLUDES
       
    24 
       
    25 #include <e32def.h>
       
    26 #include <bamdesca.h>
       
    27 
       
    28 // FORWARD DECLARATIONS
       
    29 class CPEngOutGoingTransContainer;
       
    30 class CPEngTransactionStatus;
       
    31 // CLASS DECLARATION
       
    32 
       
    33 /**
       
    34  *  Abstract interface of the send data handler
       
    35  *
       
    36  *  @lib PEngServer2
       
    37  *  @since 3.0
       
    38  */
       
    39 class MPEngHandlerSendData
       
    40     {
       
    41     public: // New functions
       
    42 
       
    43         /**
       
    44          *  Create new transaction containers and start their processing
       
    45          *
       
    46          *	Function goes over array of outgoing transaction handlers
       
    47          *  and if there is some handlers, their containers are created
       
    48          *	and started to process transactions
       
    49          *
       
    50          *  @since 3.0
       
    51          */
       
    52         virtual void CreateNewContainersRunThemL() = 0;
       
    53 
       
    54         /**
       
    55          *  Complete passed transaction container
       
    56          *
       
    57          *  Transaction container is deleted from the array of containers
       
    58          *	Its transaction result is tored(owner ship is transfered)
       
    59          *	If completion code of the container is different than KErrNone
       
    60          *	whole request processing is stoped and completed with such
       
    61          *	a error.
       
    62          *
       
    63          *  @since 3.0
       
    64          *  @param aContainer transaction container to be completed
       
    65          *  @param aStatus result of the transaction status, ownership
       
    66          *						is taken by this function
       
    67          *  @param aErrCode complete code of the container transaction
       
    68          */
       
    69         virtual void CompleteTransContainer(
       
    70             CPEngOutGoingTransContainer* aContainer,
       
    71             CPEngTransactionStatus* aStatus,
       
    72             TInt aErrCode ) = 0;
       
    73 
       
    74         /**
       
    75          *  Checks if this is last running transaction container
       
    76          *
       
    77          *  @since 3.0
       
    78          *  @return ETrue if calling transaction container is last one
       
    79          */
       
    80         virtual TBool LastRunningTransaction() = 0;
       
    81 
       
    82 
       
    83     public:  //Destructor
       
    84 
       
    85         /**
       
    86          * Virtual inline destructor.
       
    87          *
       
    88          * Concrete Request Handler can be
       
    89          * destroyed using this inteface.
       
    90          */
       
    91         virtual ~MPEngHandlerSendData() {};
       
    92 
       
    93 
       
    94 
       
    95     };
       
    96 
       
    97 #endif      // __MPENGHANDLERSENDDATA_H__
       
    98 
       
    99 // End of File