Smallers steps to keep plugin running
[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 /**
45  * Request DNS resolution.
46  */
47 #define GNUNET_MESSAGE_TYPE_RESOLVER_REQUEST 2
48
49 /**
50  * Response to a DNS resolution request.
51  */
52 #define GNUNET_MESSAGE_TYPE_RESOLVER_RESPONSE 3
53
54
55
56 /**
57  * Request to ARM to start a service.
58  */
59 #define GNUNET_MESSAGE_TYPE_ARM_START 8
60
61 /**
62  * Request to ARM to stop a service.
63  */
64 #define GNUNET_MESSAGE_TYPE_ARM_STOP 9
65
66 /**
67  * Response from ARM: service is now up.
68  */
69 #define GNUNET_MESSAGE_TYPE_ARM_IS_UP 10
70
71 /**
72  * Response from ARM: service is now down.
73  * (failed to start it or shut it down).
74  */
75 #define GNUNET_MESSAGE_TYPE_ARM_IS_DOWN 11
76
77 /**
78  * Response from ARM: service status is unknown.
79  */
80 #define GNUNET_MESSAGE_TYPE_ARM_IS_UNKNOWN 12
81
82 /**
83  * Request ARM service shutdown.
84  */
85 #define GNUNET_MESSAGE_TYPE_ARM_SHUTDOWN 13
86
87 /**
88  * Acknowledge service shutting down, disconnect
89  * indicates service stopped.
90  */
91 #define GNUNET_MESSAGE_TYPE_ARM_SHUTDOWN_ACK 14
92
93 /**
94  * HELLO message used for communicating peer addresses.
95  * Managed by libgnunethello.
96  */
97 #define GNUNET_MESSAGE_TYPE_HELLO 16
98
99 /**
100  * FRAGMENT of a larger message.
101  * Managed by libgnunetfragment.
102  */
103 #define GNUNET_MESSAGE_TYPE_FRAGMENT 18
104
105
106 /**
107  * Message from the core saying that the transport
108  * server should start giving it messages.  This
109  * should automatically trigger the transmission of
110  * a HELLO message.
111  */
112 #define GNUNET_MESSAGE_TYPE_TRANSPORT_START 20
113
114 /**
115  * Message from TRANSPORT notifying about a
116  * client that connected to us.
117  */
118 #define GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT 21
119
120 /**
121  * Message from TRANSPORT notifying about a
122  * client that disconnected from us.
123  */
124 #define GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT 22
125
126 /**
127  * Request to TRANSPORT to transmit a message.
128  */
129 #define GNUNET_MESSAGE_TYPE_TRANSPORT_SEND 23
130
131 /**
132  * Confirmation from TRANSPORT that message for
133  * transmission has been queued (and that the next
134  * message to this peer can now be passed to the
135  * service).  Note that this confirmation does NOT
136  * imply that the message was fully transmitted.
137  */
138 #define GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK 24
139
140 /**
141  * Message from TRANSPORT notifying about a
142  * message that was received.
143  */
144 #define GNUNET_MESSAGE_TYPE_TRANSPORT_RECV 25
145
146 /**
147  * Message telling transport to limit its receive rate.
148  */
149 #define GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA 26
150
151 /**
152  * Request to look addresses of peers in server.
153  */
154 #define GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP 27
155
156 /**
157  * Response to the address lookup request.
158  */
159 #define GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY 28
160
161 /**
162  * Register a client that wants to do blacklisting.
163  */
164 #define GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_INIT 29
165
166 /**
167  * Query to a blacklisting client (is this peer blacklisted)?
168  */
169 #define GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY 30
170
171
172 /**
173  * Reply from blacklisting client (answer to blacklist query).
174  */
175 #define GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY 31
176
177 /**
178  * Transport PING message
179  */
180 #define GNUNET_MESSAGE_TYPE_TRANSPORT_PING 32
181
182 /**
183  * Transport PONG message
184  */
185 #define GNUNET_MESSAGE_TYPE_TRANSPORT_PONG 33
186
187 /**
188  * Message for TRANSPORT asking that a connection
189  * be initiated with a peer.
190  */
191 #define GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_CONNECT 34
192
193 /**
194  * Request update and listing of a peer.
195  */
196 #define GNUNET_MESSAGE_TYPE_PEERINFO_GET 37
197
198 /**
199  * Request update and listing of all peers.
200  */
201 #define GNUNET_MESSAGE_TYPE_PEERINFO_GET_ALL 38
202
203 /**
204  * Information about one of the peers.
205  */
206 #define GNUNET_MESSAGE_TYPE_PEERINFO_INFO 39
207
208 /**
209  * End of information about other peers.
210  */
211 #define GNUNET_MESSAGE_TYPE_PEERINFO_INFO_END 40
212
213 /**
214  * Start notifying this client about all changes to
215  * the known peers until it disconnects.
216  */
217 #define GNUNET_MESSAGE_TYPE_PEERINFO_NOTIFY 41
218
219 /**
220  * DV service to DV Plugin message, when a message is
221  * unwrapped by the DV service and handed to the plugin
222  * for processing
223  */
224 #define GNUNET_MESSAGE_TYPE_TRANSPORT_DV_RECEIVE 44
225
226 /**
227  * DV Plugin to DV service message, indicating a message
228  * should be sent out.
229  */
230 #define GNUNET_MESSAGE_TYPE_TRANSPORT_DV_SEND 45
231
232 /**
233  * DV service to DV api message, containing a confirmation
234  * or failure of a DV_SEND message.
235  */
236 #define GNUNET_MESSAGE_TYPE_TRANSPORT_DV_SEND_RESULT 46
237
238 /**
239  * P2P DV message encapsulating some real message
240  */
241 #define GNUNET_MESSAGE_TYPE_DV_DATA 47
242
243 /**
244  * P2P DV message gossipping peer information
245  */
246 #define GNUNET_MESSAGE_TYPE_DV_GOSSIP 48
247
248 /**
249  * DV Plugin to DV service message, indicating
250  * startup.
251  */
252 #define GNUNET_MESSAGE_TYPE_DV_START 49
253
254 /**
255  * P2P DV message notifying connected peers of a disconnect
256  */
257 #define GNUNET_MESSAGE_TYPE_DV_DISCONNECT 50
258
259 /**
260  * TCP NAT probe message, send from NAT'd peer to
261  * other peer to establish bi-directional communication
262  */
263 #define GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE 51
264
265 /**
266  * Normal UDP message type.
267  */
268 #define GNUNET_MESSAGE_TYPE_TRANSPORT_UDP_MESSAGE 52
269
270 /**
271  * Fragmented part of a UDP message.
272  */
273 #define GNUNET_MESSAGE_TYPE_TRANSPORT_UDP_MESSAGE_PART 53
274
275 /**
276  * UDP NAT probe message, send from NAT'd peer to
277  * other peer to negotiate punched address/port
278  */
279 #define GNUNET_MESSAGE_TYPE_TRANSPORT_UDP_NAT_PROBE 55
280
281 /**
282  * UDP NAT probe reply, sent from a non-NAT'd peer to
283  * a NAT'd one to inform it we got the probe and of the
284  * address/port seen
285  */
286 #define GNUNET_MESSAGE_TYPE_TRANSPORT_UDP_NAT_PROBE_REPLY 56
287
288 /**
289  * UDP NAT probe confirmation, sent from a NAT'd peer to
290  * a non-NAT'd one to inform it which port to send to us
291  * on
292  */
293 #define GNUNET_MESSAGE_TYPE_TRANSPORT_UDP_NAT_PROBE_CONFIRM 57
294
295 /**
296  * UDP NAT probe keepalive, once a hole is punched the NAT'd peer
297  * needs to keep the hole alive
298  */
299 #define GNUNET_MESSAGE_TYPE_TRANSPORT_UDP_NAT_PROBE_KEEPALIVE 58
300
301 /**
302  * Welcome message between TCP transports.
303  */
304 #define GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME 60
305
306 /**
307  * Initial setup message from core client to core.
308  */
309 #define GNUNET_MESSAGE_TYPE_CORE_INIT 64
310
311 /**
312  * Response from core to core client to INIT message.
313  */
314 #define GNUNET_MESSAGE_TYPE_CORE_INIT_REPLY 65
315
316 /**
317  * Notify clients about new peer-to-peer connections (before
318  * key exchange and authentication).
319  */
320 #define GNUNET_MESSAGE_TYPE_CORE_NOTIFY_PRE_CONNECT 66
321
322 /**
323  * Notify clients about new peer-to-peer connections (triggered
324  * after key exchange).
325  */
326 #define GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT 67
327
328 /**
329  * Notify clients about peer disconnecting.
330  */
331 #define GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT 68
332
333 /**
334  * Notify clients about peer status change.
335  */
336 #define GNUNET_MESSAGE_TYPE_CORE_NOTIFY_STATUS_CHANGE 69
337
338 /**
339  * Notify clients about incoming P2P messages.
340  */
341 #define GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND 70
342
343 /**
344  * Notify clients about outgoing P2P transmissions.
345  */
346 #define GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND 71
347
348 /**
349  * Request from client to "configure" P2P connection.
350  */
351 #define GNUNET_MESSAGE_TYPE_CORE_REQUEST_INFO 72
352
353 /**
354  * Response from server about (possibly updated) P2P
355  * connection configuration.
356  */
357 #define GNUNET_MESSAGE_TYPE_CORE_CONFIGURATION_INFO 73
358
359 /**
360  * Request from client with message to transmit.
361  */
362 #define GNUNET_MESSAGE_TYPE_CORE_SEND 74
363
364 /**
365  * Request from client asking to connect to a peer.
366  */
367 #define GNUNET_MESSAGE_TYPE_CORE_REQUEST_CONNECT 75
368
369 /**
370  * Request from client asking to call back with all connected peers.
371  */
372 #define GNUNET_MESSAGE_TYPE_CORE_ITERATE_PEERS 76
373
374 /**
375  * Session key exchange between peers.
376  */
377 #define GNUNET_MESSAGE_TYPE_CORE_SET_KEY 80
378
379 /**
380  * Encapsulation for an encrypted message between peers.
381  */
382 #define GNUNET_MESSAGE_TYPE_CORE_ENCRYPTED_MESSAGE 81
383
384 /**
385  * Check that other peer is alive (challenge).
386  */
387 #define GNUNET_MESSAGE_TYPE_CORE_PING 82
388
389 /**
390  * Confirmation that other peer is alive.
391  */
392 #define GNUNET_MESSAGE_TYPE_CORE_PONG 83
393
394 /**
395  * Request by the other peer to terminate the connection.
396  */
397 #define GNUNET_MESSAGE_TYPE_CORE_HANGUP 84
398
399 /**
400  * Message sent by datastore client on join.
401  */
402 #define GNUNET_MESSAGE_TYPE_DATASTORE_RESERVE 92
403
404 /**
405  * Message sent by datastore client on join.
406  */
407 #define GNUNET_MESSAGE_TYPE_DATASTORE_RELEASE_RESERVE 93
408
409 /**
410  * Message sent by datastore to client informing about status
411  * processing a request
412  * (in response to RESERVE, RELEASE_RESERVE, PUT, UPDATE and REMOVE requests).
413  */
414 #define GNUNET_MESSAGE_TYPE_DATASTORE_STATUS 94
415
416 /**
417  * Message sent by datastore client to store data.
418  */
419 #define GNUNET_MESSAGE_TYPE_DATASTORE_PUT 95
420
421 /**
422  * Message sent by datastore client to update data.
423  */
424 #define GNUNET_MESSAGE_TYPE_DATASTORE_UPDATE 96
425
426 /**
427  * Message sent by datastore client to get data.
428  */
429 #define GNUNET_MESSAGE_TYPE_DATASTORE_GET 97
430
431 /**
432  * Message sent by datastore client to get random data.
433  */
434 #define GNUNET_MESSAGE_TYPE_DATASTORE_GET_RANDOM 98
435
436 /**
437  * Message sent by datastore to client providing requested data
438  * (in response to GET or GET_RANDOM request).
439  */
440 #define GNUNET_MESSAGE_TYPE_DATASTORE_DATA 99
441
442 /**
443  * Message sent by datastore to client signaling end of matching data.
444  * This message will also be sent for "GET_RANDOM", even though
445  * "GET_RANDOM" returns at most one data item.
446  */
447 #define GNUNET_MESSAGE_TYPE_DATASTORE_DATA_END 100
448
449 /**
450  * Message sent by datastore client to remove data.
451  */
452 #define GNUNET_MESSAGE_TYPE_DATASTORE_REMOVE 101
453
454 /**
455  * Message sent by datastore client to drop the database.
456  */
457 #define GNUNET_MESSAGE_TYPE_DATASTORE_DROP 102
458
459
460 /**
461  * Message sent by fs client to start indexing.
462  */
463 #define GNUNET_MESSAGE_TYPE_FS_INDEX_START 128
464
465 /**
466  * Affirmative response to a request for start indexing.
467  */
468 #define GNUNET_MESSAGE_TYPE_FS_INDEX_START_OK 129
469
470 /**
471  * Response to a request for start indexing that
472  * refuses.
473  */
474 #define GNUNET_MESSAGE_TYPE_FS_INDEX_START_FAILED 130
475
476 /**
477  * Request from client for list of indexed files.
478  */
479 #define GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_GET 131
480
481 /**
482  * Reply to client with an indexed file name.
483  */
484 #define GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_ENTRY 132
485
486 /**
487  * Reply to client indicating end of list.
488  */
489 #define GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_END 133
490
491 /**
492  * Request from client to unindex a file.
493  */
494 #define GNUNET_MESSAGE_TYPE_FS_UNINDEX 134
495
496 /**
497  * Reply to client indicating unindex receipt.
498  */
499 #define GNUNET_MESSAGE_TYPE_FS_UNINDEX_OK 135
500
501 /**
502  * Client asks FS service to start a (keyword) search.
503  */
504 #define GNUNET_MESSAGE_TYPE_FS_START_SEARCH 136
505
506 /**
507  * P2P request for content (one FS to another).
508  */
509 #define GNUNET_MESSAGE_TYPE_FS_GET 137
510
511 /**
512  * P2P response with content or active migration of content.  Also
513  * used between the service and clients (in response to START_SEARCH).
514  */
515 #define GNUNET_MESSAGE_TYPE_FS_PUT 138
516
517
518 /**
519  * DHT Message Types
520  */
521
522 /**
523  * Local DHT route request type
524  */
525 #define GNUNET_MESSAGE_TYPE_DHT_LOCAL_ROUTE 142
526
527 /**
528  * Local generic DHT route result type
529  */
530 #define GNUNET_MESSAGE_TYPE_DHT_LOCAL_ROUTE_RESULT 143
531
532 /**
533  * P2P DHT route request type
534  */
535 #define GNUNET_MESSAGE_TYPE_DHT_P2P_ROUTE 144
536
537 /**
538  * P2P DHT route result type
539  */
540 #define GNUNET_MESSAGE_TYPE_DHT_P2P_ROUTE_RESULT 145
541
542 /**
543  * Local generic DHT message stop type
544  */
545 #define GNUNET_MESSAGE_TYPE_DHT_LOCAL_ROUTE_STOP 146
546
547 /**
548  * Local and P2P DHT PUT message
549  * (encapsulated in DHT_ROUTE message)
550  */
551 #define GNUNET_MESSAGE_TYPE_DHT_PUT 147
552
553 /**
554  * Local and P2P DHT GET message
555  * (encapsulated in DHT_ROUTE message)
556  */
557 #define GNUNET_MESSAGE_TYPE_DHT_GET 148
558
559 /**
560  * Local and P2P DHT Get result message
561  */
562 #define GNUNET_MESSAGE_TYPE_DHT_GET_RESULT 149
563
564 /**
565  * Local and P2P DHT find peer message
566  */
567 #define GNUNET_MESSAGE_TYPE_DHT_FIND_PEER 150
568
569 /**
570  * Local and P2P DHT find peer result message
571  */
572 #define GNUNET_MESSAGE_TYPE_DHT_FIND_PEER_RESULT 151
573
574 /**
575  * P2P DHT PING request type
576  */
577 #define GNUNET_MESSAGE_TYPE_DHT_P2P_PING 152
578
579 /**
580  * DHT Control message type, for telling the
581  * DHT to alter its current operation somehow.
582  */
583 #define GNUNET_MESSAGE_TYPE_DHT_CONTROL 153
584
585 /**
586  * Local control message type, tells peer to start
587  * issuing malicious GET requests.
588  */
589 #define GNUNET_MESSAGE_TYPE_DHT_MALICIOUS_GET 154
590
591 /**
592  * Local control message type, tells peer to start
593  * issuing malicious PUT requests.
594  */
595 #define GNUNET_MESSAGE_TYPE_DHT_MALICIOUS_PUT 155
596
597 /**
598  * Local control message type, tells peer to start
599  * dropping all requests.
600  */
601 #define GNUNET_MESSAGE_TYPE_DHT_MALICIOUS_DROP  156
602
603 /**
604  * Hostlist advertisement message
605  */
606 #define GNUNET_MESSAGE_TYPE_HOSTLIST_ADVERTISEMENT 160
607
608
609 /**
610  * Set a statistical value.
611  */
612 #define GNUNET_MESSAGE_TYPE_STATISTICS_SET 168
613
614 /**
615  * Get a statistical value(s).
616  */
617 #define GNUNET_MESSAGE_TYPE_STATISTICS_GET 169
618
619 /**
620  * Response to a STATISTICS_GET message (with value).
621  */
622 #define GNUNET_MESSAGE_TYPE_STATISTICS_VALUE 170
623
624 /**
625  * Response to a STATISTICS_GET message (end of value stream).
626  */
627 #define GNUNET_MESSAGE_TYPE_STATISTICS_END 171
628
629 /**
630  * Watch changes to a statistical value.  Message format is the same
631  * as for GET, except that the subsystem and entry name must be given.
632  */
633 #define GNUNET_MESSAGE_TYPE_STATISTICS_WATCH 172
634
635 /**
636  * Changes to a watched value.
637  */
638 #define GNUNET_MESSAGE_TYPE_STATISTICS_WATCH_VALUE 173
639
640
641 /**
642  * Type of messages between the gnunet-vpn-helper and the daemon
643  */
644 #define GNUNET_MESSAGE_TYPE_VPN_HELPER 185
645
646
647
648 /**
649  * Type of messages between the gnunet-wlan-helper and the daemon
650  *
651  * data messages
652  */
653
654 #define GNUNET_MESSAGE_TYPE_WLAN_HELPER_DATA 195
655
656 /**
657  * Control messages between the gnunet-wlan-helper and the daemon
658  */
659
660 #define GNUNET_MESSAGE_TYPE_WLAN_HELPER_CONTROL 196
661
662 /**
663  * Type of messages for advertisement over wlan
664  */
665 #define GNUNET_MESSAGE_TYPE_WLAN_HELPER_ADVERTISEMENT 196
666
667 /**
668  * Type of messages for wlan
669  */
670
671 /**
672  * Type of messages to query the local service-dns
673  */
674 #define GNUNET_MESSAGE_TYPE_LOCAL_QUERY_DNS 205
675 /**
676  * Type of messages the local service-dns responds with
677  */
678 #define GNUNET_MESSAGE_TYPE_LOCAL_RESPONSE_DNS 206
679
680
681 /**
682  * Type used to match 'all' message types.
683  */
684 #define GNUNET_MESSAGE_TYPE_ALL 65535
685
686 /*
687   TODO:
688   - applications (FS, VPN, CHAT, TRACEKIT, TBENCH)
689 */
690
691
692
693
694 /* BELOW: experimental student-DHT protocol codes */
695
696 /**
697  * Request to join a CAN DHT
698  */
699 #define GNUNET_MESSAGE_TYPE_DHT_CAN_JOIN_REQUEST 1174
700
701 /**
702  * Response to join request of a CAN DHT
703  */
704 #define GNUNET_MESSAGE_TYPE_DHT_CAN_JOIN_REPLY 1175
705
706 /**
707  * Messages for swapping locations
708  */
709 #define GNUNET_MESSAGE_TYPE_DHT_GET_NEIGHBOURLIST_REQUEST 1180
710
711 #define GNUNET_MESSAGE_TYPE_DHT_GET_NEIGHBOURLIST_RESULT 1181
712
713 #define GNUNET_MESSAGE_TYPE_DHT_SWAP_LOCATION_REQUEST 1182
714
715 #define GNUNET_MESSAGE_TYPE_DHT_SWAP_LOCATION_ACK 1183
716
717 /**
718  * Freenet hello message
719  */
720 #define GNUNET_MESSAGE_TYPE_DHT_FREENET_HELLO 1184
721
722
723 #if 0                           /* keep Emacsens' auto-indent happy */
724 {
725 #endif
726 #ifdef __cplusplus
727 }
728 #endif
729
730 /* ifndef GNUNET_PROTOCOLS_H */
731 #endif
732 /* end of gnunet_protocols.h */