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