|
1 /* |
|
2 * Copyright (c) 2002 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: Presence server message definition |
|
15 * |
|
16 */ |
|
17 |
|
18 #ifndef __TPENGSERVERMESSAGES_H__ |
|
19 #define __TPENGSERVERMESSAGES_H__ |
|
20 |
|
21 // INCLUDES |
|
22 |
|
23 // DATA |
|
24 enum TPEngServerMessages |
|
25 { |
|
26 // !!!! If new Sever message is added here, update it also here |
|
27 // !!!! Remeber to update Highest request number for |
|
28 // !!!! Server Policy check up |
|
29 |
|
30 /** |
|
31 * EMainSessShutdownServer = 1, |
|
32 * EMainSessCreateHolderSubSession = 2, |
|
33 * EMainSessCreateTransactionSubSession = 3, |
|
34 * EMainSessCloseSubSession = 4, |
|
35 * EMainSessCreateAdminSubSession = 5, |
|
36 * EMainSessCloseAdminSubSession = 6, |
|
37 * ESubSessCancelRequest = 7, |
|
38 * ESubSessLogIn = 8, |
|
39 * ESubSessForceLogOut = 9, |
|
40 * ESubSessAttachHolder = 10, |
|
41 * ESubSessAttachWithProcessName = 11, |
|
42 * ESubSessDetachHolder = 12, |
|
43 * ESubSessLeaveAlive = 13, |
|
44 * ESubSessGetServiceTree = 14, |
|
45 * ESubSessGetLogInData = 15, |
|
46 * ESubSessUpdateData = 16, |
|
47 * ESubSessFetchUpdateRqstResult = 17, |
|
48 * EHighestServerRequest = 18 |
|
49 */ |
|
50 |
|
51 /** |
|
52 * Every message to the server carries 4 data slots which can be used |
|
53 * to transfer data to the server side. |
|
54 * If sub-sessions are used, 4th slot of the clients message |
|
55 * is reserved for main session identification. |
|
56 * Meanings of parameters of the message vary for different requests, |
|
57 * order of parameters is fixed, therefore parameters are future |
|
58 * referred as MessageSlot0, MessageSlot 1, MessageSlot 2, MessageSlot 3. |
|
59 * Type of the data in the message slots can vary. |
|
60 */ |
|
61 |
|
62 // ======================================================================= |
|
63 // ================= Main Session requests =============================== |
|
64 // ======================================================================= |
|
65 |
|
66 /*********************************************************************/ |
|
67 /* Server Management */ |
|
68 /*********************************************************************/ |
|
69 |
|
70 // shut down the server |
|
71 EMainSessShutdownServer = 1, |
|
72 |
|
73 /*********************************************************************/ |
|
74 /* Sub Session management */ |
|
75 /*********************************************************************/ |
|
76 |
|
77 /** |
|
78 * Create new Session Holder sub-session |
|
79 * |
|
80 * Message package carries: |
|
81 * MessageSlot 0 - Buffer with Session Id |
|
82 * MessageSlot 1 - Application Id |
|
83 * MessageSlot 2 - not used |
|
84 * MessageSlot 3 - reserved by Sub-session framework |
|
85 */ |
|
86 EMainSessCreateHolderSubSession = 2, |
|
87 |
|
88 /** |
|
89 * Create new Transaction sub-session |
|
90 * |
|
91 * Message package carries: |
|
92 * MessageSlot 0 - Buffer with Session Id |
|
93 * MessageSlot 1 - Application Id |
|
94 * MessageSlot 2 - not used |
|
95 * MessageSlot 3 - reserved by Sub-session framework |
|
96 */ |
|
97 EMainSessCreateTransactionSubSession = 3, |
|
98 |
|
99 /** |
|
100 * close sub-session |
|
101 * |
|
102 * Message package carries: |
|
103 * MessageSlot 0 - not used |
|
104 * MessageSlot 1 - not used |
|
105 * MessageSlot 2 - not used |
|
106 * MessageSlot 3 - reserved by Sub-session framework |
|
107 */ |
|
108 EMainSessCloseSubSession = 4, |
|
109 |
|
110 |
|
111 /** |
|
112 * Create new Administrator sub-session |
|
113 * |
|
114 * Message package carries: |
|
115 * MessageSlot 0 - Buffer with Session Id |
|
116 * MessageSlot 1 - Application Id |
|
117 * MessageSlot 2 - not used |
|
118 * MessageSlot 3 - reserved by Sub-session framework |
|
119 */ |
|
120 EMainSessCreateAdminSubSession = 5, |
|
121 |
|
122 /** |
|
123 * close Administrator sub-session |
|
124 * |
|
125 * Message package carries: |
|
126 * MessageSlot 0 - not used |
|
127 * MessageSlot 1 - not used |
|
128 * MessageSlot 2 - not used |
|
129 * MessageSlot 3 - reserved by Sub-session framework |
|
130 */ |
|
131 EMainSessCloseAdminSubSession = 6, |
|
132 |
|
133 |
|
134 // ======================================================================= |
|
135 // ================= Sub Session requests ================================ |
|
136 // ======================================================================= |
|
137 |
|
138 /*********************************************************************/ |
|
139 /* Asynchronous Requests Management */ |
|
140 /*********************************************************************/ |
|
141 |
|
142 /** |
|
143 * Cancel Asynchronous request Request in the sub-session |
|
144 * |
|
145 * Message package carries: |
|
146 * MessageSlot 0 - Enumeration of the request function |
|
147 * MessageSlot 1 - not used |
|
148 * MessageSlot 2 - not used |
|
149 * MessageSlot 3 - reserved by Sub-session framework |
|
150 */ |
|
151 ESubSessCancelRequest = 7, |
|
152 |
|
153 /*********************************************************************/ |
|
154 /* Session holder client */ |
|
155 /*********************************************************************/ |
|
156 |
|
157 /** |
|
158 * Asynchronous request to log in to the presence service |
|
159 * |
|
160 * There can be only one request of this kind pending |
|
161 * on the server per each CSP session |
|
162 * |
|
163 * Message package carries: |
|
164 * MessageSlot 0 - Buffer with the Log In data |
|
165 * MessageSlot 1 - Not used |
|
166 * MessageSlot 2 - Not used |
|
167 * MessageSlot 3 - reserved by Sub-session framework |
|
168 */ |
|
169 ESubSessLogIn = 8, |
|
170 |
|
171 /** |
|
172 * Asynchronous request to Force Log out CSP session |
|
173 * |
|
174 * There can be only one request of this kind pending |
|
175 * on the server per each CSP session |
|
176 * |
|
177 * Message package carries: |
|
178 * MessageSlot 0 - Not used |
|
179 * MessageSlot 1 - Not used |
|
180 * MessageSlot 2 - Not used |
|
181 * MessageSlot 3 - reserved by Sub-session framework |
|
182 */ |
|
183 ESubSessForceLogOut = 9, |
|
184 |
|
185 /** |
|
186 * Synchronous message to attach session holder |
|
187 * Session holder is attached to the CSP session if it |
|
188 * exists |
|
189 * |
|
190 * Message package carries: |
|
191 * MessageSlot 0 - Not used |
|
192 * MessageSlot 1 - Not used |
|
193 * MessageSlot 2 - Not used |
|
194 * MessageSlot 3 - reserved by Sub-session framework |
|
195 */ |
|
196 ESubSessAttachHolder = 10, |
|
197 |
|
198 /** |
|
199 * Synchronous message to attach session holder |
|
200 * Attaching is done for reserved Process Name |
|
201 * Session holder is attached to the CSP session if it |
|
202 * exists. |
|
203 * |
|
204 * Message package carries: |
|
205 * MessageSlot 0 - Process Name |
|
206 * MessageSlot 1 - Not used |
|
207 * MessageSlot 2 - Not used |
|
208 * MessageSlot 3 - reserved by Sub-session framework |
|
209 */ |
|
210 ESubSessAttachWithProcessName = 11, |
|
211 |
|
212 /** |
|
213 * Asynchronous request to detach session holder from CPS |
|
214 * session. This can lead in closing of whole CPS session |
|
215 * therefore request is asynchronous. |
|
216 * |
|
217 * Message package carries: |
|
218 * MessageSlot 0 - Not used |
|
219 * MessageSlot 1 - Not used |
|
220 * MessageSlot 2 - Not used |
|
221 * MessageSlot 3 - reserved by Sub-session framework |
|
222 */ |
|
223 ESubSessDetachHolder = 12, |
|
224 |
|
225 /** |
|
226 * Synchronous request to reserve CPS session for defined |
|
227 * process name |
|
228 * |
|
229 * Message package carries: |
|
230 * MessageSlot 0 - process name |
|
231 * MessageSlot 1 - Not used |
|
232 * MessageSlot 2 - Not used |
|
233 * MessageSlot 3 - reserved by Sub-session framework |
|
234 */ |
|
235 ESubSessLeaveAlive = 13, |
|
236 |
|
237 /** |
|
238 * Synchronous request to get Service tree of opened session |
|
239 * |
|
240 * Message package carries: |
|
241 * MessageSlot 0 - descriptor to write buffer with the |
|
242 * packed service tree |
|
243 * MessageSlot 1 - Not used |
|
244 * MessageSlot 2 - Not used |
|
245 * MessageSlot 3 - reserved by Sub-session framework |
|
246 */ |
|
247 ESubSessGetServiceTree = 14, |
|
248 |
|
249 /** |
|
250 * Synchronous request to get Log in data of opened session |
|
251 * |
|
252 * Message package carries: |
|
253 * MessageSlot 0 - descriptor to write Log In data |
|
254 * MessageSlot 1 - Not used |
|
255 * MessageSlot 2 - Not used |
|
256 * MessageSlot 3 - reserved by Sub-session framework |
|
257 */ |
|
258 ESubSessGetLogInData = 15, |
|
259 |
|
260 |
|
261 |
|
262 /*********************************************************************/ |
|
263 /* Transfer client */ |
|
264 /*********************************************************************/ |
|
265 |
|
266 /** |
|
267 * Asynchronous request to update defined data to the network |
|
268 * |
|
269 * Message package carries: |
|
270 * MessageSlot 0 - Operation Id |
|
271 * MessageSlot 1 - data to be updated |
|
272 * MessageSlot 2 - Length of passed data |
|
273 * MessageSlot 3 - reserved by Sub-session framework |
|
274 */ |
|
275 ESubSessUpdateData = 16, |
|
276 |
|
277 /** |
|
278 * Synchronous request to fetch result data for last Update |
|
279 * request |
|
280 * |
|
281 * Message package carries: |
|
282 * MessageSlot 0 - buffer server should store result |
|
283 * MessageSlot 1 - max available size of buffer |
|
284 * MessageSlot 2 - not used |
|
285 * MessageSlot 3 - reserved by Sub-session framework |
|
286 */ |
|
287 ESubSessFetchUpdateRqstResult = 17, |
|
288 |
|
289 /** |
|
290 * Highest server request value, not used for any client's request |
|
291 * It is used for specifying of the Request ranges |
|
292 * which are allowed for the client |
|
293 * @see CPolicyServer |
|
294 */ |
|
295 EHighestServerRequest = 18 |
|
296 }; |
|
297 |
|
298 |
|
299 #endif // __TPENGSERVERMESSAGES_H__ |
|
300 |
|
301 // End of File |
|
302 |