keepalive/flextimer/server/inc/mflextimerservicecb.h
changeset 32 5c4486441ae6
equal deleted inserted replaced
31:c16e04725da3 32:5c4486441ae6
       
     1 /*
       
     2  * Copyright (c) 2010 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:
       
    15  * This class contains definition of MFlexTimerServiceCB
       
    16  *
       
    17  */
       
    18 /*
       
    19  * %version: 1 %
       
    20  */
       
    21 // Protection against nested includes
       
    22 #ifndef MFLEXTIMERSERVICECB_H
       
    23 #define MFLEXTIMERSERVICECB_H
       
    24 
       
    25 // Class declaration
       
    26 /**
       
    27  *  Callback interface for Flexible timer engine to inform a session
       
    28  *  about timeouts and aborts.
       
    29  */
       
    30 class MFlexTimerServiceCB
       
    31     {
       
    32 public:
       
    33 
       
    34     /** Pure virtual functions*/
       
    35     /**
       
    36      * Function used for inform that a timeout has happened and client
       
    37      * should be informed about it. After this function is called, there will
       
    38      * no longer be indications related to this timer. After this function
       
    39      * returns, the timer object will be deleted.
       
    40      * 
       
    41      */
       
    42     virtual void Timeout() const = 0;
       
    43 
       
    44     /**
       
    45      * Function for informing client session that something has happended and
       
    46      * timer should be aborted. After this function is called, there will
       
    47      * no longer be indications related to this timer. After this function
       
    48      * returns, the timer object will be deleted.
       
    49      * 
       
    50      * @param aReason Error code specifying why timer is aborted.
       
    51      * 
       
    52      * @see RFlexTimer
       
    53      *
       
    54      */
       
    55     virtual void Abort( TInt aReason ) const = 0;
       
    56 
       
    57     };
       
    58 
       
    59 #endif  /* MFLEXTIMERSERVICECB_H */