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