keepalive/flextimer/server/inc/mflextimerservicecb.h
author hgs
Mon, 24 May 2010 20:51:35 +0300
changeset 32 5c4486441ae6
permissions -rw-r--r--
201021
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
32
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
 * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
 * All rights reserved.
hgs
parents:
diff changeset
     4
 * This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
 * under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
 * which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
 *
hgs
parents:
diff changeset
     9
 * Initial Contributors:
hgs
parents:
diff changeset
    10
 * Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
 *
hgs
parents:
diff changeset
    12
 * Contributors:
hgs
parents:
diff changeset
    13
 *
hgs
parents:
diff changeset
    14
 * Description:
hgs
parents:
diff changeset
    15
 * This class contains definition of MFlexTimerServiceCB
hgs
parents:
diff changeset
    16
 *
hgs
parents:
diff changeset
    17
 */
hgs
parents:
diff changeset
    18
/*
hgs
parents:
diff changeset
    19
 * %version: 1 %
hgs
parents:
diff changeset
    20
 */
hgs
parents:
diff changeset
    21
// Protection against nested includes
hgs
parents:
diff changeset
    22
#ifndef MFLEXTIMERSERVICECB_H
hgs
parents:
diff changeset
    23
#define MFLEXTIMERSERVICECB_H
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
// Class declaration
hgs
parents:
diff changeset
    26
/**
hgs
parents:
diff changeset
    27
 *  Callback interface for Flexible timer engine to inform a session
hgs
parents:
diff changeset
    28
 *  about timeouts and aborts.
hgs
parents:
diff changeset
    29
 */
hgs
parents:
diff changeset
    30
class MFlexTimerServiceCB
hgs
parents:
diff changeset
    31
    {
hgs
parents:
diff changeset
    32
public:
hgs
parents:
diff changeset
    33
hgs
parents:
diff changeset
    34
    /** Pure virtual functions*/
hgs
parents:
diff changeset
    35
    /**
hgs
parents:
diff changeset
    36
     * Function used for inform that a timeout has happened and client
hgs
parents:
diff changeset
    37
     * should be informed about it. After this function is called, there will
hgs
parents:
diff changeset
    38
     * no longer be indications related to this timer. After this function
hgs
parents:
diff changeset
    39
     * returns, the timer object will be deleted.
hgs
parents:
diff changeset
    40
     * 
hgs
parents:
diff changeset
    41
     */
hgs
parents:
diff changeset
    42
    virtual void Timeout() const = 0;
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
    /**
hgs
parents:
diff changeset
    45
     * Function for informing client session that something has happended and
hgs
parents:
diff changeset
    46
     * timer should be aborted. After this function is called, there will
hgs
parents:
diff changeset
    47
     * no longer be indications related to this timer. After this function
hgs
parents:
diff changeset
    48
     * returns, the timer object will be deleted.
hgs
parents:
diff changeset
    49
     * 
hgs
parents:
diff changeset
    50
     * @param aReason Error code specifying why timer is aborted.
hgs
parents:
diff changeset
    51
     * 
hgs
parents:
diff changeset
    52
     * @see RFlexTimer
hgs
parents:
diff changeset
    53
     *
hgs
parents:
diff changeset
    54
     */
hgs
parents:
diff changeset
    55
    virtual void Abort( TInt aReason ) const = 0;
hgs
parents:
diff changeset
    56
hgs
parents:
diff changeset
    57
    };
hgs
parents:
diff changeset
    58
hgs
parents:
diff changeset
    59
#endif  /* MFLEXTIMERSERVICECB_H */