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