radioapp/radiouiengine/tsrc/inc/t_schedulerstartandstoptimer.h
author hgs
Mon, 20 Sep 2010 18:04:48 +0300
changeset 51 bbebb0235466
permissions -rw-r--r--
201037
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
51
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2009 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:  Timer for Starting and Stopping current Active Scheduler.
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
#ifndef C_ACCSRVRESETINACTIVITYTIMETIMER_H
hgs
parents:
diff changeset
    21
#define C_ACCSRVRESETINACTIVITYTIMETIMER_H
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
#include <e32base.h>
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
#include "mschedulerstartandstoptimerobserver.h"
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
hgs
parents:
diff changeset
    31
/**  Timer's default value in micro seconds */
hgs
parents:
diff changeset
    32
const TInt KTimerDefaultValue   = 400;
hgs
parents:
diff changeset
    33
hgs
parents:
diff changeset
    34
hgs
parents:
diff changeset
    35
/**
hgs
parents:
diff changeset
    36
 *  Timer class for Starting and Stopping current Active Scheduler.
hgs
parents:
diff changeset
    37
 *  
hgs
parents:
diff changeset
    38
 *
hgs
parents:
diff changeset
    39
 *  @code
hgs
parents:
diff changeset
    40
 *   ?good_class_usage_example(s)
hgs
parents:
diff changeset
    41
 *  @endcode
hgs
parents:
diff changeset
    42
 *
hgs
parents:
diff changeset
    43
 *  @lib AccServer.exe
hgs
parents:
diff changeset
    44
 *  @since S60 10.1
hgs
parents:
diff changeset
    45
 */
hgs
parents:
diff changeset
    46
