1 /* |
|
2 * Copyright (c) 2006 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 the License "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: Header file for CCSeSchdulerTimer-class.* |
|
15 */ |
|
16 |
|
17 |
|
18 |
|
19 |
|
20 #ifndef _CCSESCHEDULERTIMER_H |
|
21 #define _CCSESCHEDULERTIMER_H |
|
22 |
|
23 // INCLUDES |
|
24 #include <e32base.h> |
|
25 |
|
26 // CONSTANTS |
|
27 // None |
|
28 // MACROS |
|
29 // None |
|
30 |
|
31 // DATA TYPES |
|
32 // None |
|
33 |
|
34 // FUNCTION PROTOTYPES |
|
35 // None |
|
36 |
|
37 // FORWARD DECLARATIONS |
|
38 class MCseSchedulerTimerObserver; |
|
39 class CCseSchedulerPluginIF; |
|
40 |
|
41 /** |
|
42 * Timer for determining when schedules should be run. |
|
43 */ |
|
44 class CCseSchedulerTimer : public CTimer |
|
45 { |
|
46 public: // Constructors and destructors |
|
47 /** |
|
48 * Destructor. |
|
49 */ |
|
50 virtual ~CCseSchedulerTimer(); |
|
51 |
|
52 /** |
|
53 * Two-phased constructor. |
|
54 * @param aObserver A pointer back to server engine through observer |
|
55 */ |
|
56 static CCseSchedulerTimer* NewL( MCseSchedulerTimerObserver* aObserver ); |
|
57 |
|
58 public: // New methods |
|
59 /** |
|
60 * Sets timer to fire on given time |
|
61 * @param aTime Time when timer is set to fire |
|
62 * @return None |
|
63 */ |
|
64 void SetTimer( const TTime& aTime ); |
|
65 |
|
66 private: // Constructors and destructors |
|
67 /** |
|
68 * By default Symbian 2nd phase constructor is private. |
|
69 */ |
|
70 void ConstructL(); |
|
71 |
|
72 /** |
|
73 * C++ default constructor. |
|
74 * @param aObserver A pointer back to server engine through observer. |
|
75 */ |
|
76 CCseSchedulerTimer( MCseSchedulerTimerObserver* aObserver ); |
|
77 |
|
78 private: // Functions from base classes |
|
79 /** |
|
80 * RunL |
|
81 * @return None |
|
82 */ |
|
83 void RunL(); |
|
84 |
|
85 /** |
|
86 * RunError |
|
87 * @return See CTimer documentation. |
|
88 */ |
|
89 TInt RunError( TInt aError ); |
|
90 |
|
91 /** |
|
92 * DoCancel |
|
93 * @return None |
|
94 */ |
|
95 void DoCancel(); |
|
96 |
|
97 private: // Data |
|
98 /** |
|
99 * Pointer back to scheduler engine. Not own. |
|
100 */ |
|
101 MCseSchedulerTimerObserver* iObserver; |
|
102 }; |
|
103 |
|
104 #endif //_CCSESCHEDULERTIMER_H |
|