|
1 /* |
|
2 * Copyright (c) 2006-2009 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 */ |
|
16 |
|
17 #ifndef HARVESTEREVENTMANAGER_H |
|
18 #define HARVESTEREVENTMANAGER_H |
|
19 |
|
20 #include <e32base.h> // For CActive, link against: euser.lib |
|
21 #include <e32msgqueue.h> |
|
22 |
|
23 #include "harvestercommon.h" |
|
24 |
|
25 NONSHARABLE_CLASS( CHarvesterEventManager ) : public CBase |
|
26 { |
|
27 public: |
|
28 virtual ~CHarvesterEventManager(); |
|
29 |
|
30 IMPORT_C static CHarvesterEventManager* GetInstanceL(); |
|
31 IMPORT_C void ReleaseInstance(); |
|
32 |
|
33 /* |
|
34 * Increase event's item count |
|
35 * @param aHEObserverType Event type |
|
36 * @param aCount Increase to event's items |
|
37 */ |
|
38 IMPORT_C void IncreaseItemCount( HarvesterEventObserverType aHEObserverType, TUint aCount = 1 ); |
|
39 |
|
40 /* |
|
41 * Decrease event's item count |
|
42 * @param aHEObserverType Event type |
|
43 * @param aCount Decrease to event's items |
|
44 */ |
|
45 IMPORT_C TBool DecreaseItemCountL( HarvesterEventObserverType aHEObserverType, TUint aCount = 1 ); |
|
46 |
|
47 /* |
|
48 * Get event's item count |
|
49 * @param aHEObserverType Event type |
|
50 * @return Event's item count |
|
51 */ |
|
52 IMPORT_C TUint ItemCount( HarvesterEventObserverType aHEObserverType ); |
|
53 |
|
54 /** |
|
55 * Send event to all matching observers. |
|
56 * @param aHEObserverType Event type |
|
57 * @param aHEState Event state |
|
58 * @param aItemsLeft Items left |
|
59 * @return Event sending error code |
|
60 */ |
|
61 IMPORT_C TInt SendEventL( HarvesterEventObserverType aHEObserverType, |
|
62 HarvesterEventState aHEState, TUint aItemsLeft = 0 ); |
|
63 |
|
64 /* |
|
65 * Register event observer. Leaves if registering fails. |
|
66 * @param aMessage Event observer's client side information |
|
67 */ |
|
68 IMPORT_C void RegisterEventObserverL( const RMessage2& aMessage ); |
|
69 |
|
70 /* |
|
71 * Unregister event observer. Returns error code if unregistering fails. |
|
72 * @param aMessage Event observer's client side information |
|
73 */ |
|
74 IMPORT_C TInt UnregisterEventObserver( const RMessage2& aMessage ); |
|
75 |
|
76 /** |
|
77 * Get current state of event by event type |
|
78 * @param Event type |
|
79 * @return Currect state of event |
|
80 */ |
|
81 IMPORT_C HarvesterEventState CurrentState( HarvesterEventObserverType aHEObserverType ); |
|
82 |
|
83 /** |
|
84 * @deprecated Client generates own "Harvester Event Observer IDs" |
|
85 */ |
|
86 IMPORT_C TUint GetLastClientId(); |
|
87 |
|
88 private: |
|
89 /** |
|
90 * Server side event status. |
|
91 */ |
|
92 struct TEventStatus |
|
93 { |
|
94 HarvesterEventObserverType iObserverType; |
|
95 HarvesterEventState iCurrentState; |
|
96 TUint iItemsLeft; |
|
97 }; |
|
98 |
|
99 // C++ constructor |
|
100 CHarvesterEventManager(); |
|
101 |
|
102 // Second-phase constructor |
|
103 void ConstructL(); |
|
104 |
|
105 /** |
|
106 * Check if observer type contain wanted event type. |
|
107 * @param aObserverType Observer type |
|
108 * @param aEventType Event type |
|
109 * @return Does observer type contain wanted event type |
|
110 */ |
|
111 TBool CheckObserverType( TInt aObserverType, TInt aEventType ); |
|
112 |
|
113 /** |
|
114 * Get wanted event by event type |
|
115 * @param aHEObserverType Wanted event type |
|
116 * @return Requested event or NULL |
|
117 */ |
|
118 TEventStatus* GetEventStatus( HarvesterEventObserverType aHEObserverType ); |
|
119 |
|
120 /** |
|
121 * Send event to single observer. |
|
122 * @param aEventObserverInfo Observer to receive event |
|
123 * @param aHEObserverType Event type |
|
124 * @param aHEState Event state |
|
125 * @param aItemsLeft Items left |
|
126 * @return Event sending error code |
|
127 */ |
|
128 TInt SendSingleEvent( THarvesterEventObserverInfo& aEventObserverInfo, |
|
129 HarvesterEventObserverType aObserverType, |
|
130 HarvesterEventState aEventState, TUint aItemsLeft ); |
|
131 |
|
132 private: |
|
133 |
|
134 RArray<TEventStatus> iEventStatuses; |
|
135 RPointerArray<THarvesterEventQueue> iEventQueues; |
|
136 RPointerArray<THarvesterEventObserverInfo> iRegisteredObservers; |
|
137 }; |
|
138 |
|
139 /** |
|
140 * A helper class to store this singleton's static data. |
|
141 */ |
|
142 class CHarvesterEventManagerStaticData : public CBase |
|
143 { |
|
144 friend class CHarvesterEventManager; |
|
145 |
|
146 public: |
|
147 |
|
148 CHarvesterEventManagerStaticData( CHarvesterEventManager* aHEM ) : iHEM(aHEM), iRefCount(1) |
|
149 { |
|
150 } |
|
151 |
|
152 virtual ~CHarvesterEventManagerStaticData() |
|
153 { |
|
154 delete iHEM; |
|
155 } |
|
156 |
|
157 protected: |
|
158 |
|
159 CHarvesterEventManager* iHEM; |
|
160 TInt iRefCount; |
|
161 }; |
|
162 |
|
163 #endif // HARVESTEREVENTMANAGER_H |