|
1 /* |
|
2 * Copyright (c) 2004 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: Service messages between Storage Manager and Storage Server |
|
15 * |
|
16 */ |
|
17 |
|
18 #ifndef __TPENGSTORAGESERVERMESSAGES_H__ |
|
19 #define __TPENGSTORAGESERVERMESSAGES_H__ |
|
20 |
|
21 // CONSTANTS |
|
22 |
|
23 // Mask to include additional TBool value for creation of entry in lock mechanism |
|
24 const TInt KLockEntryCreateMask = 0x100000; |
|
25 |
|
26 // DATA TYPES |
|
27 enum TPEngStorageServerMessages |
|
28 { |
|
29 /** |
|
30 * Every message to the server carries 4 data slots which can be used |
|
31 * to transfer data to the server side. |
|
32 * If sub-sessions are used, 4th slot of the clients message |
|
33 * is reserved for main session identification. |
|
34 * Meanings of parameters of the message vary for different requests, |
|
35 * order of parameters is fixed, therefore parameters are future |
|
36 * referred as MessageSlot0, MessageSlot1, MessageSlot2, MessageSlot3. |
|
37 * Type of the data in the message slots can vary. |
|
38 */ |
|
39 |
|
40 // ======================================================================= |
|
41 // ================= Main Session requests =============================== |
|
42 // ======================================================================= |
|
43 |
|
44 /*********************************************************************/ |
|
45 /* Server Management */ |
|
46 /*********************************************************************/ |
|
47 |
|
48 // shut down the server |
|
49 EMainSessShutdownServer, |
|
50 |
|
51 /*********************************************************************/ |
|
52 /* Sub Session management */ |
|
53 /*********************************************************************/ |
|
54 |
|
55 /** |
|
56 * Create new Storage folder sub-session |
|
57 * |
|
58 * Message package carries: |
|
59 * MessageSlot 0 - Buffer with Session Id |
|
60 * MessageSlot 1 - not used |
|
61 * MessageSlot 2 - not used |
|
62 * MessageSlot 3 - reserved by Sub-session framework |
|
63 */ |
|
64 EMainSessCreateFolderSubSession, |
|
65 |
|
66 /** |
|
67 * Create new Administrator sub-session |
|
68 * |
|
69 * Message package carries: |
|
70 * MessageSlot 0 - Buffer with Session Id |
|
71 * MessageSlot 1 - not used |
|
72 * MessageSlot 2 - not used |
|
73 * MessageSlot 3 - reserved by Sub-session framework |
|
74 */ |
|
75 EMainSessCreateAdminSubSession, |
|
76 |
|
77 /** |
|
78 * close sub-session |
|
79 * |
|
80 * Message package carries: |
|
81 * MessageSlot 0 - not used |
|
82 * MessageSlot 1 - not used |
|
83 * MessageSlot 2 - not used |
|
84 * MessageSlot 3 - reserved by Sub-session framework |
|
85 */ |
|
86 EMainSessCloseSubSession, |
|
87 |
|
88 /*********************************************************************/ |
|
89 /* Global Event Notification */ |
|
90 /*********************************************************************/ |
|
91 |
|
92 /** |
|
93 * start listening of global event |
|
94 * |
|
95 * Message package carries: |
|
96 * MessageSlot 0 - not used |
|
97 * MessageSlot 1 - not used |
|
98 * MessageSlot 2 - not used |
|
99 * MessageSlot 3 - |
|
100 */ |
|
101 EMainSessListenGlobalEvents, |
|
102 |
|
103 /*********************************************************************/ |
|
104 /* Asynchronous Requests Management */ |
|
105 /*********************************************************************/ |
|
106 |
|
107 /** |
|
108 * Cancel Asynchronous request Request |
|
109 * |
|
110 * Message package carries: |
|
111 * MessageSlot 0 - |
|
112 * MessageSlot 1 - |
|
113 * MessageSlot 2 - |
|
114 * MessageSlot 3 - |
|
115 */ |
|
116 EMainSessCancelRequest, |
|
117 |
|
118 /** |
|
119 * Reload Asynchronous Scout on the Server side |
|
120 * |
|
121 * Message package carries: |
|
122 * MessageSlot 0 - |
|
123 * MessageSlot 1 - |
|
124 * MessageSlot 2 - |
|
125 * MessageSlot 3 - |
|
126 */ |
|
127 EMainSessReloadAsynchronousScout, |
|
128 |
|
129 /*********************************************************************/ |
|
130 /* Session Slot Management */ |
|
131 /*********************************************************************/ |
|
132 |
|
133 /** |
|
134 * Create Session Slot Folder |
|
135 * |
|
136 * Message package carries: |
|
137 * MessageSlot 0 - |
|
138 * MessageSlot 1 - |
|
139 * MessageSlot 2 - |
|
140 * MessageSlot 3 - |
|
141 */ |
|
142 EMainSessCreateSessionFolder, |
|
143 |
|
144 /** |
|
145 * Remove Session Slot Folder |
|
146 * |
|
147 * Message package carries: |
|
148 * MessageSlot 0 - |
|
149 * MessageSlot 1 - |
|
150 * MessageSlot 2 - |
|
151 * MessageSlot 3 - |
|
152 */ |
|
153 EMainSessRemoveSessionFolder, |
|
154 |
|
155 /** |
|
156 * Get Session Slot State |
|
157 * |
|
158 * Message package carries: |
|
159 * MessageSlot 0 - |
|
160 * MessageSlot 1 - |
|
161 * MessageSlot 2 - |
|
162 * MessageSlot 3 - |
|
163 */ |
|
164 EMainSessGetSessionState, |
|
165 |
|
166 /** |
|
167 * Get States of all sessions |
|
168 * |
|
169 * Message package carries: |
|
170 * MessageSlot 0 - |
|
171 * MessageSlot 1 - |
|
172 * MessageSlot 2 - |
|
173 * MessageSlot 3 - |
|
174 */ |
|
175 EMainSessGetAllSessionStates, |
|
176 |
|
177 /*********************************************************************/ |
|
178 /* Resting support */ |
|
179 /*********************************************************************/ |
|
180 |
|
181 /** |
|
182 * Wipe out Session slot Folder from the storage |
|
183 * |
|
184 * Message package carries: |
|
185 * MessageSlot 0 - packes session slot Id |
|
186 * MessageSlot 1 - |
|
187 * MessageSlot 2 - |
|
188 * MessageSlot 3 - |
|
189 */ |
|
190 EMainSessWipeSessionFolder, |
|
191 |
|
192 // ================================================================== |
|
193 // ================ Admin Sub session client requests =============== |
|
194 // ================================================================== |
|
195 |
|
196 /*********************************************************************/ |
|
197 /* Global event notification */ |
|
198 /*********************************************************************/ |
|
199 |
|
200 /** |
|
201 * Notify new global event |
|
202 * |
|
203 * Message package carries: |
|
204 * MessageSlot 0 - Buffer with detailed event description |
|
205 * MessageSlot 1 - not-used |
|
206 * MessageSlot 2 - not-used |
|
207 * MessageSlot 3 - reserved by Sub-session framework |
|
208 */ |
|
209 EAdminSubSessNotifyNewEvent, |
|
210 |
|
211 /** |
|
212 * Notify error to listeners |
|
213 * |
|
214 * Message package carries: |
|
215 * MessageSlot 0 - error code |
|
216 * MessageSlot 1 - not-used |
|
217 * MessageSlot 2 - not-used |
|
218 * MessageSlot 3 - reserved by Sub-session framework |
|
219 */ |
|
220 EAdminSubSessNotifyError, |
|
221 |
|
222 /*********************************************************************/ |
|
223 /* Registered Application Id check */ |
|
224 /*********************************************************************/ |
|
225 |
|
226 /** |
|
227 * Check if passed App Id is registered for passed Session Slot |
|
228 * |
|
229 * Message package carries: |
|
230 * MessageSlot 0 - application Id |
|
231 * MessageSlot 1 - not-used |
|
232 * MessageSlot 2 - not-used |
|
233 * MessageSlot 3 - reserved by Sub-session framework |
|
234 */ |
|
235 EAdminSubSessCheckAppIdRegistration, |
|
236 |
|
237 |
|
238 // ======================================================================= |
|
239 // ================= Folder Sub Session client requests ================== |
|
240 // ======================================================================= |
|
241 |
|
242 /*********************************************************************/ |
|
243 /* Asynchronous Requests Management */ |
|
244 /*********************************************************************/ |
|
245 |
|
246 /** |
|
247 * Cancel Asynchronous request Request |
|
248 * |
|
249 * Message package carries: |
|
250 * MessageSlot 0 - |
|
251 * MessageSlot 1 - |
|
252 * MessageSlot 2 - |
|
253 * MessageSlot 3 - reserved by Sub-session framework |
|
254 */ |
|
255 EFolderSubSessCancelRequest, |
|
256 |
|
257 /** |
|
258 * Reload Asynchronous Scout on the Server side |
|
259 * |
|
260 * Message package carries: |
|
261 * MessageSlot 0 - |
|
262 * MessageSlot 1 - |
|
263 * MessageSlot 2 - |
|
264 * MessageSlot 3 - reserved by Sub-session framework |
|
265 */ |
|
266 EFolderSubSessReloadAsynchronousScout, |
|
267 |
|
268 /*********************************************************************/ |
|
269 /* Store Entry management */ |
|
270 /*********************************************************************/ |
|
271 |
|
272 /** |
|
273 * Write store entry |
|
274 * |
|
275 * Message package carries: |
|
276 * MessageSlot 0 - |
|
277 * MessageSlot 1 - |
|
278 * MessageSlot 2 - |
|
279 * MessageSlot 3 - reserved by Sub-session framework |
|
280 */ |
|
281 EFolderSubSessWriteEntry, |
|
282 |
|
283 /** |
|
284 * Read store Entry |
|
285 * |
|
286 * Message package carries: |
|
287 * MessageSlot 0 - |
|
288 * MessageSlot 1 - |
|
289 * MessageSlot 2 - |
|
290 * MessageSlot 3 - reserved by Sub-session framework |
|
291 */ |
|
292 EFolderSubSessReadEntry, |
|
293 |
|
294 /** |
|
295 * Get Entry size |
|
296 * |
|
297 * Message package carries: |
|
298 * MessageSlot 0 - |
|
299 * MessageSlot 1 - |
|
300 * MessageSlot 2 - |
|
301 * MessageSlot 3 - reserved by Sub-session framework |
|
302 */ |
|
303 EFolderSubSessGetEntryLength, |
|
304 |
|
305 /** |
|
306 * Remove Store entry from the storage |
|
307 * |
|
308 * Message package carries: |
|
309 * MessageSlot 0 - |
|
310 * MessageSlot 1 - |
|
311 * MessageSlot 2 - |
|
312 * MessageSlot 3 - reserved by Sub-session framework |
|
313 */ |
|
314 EFolderSubSessRemoveEntry, |
|
315 |
|
316 /** |
|
317 * Lock Store Entry |
|
318 * |
|
319 * Message package carries: |
|
320 * MessageSlot 0 - |
|
321 * MessageSlot 1 - |
|
322 * MessageSlot 2 - |
|
323 * MessageSlot 3 - reserved by Sub-session framework |
|
324 */ |
|
325 EFolderSubSessLockEntry, |
|
326 |
|
327 /** |
|
328 * Unlock the Store entry |
|
329 * |
|
330 * Message package carries: |
|
331 * MessageSlot 0 - |
|
332 * MessageSlot 1 - |
|
333 * MessageSlot 2 - |
|
334 * MessageSlot 3 - reserved by Sub-session framework |
|
335 */ |
|
336 EFolderSubSessUnlockEntry, |
|
337 |
|
338 /** |
|
339 * Is Store entry locked |
|
340 * |
|
341 * Message package carries: |
|
342 * MessageSlot 0 - |
|
343 * MessageSlot 1 - |
|
344 * MessageSlot 2 - |
|
345 * MessageSlot 3 - reserved by Sub-session framework |
|
346 */ |
|
347 EFolderSubSessIsEntryLocked, |
|
348 |
|
349 /** |
|
350 * Suspend notification to the client |
|
351 * |
|
352 * Message package carries: |
|
353 * MessageSlot 0 - |
|
354 * MessageSlot 1 - |
|
355 * MessageSlot 2 - |
|
356 * MessageSlot 3 - reserved by Sub-session framework |
|
357 */ |
|
358 EFolderSubSessSuspendNotification, |
|
359 |
|
360 /** |
|
361 * Resume notification to the client |
|
362 * |
|
363 * Message package carries: |
|
364 * MessageSlot 0 - |
|
365 * MessageSlot 1 - |
|
366 * MessageSlot 2 - |
|
367 * MessageSlot 3 - reserved by Sub-session framework |
|
368 */ |
|
369 EFolderSubSessResumeNotification, |
|
370 |
|
371 /*********************************************************************/ |
|
372 /* Storage ID changes notify management */ |
|
373 /*********************************************************************/ |
|
374 |
|
375 /** |
|
376 * Synchronous Request to register for notification |
|
377 * of change of content of particular storage entry, |
|
378 * |
|
379 * Message package carries: |
|
380 * MessageSlot 0 - |
|
381 * MessageSlot 1 - |
|
382 * MessageSlot 2 - |
|
383 * MessageSlot 3 - reserved by Sub-session framework |
|
384 */ |
|
385 EFolderSubSessListenSIDsChanges, |
|
386 |
|
387 /** |
|
388 * Synchronous Request to update set of SIDs client |
|
389 * is interested in. |
|
390 * |
|
391 * Message package carries: |
|
392 * MessageSlot 0 - |
|
393 * MessageSlot 1 - |
|
394 * MessageSlot 2 - |
|
395 * MessageSlot 3 - reserved by Sub-session framework |
|
396 */ |
|
397 EFolderSubSessUpdateListenSIDsScout, |
|
398 |
|
399 /** |
|
400 * Synchronous Request to fetch changed SIds indexes |
|
401 * |
|
402 * Message package carries: |
|
403 * MessageSlot 0 - |
|
404 * MessageSlot 1 - |
|
405 * MessageSlot 2 - |
|
406 * MessageSlot 3 - reserved by Sub-session framework |
|
407 */ |
|
408 EFolderSubSessFetchChangedSIDsIndexes, |
|
409 |
|
410 /** |
|
411 * Synchronous Request to notify that client forces Store Entry |
|
412 * change notification |
|
413 * |
|
414 * Message package carries: |
|
415 * MessageSlot 0 - |
|
416 * MessageSlot 1 - |
|
417 * MessageSlot 2 - |
|
418 * MessageSlot 3 - reserved by Sub-session framework |
|
419 */ |
|
420 EFolderSubSessNotifyChangedSIDs, |
|
421 |
|
422 /** |
|
423 * Highest Storage server request value, not used for any client's request |
|
424 * It is used for specifying of the Request ranges |
|
425 */ |
|
426 EHighestStoreServerRequest |
|
427 }; |
|
428 |
|
429 #endif // __TPENGSTORAGESERVERMESSAGES_H__ |
|
430 |
|
431 // End of File |