NONSHARABLE_CLASS(  CSchedulerStopAndStartTimer ): public CTimer
hgs
parents:
diff changeset
    47
    {
hgs
parents:
diff changeset
    48
hgs
parents:
diff changeset
    49
public:
hgs
parents:
diff changeset
    50
    enum TTimerId{
hgs
parents:
diff changeset
    51
    ETimerIdRunMUT = 0,
hgs
parents:
diff changeset
    52
    ETimerIdCreateMUT = 1,
hgs
parents:
diff changeset
    53
    ETimerIdDeleteMUT = 2    
hgs
parents:
diff changeset
    54
    };
hgs
parents:
diff changeset
    55
hgs
parents:
diff changeset
    56
hgs
parents:
diff changeset
    57
    /**
hgs
parents:
diff changeset
    58
    * Two-phased constructor.
hgs
parents:
diff changeset
    59
    * @param aSchedulerStartAndStopTimerObserver Observer callback interface.
hgs
parents:
diff changeset
    60
    */
hgs
parents:
diff changeset
    61
    static CSchedulerStopAndStartTimer* NewL(
hgs
parents:
diff changeset
    62
            MSchedulerStartAndStopTimerObserver& aSchedulerStartAndStopTimerObserver );
hgs
parents:
diff changeset
    63
hgs
parents:
diff changeset
    64
    /**
hgs
parents:
diff changeset
    65
    * Destructor.
hgs
parents:
diff changeset
    66
    */
hgs
parents:
diff changeset
    67
    virtual ~CSchedulerStopAndStartTimer();
hgs
parents:
diff changeset
    68
hgs
parents:
diff changeset
    69
    /**
hgs
parents:
diff changeset
    70
     * Starts the timer.
hgs
parents:
diff changeset
    71
     * @since S60 10.1
hgs
parents:
diff changeset
    72
     * @param aTime Time out value.
hgs
parents:
diff changeset
    73
     * @param aTimeId Timer Id.
hgs
parents:
diff changeset
    74
     * @return void
hgs
parents:
diff changeset
    75
     */
hgs
parents:
diff changeset
    76
     void StartTimer( TInt aTime = KTimerDefaultValue,
hgs
parents:
diff changeset
    77
             TUint aTimerId = ETimerIdRunMUT );
hgs
parents:
diff changeset
    78
hgs
parents:
diff changeset
    79
hgs
parents:
diff changeset
    80
protected:
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
    /**
hgs
parents:
diff changeset
    83
     * From CActive.
hgs
parents:
diff changeset
    84
     * Handles an active object's request completion event.
hgs
parents:
diff changeset
    85
     *
hgs
parents:
diff changeset
    86
     * @since S60 10.1
hgs
parents:
diff changeset
    87
     * @param void
hgs
parents:
diff changeset
    88
     */
hgs
parents:
diff changeset
    89
   void RunL();
hgs
parents:
diff changeset
    90
    
hgs
parents:
diff changeset
    91
   /**
hgs
parents:
diff changeset
    92
    * From CActive.
hgs
parents:
diff changeset
    93
    * Handles RunL's leave cases
hgs
parents:
diff changeset
    94
    *
hgs
parents:
diff changeset
    95
    * @since S60 10.1
hgs
parents:
diff changeset
    96
    * @param aError Error code.
hgs
parents:
diff changeset
    97
    */
hgs
parents:
diff changeset
    98
   TInt RunError( TInt aError );
hgs
parents:
diff changeset
    99
hgs
parents:
diff changeset
   100
hgs
parents:
diff changeset
   101
private:
hgs
parents:
diff changeset
   102
hgs
parents:
diff changeset
   103
    /**
hgs
parents:
diff changeset
   104
    * C++ default constructor.
hgs
parents:
diff changeset
   105
    * @param aSchedulerStartAndStopTimerObserver Observer callback interface.
hgs
parents:
diff changeset
   106
    */
hgs
parents:
diff changeset
   107
    CSchedulerStopAndStartTimer(
hgs
parents:
diff changeset
   108
            MSchedulerStartAndStopTimerObserver& aSchedulerStartAndStopTimerObserver );
hgs
parents:
diff changeset
   109
hgs
parents:
diff changeset
   110
    /**
hgs
parents:
diff changeset
   111
     * By default Symbian OS constructor is private.
hgs
parents:
diff changeset
   112
     * @param none.
hgs
parents:
diff changeset
   113
     */
hgs
parents:
diff changeset
   114
    void ConstructL();
hgs
parents:
diff changeset
   115
hgs
parents:
diff changeset
   116
hgs
parents:
diff changeset
   117
private: // data
hgs
parents:
diff changeset
   118
    enum TTmerPhase
hgs
parents:
diff changeset
   119
        {
hgs
parents:
diff changeset
   120
        ETimerPhaseUndefined = 0,
hgs
parents:
diff changeset
   121
        ETimerPhaseStarting = 1,
hgs
parents:
diff changeset
   122
        ETimerPhaseStarted = 2
hgs
parents:
diff changeset
   123
        };
hgs
parents:
diff changeset
   124
hgs
parents:
diff changeset
   125
    /**
hgs
parents:
diff changeset
   126
     * TimeOut time
hgs
parents:
diff changeset
   127
     */
hgs
parents:
diff changeset
   128
    TInt iTime;
hgs
parents:
diff changeset
   129
hgs
parents:
diff changeset
   130
    /**
hgs
parents:
diff changeset
   131
     * Timer id. Client specific i.e same value is returned to observer.
hgs
parents:
diff changeset
   132
     */
hgs
parents:
diff changeset
   133
    TUint iTimerId;
hgs
parents:
diff changeset
   134
    
hgs
parents:
diff changeset
   135
    /**
hgs
parents:
diff changeset
   136
     * ResetInactivityTimeTimerObserver object.
hgs
parents:
diff changeset
   137
     */
hgs
parents:
diff changeset
   138
    MSchedulerStartAndStopTimerObserver& iSchedulerStartAndStopTimerObserver;
hgs
parents:
diff changeset
   139
hgs
parents:
diff changeset
   140
    TTmerPhase iPhase;
hgs
parents:
diff changeset
   141
    };
hgs
parents:
diff changeset
   142
hgs
parents:
diff changeset
   143
hgs
parents:
diff changeset
   144
#endif // C_ACCSRVRESETINACTIVITYTIMETIMER_H