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