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  * Request to look addresses of peers in server.
 168  */
 169 #define GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP 27
 170
 171 /**
 172  * Response to the address lookup request.
 173  */
 174 #define GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY 28
 175
 176 /**
 177  * Register a client that wants to do blacklisting.
 178  */
 179 #define GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_INIT 29
 180
 181 /**
 182  * Query to a blacklisting client (is this peer blacklisted)?
 183  */
 184 #define GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY 30
 185
 186 /**
 187  * Reply from blacklisting client (answer to blacklist query).
 188  */
 189 #define GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY 31
 190
 191 /**
 192  * Transport PING message
 193  */
 194 #define GNUNET_MESSAGE_TYPE_TRANSPORT_PING 32
 195
 196 /**
 197  * Transport PONG message
 198  */
 199 #define GNUNET_MESSAGE_TYPE_TRANSPORT_PONG 33
 200
 201 /**
 202  * Request update and listing of a peer.
 203  */
 204 #define GNUNET_MESSAGE_TYPE_PEERINFO_GET 37
 205
 206 /**
 207  * Request update and listing of all peers.
 208  */
 209 #define GNUNET_MESSAGE_TYPE_PEERINFO_GET_ALL 38
 210
 211 /**
 212  * Information about one of the peers.
 213  */
 214 #define GNUNET_MESSAGE_TYPE_PEERINFO_INFO 39
 215
 216 /**
 217  * End of information about other peers.
 218  */
 219 #define GNUNET_MESSAGE_TYPE_PEERINFO_INFO_END 40
 220
 221 /**
 222  * Start notifying this client about all changes to
 223  * the known peers until it disconnects.
 224  */
 225 #define GNUNET_MESSAGE_TYPE_PEERINFO_NOTIFY 41
 226
 227 /**
 228  * DV service to DV Plugin message, when a message is
 229  * unwrapped by the DV service and handed to the plugin
 230  * for processing
 231  */
 232 #define GNUNET_MESSAGE_TYPE_TRANSPORT_DV_RECEIVE 44
 233
 234 /**
 235  * DV Plugin to DV service message, indicating a message
 236  * should be sent out.
 237  */
 238 #define GNUNET_MESSAGE_TYPE_TRANSPORT_DV_SEND 45
 239
 240 /**
 241  * P2P DV message encapsulating some real message
 242  */
 243 #define GNUNET_MESSAGE_TYPE_DV_DATA 46
 244
 245 /**
 246  * P2P DV message gossipping peer information
 247  */
 248 #define GNUNET_MESSAGE_TYPE_DV_GOSSIP 47
 249
 250 /**
 251  * DV Plugin to DV service message, indicating
 252  * startup.
 253  */
 254 #define GNUNET_MESSAGE_TYPE_DV_START 48
 255
 256 /**
 257  * UDP NAT probe message, send from NAT'd peer to
 258  * other peer to negotiate punched address/port
 259  */
 260 #define GNUNET_MESSAGE_TYPE_TRANSPORT_UDP_NAT_PROBE 55
 261
 262 /**
 263  * UDP NAT probe reply, sent from a non-NAT'd peer to
 264  * a NAT'd one to inform it we got the probe and of the
 265  * address/port seen
 266  */
 267 #define GNUNET_MESSAGE_TYPE_TRANSPORT_UDP_NAT_PROBE_REPLY 56
 268
 269 /**
 270  * UDP NAT probe confirmation, sent from a NAT'd peer to
 271  * a non-NAT'd one to inform it which port to send to us
 272  * on
 273  */
 274 #define GNUNET_MESSAGE_TYPE_TRANSPORT_UDP_NAT_PROBE_CONFIRM 57
 275
 276 /**
 277  * UDP NAT probe keepalive, once a hole is punched the NAT'd peer
 278  * needs to keep the hole alive
 279  */
 280 #define GNUNET_MESSAGE_TYPE_TRANSPORT_UDP_NAT_PROBE_KEEPALIVE 58
 281
 282 /**
 283  * Welcome message between TCP transports.
 284  */
 285 #define GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME 60
 286
 287 /**
 288  * Initial setup message from core client to core.
 289  */
 290 #define GNUNET_MESSAGE_TYPE_CORE_INIT 64
 291
 292 /**
 293  * Response from core to core client to INIT message.
 294  */
 295 #define GNUNET_MESSAGE_TYPE_CORE_INIT_REPLY 65
 296
 297 /**
 298  * Notify clients about new peer-to-peer connections (before
 299  * key exchange and authentication).
 300  */
 301 #define GNUNET_MESSAGE_TYPE_CORE_NOTIFY_PRE_CONNECT 66
 302
 303 /**
 304  * Notify clients about new peer-to-peer connections (triggered
 305  * after key exchange).
 306  */
 307 #define GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT 67
 308
 309 /**
 310  * Notify clients about peer disconnecting.
 311  */
 312 #define GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT 68
 313
 314 /**
 315  * Notify clients about incoming P2P messages.
 316  */
 317 #define GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND 69
 318
 319 /**
 320  * Notify clients about outgoing P2P transmissions.
 321  */
 322 #define GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND 70
 323
 324 /**
 325  * Request from client to "configure" P2P connection.
 326  */
 327 #define GNUNET_MESSAGE_TYPE_CORE_REQUEST_INFO 71
 328
 329 /**
 330  * Response from server about (possibly updated) P2P
 331  * connection configuration.
 332  */
 333 #define GNUNET_MESSAGE_TYPE_CORE_CONFIGURATION_INFO 72
 334
 335 /**
 336  * Request from client with message to transmit.
 337  */
 338 #define GNUNET_MESSAGE_TYPE_CORE_SEND 73
 339
 340 /**
 341  * Request from client asking to connect to a peer.
 342  */
 343 #define GNUNET_MESSAGE_TYPE_CORE_REQUEST_CONNECT 74
 344
 345
 346 /**
 347  * Session key exchange between peers.
 348  */
 349 #define GNUNET_MESSAGE_TYPE_CORE_SET_KEY 80
 350
 351 /**
 352  * Encapsulation for an encrypted message between peers.
 353  */
 354 #define GNUNET_MESSAGE_TYPE_CORE_ENCRYPTED_MESSAGE 81
 355
 356 /**
 357  * Check that other peer is alive (challenge).
 358  */
 359 #define GNUNET_MESSAGE_TYPE_CORE_PING 82
 360
 361 /**
 362  * Confirmation that other peer is alive.
 363  */
 364 #define GNUNET_MESSAGE_TYPE_CORE_PONG 83
 365
 366 /**
 367  * Request by the other peer to terminate the connection.
 368  */
 369 #define GNUNET_MESSAGE_TYPE_CORE_HANGUP 84
 370
 371 /**
 372  * Message sent by datastore client on join.
 373  */
 374 #define GNUNET_MESSAGE_TYPE_DATASTORE_RESERVE 92
 375
 376 /**
 377  * Message sent by datastore client on join.
 378  */
 379 #define GNUNET_MESSAGE_TYPE_DATASTORE_RELEASE_RESERVE 93
 380
 381 /**
 382  * Message sent by datastore to client informing about status
 383  * processing a request
 384  * (in response to RESERVE, RELEASE_RESERVE, PUT, UPDATE and REMOVE requests).
 385  */
 386 #define GNUNET_MESSAGE_TYPE_DATASTORE_STATUS 94
 387
 388 /**
 389  * Message sent by datastore client to store data.
 390  */
 391 #define GNUNET_MESSAGE_TYPE_DATASTORE_PUT 95
 392
 393 /**
 394  * Message sent by datastore client to update data.
 395  */
 396 #define GNUNET_MESSAGE_TYPE_DATASTORE_UPDATE 96
 397
 398 /**
 399  * Message sent by datastore client to get data.
 400  */
 401 #define GNUNET_MESSAGE_TYPE_DATASTORE_GET 97
 402
 403 /**
 404  * Message sent by datastore client to get random data.
 405  */
 406 #define GNUNET_MESSAGE_TYPE_DATASTORE_GET_RANDOM 98
 407
 408 /**
 409  * Message sent by datastore to client providing requested data
 410  * (in response to GET or GET_RANDOM request).
 411  */
 412 #define GNUNET_MESSAGE_TYPE_DATASTORE_DATA 99
 413
 414 /**
 415  * Message sent by datastore to client signaling end of matching data.
 416  * This message will also be sent for "GET_RANDOM", even though
 417  * "GET_RANDOM" returns at most one data item.
 418  */
 419 #define GNUNET_MESSAGE_TYPE_DATASTORE_DATA_END 100
 420
 421 /**
 422  * Message sent by datastore client to remove data.
 423  */
 424 #define GNUNET_MESSAGE_TYPE_DATASTORE_REMOVE 101
 425
 426 /**
 427  * Message sent by datastore client to drop the database.
 428  */
 429 #define GNUNET_MESSAGE_TYPE_DATASTORE_DROP 102
 430
 431
 432 /**
 433  * Message sent by fs client to start indexing.
 434  */
 435 #define GNUNET_MESSAGE_TYPE_FS_INDEX_START 128
 436
 437 /**
 438  * Affirmative response to a request for start indexing.
 439  */
 440 #define GNUNET_MESSAGE_TYPE_FS_INDEX_START_OK 129
 441
 442 /**
 443  * Response to a request for start indexing that
 444  * refuses.
 445  */
 446 #define GNUNET_MESSAGE_TYPE_FS_INDEX_START_FAILED 130
 447
 448 /**
 449  * Request from client for list of indexed files.
 450  */
 451 #define GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_GET 131
 452
 453 /**
 454  * Reply to client with an indexed file name.
 455  */
 456 #define GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_ENTRY 132
 457
 458 /**
 459  * Reply to client indicating end of list.
 460  */
 461 #define GNUNET_MESSAGE_TYPE_FS_INDEX_LIST_END 133
 462
 463 /**
 464  * Request from client to unindex a file.
 465  */
 466 #define GNUNET_MESSAGE_TYPE_FS_UNINDEX 134
 467
 468 /**
 469  * Reply to client indicating unindex receipt.
 470  */
 471 #define GNUNET_MESSAGE_TYPE_FS_UNINDEX_OK 135
 472
 473 /**
 474  * Client asks FS service to start a (keyword) search.
 475  */
 476 #define GNUNET_MESSAGE_TYPE_FS_START_SEARCH 136
 477
 478 /**
 479  * P2P request for content (one FS to another).
 480  */
 481 #define GNUNET_MESSAGE_TYPE_FS_GET 137
 482
 483 /**
 484  * P2P response with content or active migration of content.  Also
 485  * used between the service and clients (in response to START_SEARCH).
 486  */
 487 #define GNUNET_MESSAGE_TYPE_FS_PUT 138
 488
 489
 490 /**
 491  * DHT Message Types
 492  */
 493
 494 /**
 495  * Local and P2P generic DHT message start type
 496  */
 497 #define GNUNET_MESSAGE_TYPE_DHT 142
 498
 499 /**
 500  * Local and P2P generic DHT message stop type
 501  */
 502 #define GNUNET_MESSAGE_TYPE_DHT_STOP 143
 503
 504 /**
 505  * Local and message acknowledgment
 506  */
 507 #define GNUNET_MESSAGE_TYPE_DHT_ACK 144
 508
 509 /**
 510  * Local DHT Put message, from API to service
 511  */
 512 #define GNUNET_MESSAGE_TYPE_DHT_PUT 145
 513
 514 /**
 515  * Local DHT Get message, from API to service
 516  */
 517 #define GNUNET_MESSAGE_TYPE_DHT_GET 146
 518
 519 /**
 520  * Local DHT Get stop message, from API to service
 521  */
 522 #define GNUNET_MESSAGE_TYPE_DHT_GET_STOP 147
 523
 524 /**
 525  * Local DHT Get result message, from service to API
 526  */
 527 #define GNUNET_MESSAGE_TYPE_DHT_GET_RESULT 148
 528
 529 /**
 530  * Local DHT Get message, from API to service
 531  */
 532 #define GNUNET_MESSAGE_TYPE_DHT_FIND_PEER 150
 533
 534 /**
 535  * Local DHT Get stop message, from API to service
 536  */
 537 #define GNUNET_MESSAGE_TYPE_DHT_FIND_PEER_STOP 151
 538
 539 /**
 540  * Local DHT find peer result message, from service to API
 541  */
 542 #define GNUNET_MESSAGE_TYPE_DHT_FIND_PEER_RESULT 152
 543
 544 /**
 545  * Hostlist advertisement message
 546  */
 547 #define GNUNET_MESSAGE_TYPE_HOSTLIST_ADVERTISEMENT 160
 548
 549 /**
 550  * Type used to match 'all' message types.
 551  */
 552 #define GNUNET_MESSAGE_TYPE_ALL 65535
 553
 554 /*
 555   TODO:
 556   - DV
 557   - DHT
 558   - applications (FS, VPN, CHAT, TRACEKIT, TBENCH)
 559 */
 560
 561
 562 #if 0                           /* keep Emacsens' auto-indent happy */
 563 {
 564 #endif
 565 #ifdef __cplusplus
 566 }
 567 #endif
 568
 569 /* ifndef GNUNET_PROTOCOLS_H */
 570 #endif
 571 /* end of gnunet_protocols.h */