(no commit message)
[oweals/gnunet.git] / src / include / gnunet_protocols.h
1 /*
2      This file is part of GNUnet.
3      (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
4
5      GNUnet is free software; you can redistribute it and/or modify
6      it under the terms of the GNU General Public License as published
7      by the Free Software Foundation; either version 2, or (at your
8      option) any later version.
9
10      GNUnet is distributed in the hope that it will be useful, but
11      WITHOUT ANY WARRANTY; without even the implied warranty of
12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13      General Public License for more details.
14
15      You should have received a copy of the GNU General Public License
16      along with GNUnet; see the file COPYING.  If not, write to the
17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */
20
21 /**
22  * @file include/gnunet_protocols.h
23  * @brief constants for network protocols
24  * @author Christian Grothoff
25  */
26
27 #ifndef GNUNET_PROTOCOLS_H
28 #define GNUNET_PROTOCOLS_H
29
30 #ifdef __cplusplus
31 extern "C"
32 {
33 #if 0                           /* keep Emacsens' auto-indent happy */
34 }
35 #endif
36 #endif
37
38 /**
39  * Test if service is online.
40  */
41 #define GNUNET_MESSAGE_TYPE_TEST 0
42
43 /**
44  * Request service shutdown.
45  */
46 #define GNUNET_MESSAGE_TYPE_SHUTDOWN 1
47
48
49 /**
50  * Request DNS resolution.
51  */
52 #define GNUNET_MESSAGE_TYPE_RESOLVER_REQUEST 2
53
54 /**
55  * Response to a DNS resolution request.
56  */
57 #define GNUNET_MESSAGE_TYPE_RESOLVER_RESPONSE 3
58
59
60 /**
61  * Set a statistical value.
62  */
63 #define GNUNET_MESSAGE_TYPE_STATISTICS_SET 4
64
65 /**
66  * Get a statistical value(s).
67  */
68 #define GNUNET_MESSAGE_TYPE_STATISTICS_GET 5
69
70 /**
71  * Response to a STATISTICS_GET message (with value).
72  */
73 #define GNUNET_MESSAGE_TYPE_STATISTICS_VALUE 6
74
75 /**
76  * Response to a STATISTICS_GET message (end of value stream).
77  */
78 #define GNUNET_MESSAGE_TYPE_STATISTICS_END 7
79
80
81 /**
82  * Request to ARM to start a service.
83  */
84 #define GNUNET_MESSAGE_TYPE_ARM_START 8
85
86 /**
87  * Request to ARM to stop a service.
88  */
89 #define GNUNET_MESSAGE_TYPE_ARM_STOP 9
90
91 /**
92  * Response from ARM: service is now up.
93  */
94 #define GNUNET_MESSAGE_TYPE_ARM_IS_UP 10
95
96 /**
97  * Response from ARM: service is now down.
98  * (failed to start it or shut it down).
99  */
100 #define GNUNET_MESSAGE_TYPE_ARM_IS_DOWN 11
101
102 /**
103  * Response from ARM: service status is unknown.
104  */
105 #define GNUNET_MESSAGE_TYPE_ARM_IS_UNKNOWN 12
106
107
108 /**
109  * HELLO message used for communicating peer addresses.
110  * Managed by libgnunethello.
111  */
112 #define GNUNET_MESSAGE_TYPE_HELLO 16
113
114 /**
115  * FRAGMENT of a larger message.
116  * Managed by libgnunetfragment.
117  */
118 #define GNUNET_MESSAGE_TYPE_FRAGMENT 18
119
120
121 /**
122  * Message from the core saying that the transport
123  * server should start giving it messages.  This
124  * should automatically trigger the transmission of
125  * a HELLO message.
126  */
127 #define GNUNET_MESSAGE_TYPE_TRANSPORT_START 20
128
129 /**
130  * Message from TRANSPORT notifying about a
131  * client that connected to us.
132  */
133 #define GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT 21
134
135 /**
136  * Message from TRANSPORT notifying about a
137  * client that disconnected from us.
138  */
139 #define GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT 22
140
141 /**
142  * Request to TRANSPORT to transmit a message.
143  */
144 #define GNUNET_MESSAGE_TYPE_TRANSPORT_SEND 23
145
146 /**
147  * Confirmation from TRANSPORT that message for
148  * transmission has been queued (and that the next
149  * message to this peer can now be passed to the
150  * service).  Note that this confirmation does NOT
151  * imply that the message was fully transmitted.
152  */
153 #define GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK 24
154
155 /**
156  * Message from TRANSPORT notifying about a
157  * message that was received.
158  */
159 #define GNUNET_MESSAGE_TYPE_TRANSPORT_RECV 25
160
161 /**
162  * Message telling transport to limit its receive rate.
163  */
164 #define GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA 26
165
166 /**
167  * Message telling transport to try to connect to the
168  * given peer.
169  */
170 #define GNUNET_MESSAGE_TYPE_TRANSPORT_TRY_CONNECT 27
171
172 /**
173  * Response to another peer confirming that communication was
174  * established.
175  */
176 #define GNUNET_MESSAGE_TYPE_TRANSPORT_ACK 28
177
178 /**
179  * Request to look addresses of peers in server.
180  */
181 #define GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP 29
182
183 /**
184  * Response to the address lookup request. 
185  */
186 #define GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY 30
187
188
189 /**
190  * Request addition of a HELLO
191  */
192 #define GNUNET_MESSAGE_TYPE_PEERINFO_ADD 32
193
194 /**
195  * Request update and listing of a peer.
196  */
197 #define GNUNET_MESSAGE_TYPE_PEERINFO_GET 33
198
199 /**
200  * Request update and listing of all peers.
201  */
202 #define GNUNET_MESSAGE_TYPE_PEERINFO_GET_ALL 34
203
204 /**
205  * Information about one of the peers.
206  */
207 #define GNUNET_MESSAGE_TYPE_PEERINFO_INFO 35
208
209 /**
210  * End of information about other peers.
211  */
212 #define GNUNET_MESSAGE_TYPE_PEERINFO_INFO_END 36
213
214
215 /**
216  * Message by which a TCP transport notifies
217  * the other that it wants to check an address
218  * (and not initiate a persistent connection).
219  */
220 #define GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_PING 40
221
222 /**
223  * Message by which a TCP transport confirms
224  * the other that the address used worked.
225  */
226 #define GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_PONG 41
227
228 /**
229  * Welcome message between TCP transports
230  * (for a persistent connection).
231  */
232 #define GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME 42
233
234 /**
235  * Data message between TCP transports.
236  */
237 #define GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_DATA 43
238
239
240 /**
241  * Initial setup message from core client to core.
242  */
243 #define GNUNET_MESSAGE_TYPE_CORE_INIT 64
244
245 /**
246  * Response from core to core client to INIT message.
247  */
248 #define GNUNET_MESSAGE_TYPE_CORE_INIT_REPLY 65
249
250 /**
251  * Notify clients about new peer-to-peer connections.
252  */
253 #define GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT 66
254
255 /**
256  * Notify clients about peer disconnecting.
257  */
258 #define GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT 67
259
260 /**
261  * Notify clients about incoming P2P messages.
262  */
263 #define GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND 68
264
265 /**
266  * Notify clients about outgoing P2P transmissions.
267  */
268 #define GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND 69
269
270 /**
271  * Request from client to "configure" P2P connection.
272  */
273 #define GNUNET_MESSAGE_TYPE_CORE_REQUEST_CONFIGURE 70
274
275 /**
276  * Response from server about (possibly updated) P2P
277  * connection configuration.
278  */
279 #define GNUNET_MESSAGE_TYPE_CORE_CONFIGURATION_INFO 71
280
281 /**
282  * Solicitation from server for transmission (may have
283  * been requested or also be transmitted without
284  * client's request).
285  */
286 #define GNUNET_MESSAGE_TYPE_CORE_SOLICIT_TRAFFIC 72
287
288 /**
289  * Response from client with message to transmit.
290  */
291 #define GNUNET_MESSAGE_TYPE_CORE_SEND 73
292
293
294 /**
295  * Session key exchange between peers.
296  */
297 #define GNUNET_MESSAGE_TYPE_CORE_SET_KEY 80
298
299 /**
300  * Encapsulation for an encrypted message between peers.
301  */
302 #define GNUNET_MESSAGE_TYPE_CORE_ENCRYPTED_MESSAGE 81
303
304 /**
305  * Check that other peer is alife (challenge).
306  */
307 #define GNUNET_MESSAGE_TYPE_CORE_PING 82
308
309 /**
310  * Confirmation that other peer is alife.
311  */
312 #define GNUNET_MESSAGE_TYPE_CORE_PONG 83
313
314 /**
315  * Request by the other peer to terminate the connection.
316  */
317 #define GNUNET_MESSAGE_TYPE_CORE_HANGUP 84
318
319
320 /**
321  * Message sent by datastore client on join.
322  */
323 #define GNUNET_MESSAGE_TYPE_DATASTORE_RESERVE 92
324
325 /**
326  * Message sent by datastore client on join.
327  */
328 #define GNUNET_MESSAGE_TYPE_DATASTORE_RELEASE_RESERVE 93
329
330 /**
331  * Message sent by datastore to client informing about status
332  * processing a request
333  * (in response to RESERVE, RELEASE_RESERVE, PUT, UPDATE and REMOVE requests).
334  */
335 #define GNUNET_MESSAGE_TYPE_DATASTORE_STATUS 94
336
337 /**
338  * Message sent by datastore client to store data.
339  */
340 #define GNUNET_MESSAGE_TYPE_DATASTORE_PUT 95
341
342 /**
343  * Message sent by datastore client to update data.
344  */
345 #define GNUNET_MESSAGE_TYPE_DATASTORE_UPDATE 96
346
347 /**
348  * Message sent by datastore client to get data.
349  */
350 #define GNUNET_MESSAGE_TYPE_DATASTORE_GET 97
351
352 /**
353  * Message sent by datastore client to get random data.
354  */
355 #define GNUNET_MESSAGE_TYPE_DATASTORE_GET_RANDOM 98
356
357 /**
358  * Message sent by datastore to client providing requested data
359  * (in response to GET or GET_RANDOM request).
360  */
361 #define GNUNET_MESSAGE_TYPE_DATASTORE_DATA 99
362
363 /**
364  * Message sent by datastore to client signaling end of matching data.
365  * This message will also be sent for "GET_RANDOM", even though
366  * "GET_RANDOM" returns at most one data item.
367  */
368 #define GNUNET_MESSAGE_TYPE_DATASTORE_DATA_END 100
369
370 /**
371  * Message sent by datastore client to remove data.
372  */
373 #define GNUNET_MESSAGE_TYPE_DATASTORE_REMOVE 101
374
375 /**
376  * Message sent by datastore client to drop the database.
377  */
378 #define GNUNET_MESSAGE_TYPE_DATASTORE_DROP 102
379
380
381 /**
382  * Message sent by fs client to start indexing.
383  */
384 #define GNUNET_MESSAGE_TYPE_FS_INDEX_START 128
385
386 /**
387  * Affirmative response to a request for start indexing.
388  */
389 #define GNUNET_MESSAGE_TYPE_FS_INDEX_START_OK 129
390
391 /**
392  * Response to a request for start indexing that
393  * refuses.
394  */
395 #define GNUNET_MESSAGE_TYPE_FS_INDEX_START_FAILED 130
396
397 /**
398  * Request from client for list of indexed files.
399  */
400 #define GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_GET 131
401
402 /**
403  * Reply to client with an indexed file name.
404  */
405 #define GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_ENTRY 132
406
407 /**
408  * Reply to client indicating end of list.
409  */
410 #define GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_END 133
411
412 /**
413  * Request from client to unindex a file.
414  */
415 #define GNUNET_MESSAGE_TYPE_FS_UNINDEX 134
416
417 /**
418  * Reply to client indicating unindex receipt.
419  */
420 #define GNUNET_MESSAGE_TYPE_FS_UNINDEX_OK 135
421
422 /**
423  * Client asks FS service to start a (keyword) search.
424  */
425 #define GNUNET_MESSAGE_TYPE_FS_START_SEARCH 136
426
427 /**
428  * FS service has found content matching this client's
429  * request.
430  */
431 #define GNUNET_MESSAGE_TYPE_FS_CONTENT 137
432
433 /**
434  * P2P request for content (one FS to another).
435  */
436 #define GNUNET_MESSAGE_TYPE_FS_GET 138
437
438
439 /**
440  * P2P response with content or active
441  * migration of content.
442  */
443 #define GNUNET_MESSAGE_TYPE_FS_PUT 139
444
445 /**
446  * Reply to client with addresses of other peers 
447  */
448 #define GNUNET_MESSAGE_TYPE_PEER_ADDRESS 140
449
450 /*
451   TODO:
452   - DV
453   - DHT
454   - applications (FS, VPN, CHAT, TRACEKIT, TBENCH)
455 */
456
457
458 #if 0                           /* keep Emacsens' auto-indent happy */
459 {
460 #endif
461 #ifdef __cplusplus
462 }
463 #endif
464
465 /* ifndef GNUNET_PROTOCOLS_H */
466 #endif
467 /* end of gnunet_protocols.h */