no more TCP PING/PONG
[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  * Start notifying this client about all changes to
216  * the known peers until it disconnects.
217  */
218 #define GNUNET_MESSAGE_TYPE_PEERINFO_NOTIFY 37
219
220
221 /**
222  * Welcome message between TCP transports.
223  */
224 #define GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME 40
225
226
227 /**
228  * Initial setup message from core client to core.
229  */
230 #define GNUNET_MESSAGE_TYPE_CORE_INIT 64
231
232 /**
233  * Response from core to core client to INIT message.
234  */
235 #define GNUNET_MESSAGE_TYPE_CORE_INIT_REPLY 65
236
237 /**
238  * Notify clients about new peer-to-peer connections (before
239  * key exchange and authentication).
240  */
241 #define GNUNET_MESSAGE_TYPE_CORE_NOTIFY_PRE_CONNECT 66
242
243 /**
244  * Notify clients about new peer-to-peer connections (triggered
245  * after key exchange).
246  */
247 #define GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT 67
248
249 /**
250  * Notify clients about peer disconnecting.
251  */
252 #define GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT 68
253
254 /**
255  * Notify clients about incoming P2P messages.
256  */
257 #define GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND 69
258
259 /**
260  * Notify clients about outgoing P2P transmissions.
261  */
262 #define GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND 70
263
264 /**
265  * Request from client to "configure" P2P connection.
266  */
267 #define GNUNET_MESSAGE_TYPE_CORE_REQUEST_INFO 71
268
269 /**
270  * Response from server about (possibly updated) P2P
271  * connection configuration.
272  */
273 #define GNUNET_MESSAGE_TYPE_CORE_CONFIGURATION_INFO 72
274
275 /**
276  * Request from client with message to transmit.
277  */
278 #define GNUNET_MESSAGE_TYPE_CORE_SEND 73
279
280 /**
281  * Request from client asking to connect to a peer.
282  */
283 #define GNUNET_MESSAGE_TYPE_CORE_REQUEST_CONNECT 74
284
285 /**
286  * Request from client asking to disconnect from a peer.
287  */
288 #define GNUNET_MESSAGE_TYPE_CORE_REQUEST_DISCONNECT 75
289
290
291 /**
292  * Session key exchange between peers.
293  */
294 #define GNUNET_MESSAGE_TYPE_CORE_SET_KEY 80
295
296 /**
297  * Encapsulation for an encrypted message between peers.
298  */
299 #define GNUNET_MESSAGE_TYPE_CORE_ENCRYPTED_MESSAGE 81
300
301 /**
302  * Check that other peer is alife (challenge).
303  */
304 #define GNUNET_MESSAGE_TYPE_CORE_PING 82
305
306 /**
307  * Confirmation that other peer is alife.
308  */
309 #define GNUNET_MESSAGE_TYPE_CORE_PONG 83
310
311 /**
312  * Request by the other peer to terminate the connection.
313  */
314 #define GNUNET_MESSAGE_TYPE_CORE_HANGUP 84
315
316 /**
317  * Dummy message send by the topology service to create connections.
318  */
319 #define GNUNET_MESSAGE_TYPE_TOPOLOGY_DUMMY 91
320
321 /**
322  * Message sent by datastore client on join.
323  */
324 #define GNUNET_MESSAGE_TYPE_DATASTORE_RESERVE 92
325
326 /**
327  * Message sent by datastore client on join.
328  */
329 #define GNUNET_MESSAGE_TYPE_DATASTORE_RELEASE_RESERVE 93
330
331 /**
332  * Message sent by datastore to client informing about status
333  * processing a request
334  * (in response to RESERVE, RELEASE_RESERVE, PUT, UPDATE and REMOVE requests).
335  */
336 #define GNUNET_MESSAGE_TYPE_DATASTORE_STATUS 94
337
338 /**
339  * Message sent by datastore client to store data.
340  */
341 #define GNUNET_MESSAGE_TYPE_DATASTORE_PUT 95
342
343 /**
344  * Message sent by datastore client to update data.
345  */
346 #define GNUNET_MESSAGE_TYPE_DATASTORE_UPDATE 96
347
348 /**
349  * Message sent by datastore client to get data.
350  */
351 #define GNUNET_MESSAGE_TYPE_DATASTORE_GET 97
352
353 /**
354  * Message sent by datastore client to get random data.
355  */
356 #define GNUNET_MESSAGE_TYPE_DATASTORE_GET_RANDOM 98
357
358 /**
359  * Message sent by datastore to client providing requested data
360  * (in response to GET or GET_RANDOM request).
361  */
362 #define GNUNET_MESSAGE_TYPE_DATASTORE_DATA 99
363
364 /**
365  * Message sent by datastore to client signaling end of matching data.
366  * This message will also be sent for "GET_RANDOM", even though
367  * "GET_RANDOM" returns at most one data item.
368  */
369 #define GNUNET_MESSAGE_TYPE_DATASTORE_DATA_END 100
370
371 /**
372  * Message sent by datastore client to remove data.
373  */
374 #define GNUNET_MESSAGE_TYPE_DATASTORE_REMOVE 101
375
376 /**
377  * Message sent by datastore client to drop the database.
378  */
379 #define GNUNET_MESSAGE_TYPE_DATASTORE_DROP 102
380
381
382 /**
383  * Message sent by fs client to start indexing.
384  */
385 #define GNUNET_MESSAGE_TYPE_FS_INDEX_START 128
386
387 /**
388  * Affirmative response to a request for start indexing.
389  */
390 #define GNUNET_MESSAGE_TYPE_FS_INDEX_START_OK 129
391
392 /**
393  * Response to a request for start indexing that
394  * refuses.
395  */
396 #define GNUNET_MESSAGE_TYPE_FS_INDEX_START_FAILED 130
397
398 /**
399  * Request from client for list of indexed files.
400  */
401 #define GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_GET 131
402
403 /**
404  * Reply to client with an indexed file name.
405  */
406 #define GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_ENTRY 132
407
408 /**
409  * Reply to client indicating end of list.
410  */
411 #define GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_END 133
412
413 /**
414  * Request from client to unindex a file.
415  */
416 #define GNUNET_MESSAGE_TYPE_FS_UNINDEX 134
417
418 /**
419  * Reply to client indicating unindex receipt.
420  */
421 #define GNUNET_MESSAGE_TYPE_FS_UNINDEX_OK 135
422
423 /**
424  * Client asks FS service to start a (keyword) search.
425  */
426 #define GNUNET_MESSAGE_TYPE_FS_START_SEARCH 136
427
428 /**
429  * FS service has found content matching this client's
430  * request.
431  */
432 #define GNUNET_MESSAGE_TYPE_FS_CONTENT 137
433
434 /**
435  * P2P request for content (one FS to another).
436  */
437 #define GNUNET_MESSAGE_TYPE_FS_GET 138
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   TODO:
447   - DV
448   - DHT
449   - applications (FS, VPN, CHAT, TRACEKIT, TBENCH)
450 */
451
452
453 #if 0                           /* keep Emacsens' auto-indent happy */
454 {
455 #endif
456 #ifdef __cplusplus
457 }
458 #endif
459
460 /* ifndef GNUNET_PROTOCOLS_H */
461 #endif
462 /* end of gnunet_protocols.h */