src/include/gnunet_transport_service.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010, 2011 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 3, 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_transport_service.h
  23  * @brief low-level P2P IO
  24  * @author Christian Grothoff
  25  */
  26
  27 #ifndef GNUNET_TRANSPORT_SERVICE_H
  28 #define GNUNET_TRANSPORT_SERVICE_H
  29
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #if 0                           /* keep Emacsens' auto-indent happy */
  34 }
  35 #endif
  36 #endif
  37
  38 #include "gnunet_util_lib.h"
  39 #include "gnunet_ats_service.h"
  40
  41 /**
  42  * Version number of the transport API.
  43  */
  44 #define GNUNET_TRANSPORT_VERSION 0x00000000
  45
  46
  47 /**
  48  * Possible state of a neighbour.  Initially, we are #S_NOT_CONNECTED.
  49  *
  50  * Then, there are two main paths. If we receive a CONNECT message, we
  51  * first run a check against the blacklist (#S_CONNECT_RECV_BLACKLIST_INBOUND).
  52  * If this check is successful, we give the inbound address to ATS.
  53  * After the check we ask ATS for a suggestion (S_CONNECT_RECV_ATS).
  54  * If ATS makes a suggestion, we ALSO give that suggestion to the blacklist
  55  * (#S_CONNECT_RECV_BLACKLIST).  Once the blacklist approves the
  56  * address we got from ATS, we send our CONNECT_ACK and go to
  57  * #S_CONNECT_RECV_ACK.  If we receive a SESSION_ACK, we go to
  58  * #S_CONNECTED (and notify everyone about the new connection).  If the
  59  * operation times out, we go to #S_DISCONNECT.
  60  *
  61  * The other case is where we transmit a CONNECT message first.  We
  62  * start with #S_INIT_ATS.  If we get an address, we enter
  63  * #S_INIT_BLACKLIST and check the blacklist.  If the blacklist is OK
  64  * with the connection, we actually send the CONNECT message and go to
  65  * state S_CONNECT_SENT.  Once we receive a CONNECT_ACK, we go to
  66  * #S_CONNECTED (and notify everyone about the new connection and send
  67  * back a SESSION_ACK).  If the operation times out, we go to
  68  * #S_DISCONNECT.
  69  *
  70  * If the session is in trouble (i.e. transport-level disconnect or
  71  * timeout), we go to #S_RECONNECT_ATS where we ask ATS for a new
  72  * address (we don't notify anyone about the disconnect yet).  Once we
  73  * have a new address, we go to #S_RECONNECT_BLACKLIST to check the new
  74  * address against the blacklist.  If the blacklist approves, we enter
  75  * #S_RECONNECT_SENT and send a CONNECT message.  If we receive a
  76  * CONNECT_ACK, we go to #S_CONNECTED and nobody noticed that we had
  77  * trouble; we also send a SESSION_ACK at this time just in case.  If
  78  * the operation times out, we go to S_DISCONNECT (and notify everyone
  79  * about the lost connection).
  80  *
  81  * If ATS decides to switch addresses while we have a normal
  82  * connection, we go to #S_CONNECTED_SWITCHING_BLACKLIST to check the
  83  * new address against the blacklist.  If the blacklist approves, we
  84  * go to #S_CONNECTED_SWITCHING_CONNECT_SENT and send a
  85  * SESSION_CONNECT.  If we get a SESSION_ACK back, we switch the
  86  * primary connection to the suggested alternative from ATS, go back
  87  * to #S_CONNECTED and send a SESSION_ACK to the other peer just to be
  88  * sure.  If the operation times out (or the blacklist disapproves),
  89  * we go to #S_CONNECTED (and notify ATS that the given alternative
  90  * address is "invalid").
  91  *
  92  * Once a session is in #S_DISCONNECT, it is cleaned up and then goes
  93  * to (#S_DISCONNECT_FINISHED).  If we receive an explicit disconnect
  94  * request, we can go from any state to #S_DISCONNECT, possibly after
  95  * generating disconnect notifications.
  96  *
  97  * Note that it is quite possible that while we are in any of these
  98  * states, we could receive a 'CONNECT' request from the other peer.
  99  * We then enter a 'weird' state where we pursue our own primary state
 100  * machine (as described above), but with the 'send_connect_ack' flag
 101  * set to 1.  If our state machine allows us to send a 'CONNECT_ACK'
 102  * (because we have an acceptable address), we send the 'CONNECT_ACK'
 103  * and set the 'send_connect_ack' to 2.  If we then receive a
 104  * 'SESSION_ACK', we go to #S_CONNECTED (and reset 'send_connect_ack'
 105  * to 0).
 106  *
 107  */
 108 enum GNUNET_TRANSPORT_PeerState
 109 {
 110   /**
 111    * fresh peer or completely disconnected
 112    */
 113   GNUNET_TRANSPORT_NOT_CONNECTED = 0,
 114
 115   /**
 116    * Asked to initiate connection, trying to get address from ATS
 117    */
 118   GNUNET_TRANSPORT_INIT_ATS,
 119
 120   /**
 121    * Asked to initiate connection, trying to get address approved
 122    * by blacklist.
 123    */
 124   GNUNET_TRANSPORT_INIT_BLACKLIST,
 125
 126   /**
 127    * Sent CONNECT message to other peer, waiting for CONNECT_ACK
 128    */
 129   GNUNET_TRANSPORT_CONNECT_SENT,
 130
 131   /**
 132    * Received a CONNECT, do a blacklist check for inbound address
 133    */
 134   GNUNET_TRANSPORT_CONNECT_RECV_BLACKLIST_INBOUND,
 135
 136   /**
 137    * Received a CONNECT, asking ATS about address suggestions.
 138    */
 139   GNUNET_TRANSPORT_CONNECT_RECV_ATS,
 140
 141   /**
 142    * Received CONNECT from other peer, got an address, checking with blacklist.
 143    */
 144   GNUNET_TRANSPORT_CONNECT_RECV_BLACKLIST,
 145
 146   /**
 147    * CONNECT request from other peer was SESSION_ACK'ed, waiting for
 148    * SESSION_ACK.
 149    */
 150   GNUNET_TRANSPORT_CONNECT_RECV_ACK,
 151
 152   /**
 153    * Got our CONNECT_ACK/SESSION_ACK, connection is up.
 154    */
 155   GNUNET_TRANSPORT_CONNECTED,
 156
 157   /**
 158    * Connection got into trouble, rest of the system still believes
 159    * it to be up, but we're getting a new address from ATS.
 160    */
 161   GNUNET_TRANSPORT_RECONNECT_ATS,
 162
 163   /**
 164    * Connection got into trouble, rest of the system still believes
 165    * it to be up; we are checking the new address against the blacklist.
 166    */
 167   GNUNET_TRANSPORT_RECONNECT_BLACKLIST,
 168
 169   /**
 170    * Sent CONNECT over new address (either by ATS telling us to switch
 171    * addresses or from RECONNECT_ATS); if this fails, we need to tell
 172    * the rest of the system about a disconnect.
 173    */
 174   GNUNET_TRANSPORT_RECONNECT_SENT,
 175
 176   /**
 177    * We have some primary connection, but ATS suggested we switch
 178    * to some alternative; we're now checking the alternative against
 179    * the blacklist.
 180    */
 181   GNUNET_TRANSPORT_CONNECTED_SWITCHING_BLACKLIST,
 182
 183   /**
 184    * We have some primary connection, but ATS suggested we switch
 185    * to some alternative; we now sent a CONNECT message for the
 186    * alternative session to the other peer and waiting for a
 187    * CONNECT_ACK to make this our primary connection.
 188    */
 189   GNUNET_TRANSPORT_CONNECTED_SWITCHING_CONNECT_SENT,
 190
 191   /**
 192    * Disconnect in progress (we're sending the DISCONNECT message to the
 193    * other peer; after that is finished, the state will be cleaned up).
 194    */
 195   GNUNET_TRANSPORT_DISCONNECT,
 196
 197   /**
 198    * We're finished with the disconnect; and are cleaning up the state
 199    * now!  We put the struct into this state when we are really in the
 200    * task that calls 'free' on it and are about to remove the record
 201    * from the map.  We should never find a 'struct NeighbourMapEntry'
 202    * in this state in the map.  Accessing a 'struct NeighbourMapEntry'
 203    * in this state virtually always means using memory that has been
 204    * freed (the exception being the cleanup code in #free_neighbour()).
 205    */
 206   GNUNET_TRANSPORT_DISCONNECT_FINISHED
 207 };
 208
 209
 210
 211 /**
 212  * Function called by the transport for each received message.
 213  *
 214  * @param cls closure
 215  * @param peer (claimed) identity of the other peer
 216  * @param message the message
 217  * @param ats performance data
 218  * @param ats_count number of entries in ats
 219  */
 220 typedef void (*GNUNET_TRANSPORT_ReceiveCallback) (void *cls,
 221                                                   const struct
 222                                                   GNUNET_PeerIdentity * peer,
 223                                                   const struct
 224                                                   GNUNET_MessageHeader *
 225                                                   message);
 226
 227
 228 /**
 229  * Opaque handle to the service.
 230  */
 231 struct GNUNET_TRANSPORT_Handle;
 232
 233
 234 /**
 235  * Function called to notify transport users that another
 236  * peer connected to us.
 237  *
 238  * @param cls closure
 239  * @param peer the peer that connected
 240  * @param ats performance data
 241  * @param ats_count number of entries in ats (excluding 0-termination)
 242  */
 243 typedef void (*GNUNET_TRANSPORT_NotifyConnect) (void *cls,
 244                                                 const struct GNUNET_PeerIdentity
 245                                                 * peer);
 246
 247 /**
 248  * Function called to notify transport users that another
 249  * peer disconnected from us.
 250  *
 251  * @param cls closure
 252  * @param peer the peer that disconnected
 253  */
 254 typedef void (*GNUNET_TRANSPORT_NotifyDisconnect) (void *cls,
 255                                                    const struct
 256                                                    GNUNET_PeerIdentity * peer);
 257
 258
 259 /**
 260  * Function to call with result of the try connect request.
 261  *
 262  *
 263  * @param cls closure
 264  * @param result GNUNET_OK if message was transmitted to transport service
 265  *               GNUNET_SYSERR if message was not transmitted to transport service
 266  */
 267 typedef void (*GNUNET_TRANSPORT_TryConnectCallback) (void *cls,
 268                                                      const int result);
 269
 270
 271 /**
 272  * Function to call with a textual representation of an address.
 273  * This function will be called several times with different possible
 274  * textual representations, and a last time with NULL to signal the end
 275  * of the iteration.
 276  *
 277  * @param cls closure
 278  * @param address NULL on error or end of iteration,
 279  *        otherwise 0-terminated printable UTF-8 string
 280  */
 281 typedef void (*GNUNET_TRANSPORT_AddressToStringCallback) (void *cls,
 282                                                           const char *address);
 283
 284
 285 /**
 286  * Function to call with information about a peer
 287  *
 288  * The #GNUNET_TRANSPORT_monitor_peers_cancel call MUST not be called from
 289  * within this function!
 290  *
 291  * @param cls closure
 292  * @param peer peer this update is about,
 293  *      NULL if this is the final last callback for a iteration operation
 294  * @param address address, NULL for disconnect notification in monitor mode
 295  * @param state current state this peer is in
 296  * @param state_timeout timeout for the current state of the peer
 297  */
 298 typedef void (*GNUNET_TRANSPORT_PeerIterateCallback) (void *cls,
 299                                     const struct GNUNET_PeerIdentity *peer,
 300                                     const struct GNUNET_HELLO_Address *address,
 301                                     enum GNUNET_TRANSPORT_PeerState state,
 302                                     struct GNUNET_TIME_Absolute state_timeout);
 303
 304
 305 /**
 306  * Function to call with validation information about a peer
 307  *
 308  * @param cls closure
 309  * @param peer peer this update is about,
 310  *      NULL if this is the final last callback for a iteration operation
 311  * @param address address, NULL for disconnect notification in monitor mode
 312  * @param valid_until when does this address expire
 313  * @param next_validation time of the next validation operation
 314  *
 315  */
 316 typedef void (*GNUNET_TRANSPORT_ValidationIterateCallback) (void *cls,
 317                                     const struct GNUNET_PeerIdentity *peer,
 318                                     const struct GNUNET_HELLO_Address *address,
 319                                     struct GNUNET_TIME_Absolute valid_until,
 320                                     struct GNUNET_TIME_Absolute next_validation);
 321
 322
 323
 324 /**
 325  * Connect to the transport service.  Note that the connection may
 326  * complete (or fail) asynchronously.
 327  *
 328  * @param cfg configuration to use
 329  * @param self our own identity (API should check that it matches
 330  *             the identity found by transport), or NULL (no check)
 331  * @param cls closure for the callbacks
 332  * @param rec receive function to call, or NULL
 333  * @param nc function to call on connect events, or NULL
 334  * @param nd function to call on disconnect events, or NULL
 335  * @return NULL on error
 336  */
 337 struct GNUNET_TRANSPORT_Handle *
 338 GNUNET_TRANSPORT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 339                           const struct GNUNET_PeerIdentity *self, void *cls,
 340                           GNUNET_TRANSPORT_ReceiveCallback rec,
 341                           GNUNET_TRANSPORT_NotifyConnect nc,
 342                           GNUNET_TRANSPORT_NotifyDisconnect nd);
 343
 344
 345 /**
 346  * Disconnect from the transport service.
 347  *
 348  * @param handle handle returned from connect
 349  */
 350 void
 351 GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle);
 352
 353
 354 /**
 355  * Opaque handle for a transmission-ready request.
 356  */
 357 struct GNUNET_TRANSPORT_TryConnectHandle;
 358
 359
 360 /**
 361  * Ask the transport service to establish a connection to
 362  * the given peer.
 363  *
 364  * @param handle connection to transport service
 365  * @param target who we should try to connect to
 366  * @param cb callback to be called when request was transmitted to transport
 367  *         service
 368  * @param cb_cls closure for the callback
 369  * @return a GNUNET_TRANSPORT_TryConnectHandle handle or
 370  *         NULL on failure (cb will not be called)
 371  */
 372 struct GNUNET_TRANSPORT_TryConnectHandle *
 373 GNUNET_TRANSPORT_try_connect (struct GNUNET_TRANSPORT_Handle *handle,
 374                               const struct GNUNET_PeerIdentity *target,
 375                               GNUNET_TRANSPORT_TryConnectCallback cb,
 376                               void *cb_cls);
 377
 378
 379 /**
 380  * Cancel the request to transport to try a connect
 381  * Callback will not be called
 382  *
 383  * @param tch GNUNET_TRANSPORT_TryConnectHandle handle to cancel
 384  */
 385 void
 386 GNUNET_TRANSPORT_try_connect_cancel (struct GNUNET_TRANSPORT_TryConnectHandle *tch);
 387
 388
 389 /**
 390  * Opaque handle for a transmission-ready request.
 391  */
 392 struct GNUNET_TRANSPORT_TransmitHandle;
 393
 394
 395 /**
 396  * Check if we could queue a message of the given size for
 397  * transmission.  The transport service will take both its internal
 398  * buffers and bandwidth limits imposed by the other peer into
 399  * consideration when answering this query.
 400  *
 401  * @param handle connection to transport service
 402  * @param target who should receive the message
 403  * @param size how big is the message we want to transmit?
 404  * @param priority how important is the message? @deprecated - remove?
 405  * @param timeout after how long should we give up (and call
 406  *        notify with buf NULL and size 0)?
 407  * @param notify function to call when we are ready to
 408  *        send such a message
 409  * @param notify_cls closure for notify
 410  * @return NULL if someone else is already waiting to be notified
 411  *         non-NULL if the notify callback was queued (can be used to cancel
 412  *         using GNUNET_TRANSPORT_notify_transmit_ready_cancel)
 413  */
 414 struct GNUNET_TRANSPORT_TransmitHandle *
 415 GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle *handle,
 416                                         const struct GNUNET_PeerIdentity
 417                                         *target, size_t size, uint32_t priority,
 418                                         struct GNUNET_TIME_Relative timeout,
 419                                         GNUNET_CONNECTION_TransmitReadyNotify
 420                                         notify, void *notify_cls);
 421
 422
 423 /**
 424  * Cancel the specified transmission-ready notification.
 425  *
 426  * @param th handle of the transmission notification request to cancel
 427  */
 428 void
 429 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct
 430                                                GNUNET_TRANSPORT_TransmitHandle
 431                                                *th);
 432
 433
 434
 435 /**
 436  * Function called whenever there is an update to the
 437  * HELLO of this peer.
 438  *
 439  * @param cls closure
 440  * @param hello our updated HELLO
 441  */
 442 typedef void (*GNUNET_TRANSPORT_HelloUpdateCallback) (void *cls,
 443                                                       const struct
 444                                                       GNUNET_MessageHeader *
 445                                                       hello);
 446
 447
 448 /**
 449  * Handle to cancel a 'GNUNET_TRANSPORT_get_hello' operation.
 450  */
 451 struct GNUNET_TRANSPORT_GetHelloHandle;
 452
 453
 454 /**
 455  * Checks if a given peer is connected to us
 456  *
 457  * @param handle connection to transport service
 458  * @param peer the peer to check
 459  * @return #GNUNET_YES (connected) or #GNUNET_NO (disconnected)
 460  */
 461 int
 462 GNUNET_TRANSPORT_check_peer_connected (struct GNUNET_TRANSPORT_Handle *handle,
 463                                             const struct GNUNET_PeerIdentity *peer);
 464
 465
 466 /**
 467  * Set transport metrics for a peer and a direction
 468  *
 469  * @param handle transport handle
 470  * @param peer the peer to set the metric for
 471  * @param inbound set inbound direction (GNUNET_YES or GNUNET_NO)
 472  * @param outbound set outbound direction (GNUNET_YES or GNUNET_NO)
 473  * @param ats the metric as ATS information
 474  * @param ats_count the number of metrics
 475  *
 476  * Supported ATS values:
 477  * GNUNET_ATS_QUALITY_NET_DELAY  (value in ms)
 478  * GNUNET_ATS_QUALITY_NET_DISTANCE (value in count(hops))
 479  *
 480  * Example
 481  * To enforce a delay of 10 ms for peer p1 in sending direction use:
 482  *
 483  * struct GNUNET_ATS_Information ats;
 484  * ats.type = ntohl (GNUNET_ATS_QUALITY_NET_DELAY);
 485  * ats.value = ntohl (10);
 486  * GNUNET_TRANSPORT_set_traffic_metric (th, p1, TM_SEND, &ats, 1);
 487  *
 488  * Note:
 489  * Delay restrictions in receiving direction will be enforced with
 490  * 1 message delay.
 491  */
 492 void
 493 GNUNET_TRANSPORT_set_traffic_metric (struct GNUNET_TRANSPORT_Handle *handle,
 494                                      const struct GNUNET_PeerIdentity *peer,
 495                                      int inbound,
 496                                      int outbound,
 497                                      const struct GNUNET_ATS_Information *ats,
 498                                      size_t ats_count);
 499
 500
 501 /**
 502  * Obtain updates on changes to the HELLO message for this peer. The callback
 503  * given in this function is never called synchronously.
 504  *
 505  * @param handle connection to transport service
 506  * @param rec function to call with the HELLO
 507  * @param rec_cls closure for rec
 508  * @return handle to cancel the operation
 509  */
 510 struct GNUNET_TRANSPORT_GetHelloHandle *
 511 GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
 512                             GNUNET_TRANSPORT_HelloUpdateCallback rec,
 513                             void *rec_cls);
 514
 515
 516 /**
 517  * Stop receiving updates about changes to our HELLO message.
 518  *
 519  * @param ghh handle to cancel
 520  */
 521 void
 522 GNUNET_TRANSPORT_get_hello_cancel (struct GNUNET_TRANSPORT_GetHelloHandle *ghh);
 523
 524
 525 /**
 526  * Offer the transport service the HELLO of another peer.  Note that
 527  * the transport service may just ignore this message if the HELLO is
 528  * malformed or useless due to our local configuration.
 529  *
 530  * @param handle connection to transport service
 531  * @param hello the hello message
 532  * @param cont continuation to call when HELLO has been sent,
 533  *      tc reason GNUNET_SCHEDULER_REASON_TIMEOUT for fail
 534  *      tc reasong GNUNET_SCHEDULER_REASON_READ_READY for success
 535  * @param cls closure for continuation
 536  * @return a GNUNET_TRANSPORT_OfferHelloHandle handle or NULL on failure,
 537  *      in case of failure cont will not be called
 538  *
 539  */
 540 struct GNUNET_TRANSPORT_OfferHelloHandle *
 541 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
 542                               const struct GNUNET_MessageHeader *hello,
 543                               GNUNET_SCHEDULER_Task cont, void *cls);
 544
 545
 546 /**
 547  * Cancel the request to transport to offer the HELLO message
 548  *
 549  * @param ohh the GNUNET_TRANSPORT_OfferHelloHandle to cancel
 550  */
 551 void
 552 GNUNET_TRANSPORT_offer_hello_cancel (struct GNUNET_TRANSPORT_OfferHelloHandle *ohh);
 553
 554
 555 /**
 556  * Handle to cancel a pending address lookup.
 557  */
 558 struct GNUNET_TRANSPORT_AddressToStringContext;
 559
 560
 561 /**
 562  * Convert a binary address into a human readable address.
 563  *
 564  * @param cfg configuration to use
 565  * @param address address to convert (binary format)
 566  * @param numeric should (IP) addresses be displayed in numeric form
 567  *                (otherwise do reverse DNS lookup)
 568  * @param timeout how long is the lookup allowed to take at most
 569  * @param aluc function to call with the results
 570  * @param aluc_cls closure for aluc
 571  * @return handle to cancel the operation, NULL on error
 572  */
 573 struct GNUNET_TRANSPORT_AddressToStringContext *
 574 GNUNET_TRANSPORT_address_to_string (const struct GNUNET_CONFIGURATION_Handle
 575                                     *cfg,
 576                                     const struct GNUNET_HELLO_Address *address,
 577                                     int numeric,
 578                                     struct GNUNET_TIME_Relative timeout,
 579                                     GNUNET_TRANSPORT_AddressToStringCallback
 580                                     aluc, void *aluc_cls);
 581
 582
 583 /**
 584  * Cancel request for address conversion.
 585  *
 586  * @param pic the context handle
 587  */
 588 void
 589 GNUNET_TRANSPORT_address_to_string_cancel (struct
 590                                            GNUNET_TRANSPORT_AddressToStringContext
 591                                            *pic);
 592
 593 /**
 594  * Convert a transport state to a human readable string.
 595  *
 596  * @param state the state
 597  */
 598 const char *
 599 GNUNET_TRANSPORT_p2s (enum GNUNET_TRANSPORT_PeerState state);
 600
 601
 602 /**
 603  * Check if a state is defined as connected
 604  *
 605  * @param state the state value
 606  * @return GNUNET_YES or GNUNET_NO
 607  */
 608 int
 609 GNUNET_TRANSPORT_is_connected (enum GNUNET_TRANSPORT_PeerState state);
 610
 611
 612 /**
 613  * Return information about a specific peer or all peers currently known to
 614  * transport service once or in monitoring mode. To obtain information about
 615  * a specific peer, a peer identity can be passed. To obtain information about
 616  * all peers currently known to transport service, NULL can be passed as peer
 617  * identity.
 618  *
 619  * For each peer, the callback is called with information about the address used
 620  * to communicate with this peer, the state this peer is currently in and the
 621  * the current timeout for this state.
 622  *
 623  * Upon completion, the 'GNUNET_TRANSPORT_PeerIterateCallback' is called one
 624  * more time with 'NULL'. After this, the operation must no longer be
 625  * explicitly canceled.
 626  *
 627  * The #GNUNET_TRANSPORT_monitor_peers_cancel call MUST not be called in the
 628  * the peer_callback!
 629  *
 630  * @param cfg configuration to use
 631  * @param peer a specific peer identity to obtain information for,
 632  *      NULL for all peers
 633  * @param one_shot GNUNET_YES to return the current state and then end (with NULL+NULL),
 634  *                 GNUNET_NO to monitor peers continuously
 635  * @param timeout how long is the lookup allowed to take at most
 636  * @param peer_callback function to call with the results
 637  * @param peer_callback_cls closure for peer_address_callback
 638  */
 639 struct GNUNET_TRANSPORT_PeerMonitoringContext *
 640 GNUNET_TRANSPORT_monitor_peers (const struct
 641                                 GNUNET_CONFIGURATION_Handle *cfg,
 642                                 const struct GNUNET_PeerIdentity *peer,
 643                                 int one_shot,
 644                                 struct GNUNET_TIME_Relative timeout,
 645                                 GNUNET_TRANSPORT_PeerIterateCallback peer_callback,
 646                                 void *peer_callback_cls);
 647
 648
 649 /**
 650  * Cancel request to monitor peers
 651  *
 652  * @param pic handle for the request to cancel
 653  */
 654 void
 655 GNUNET_TRANSPORT_monitor_peers_cancel (struct GNUNET_TRANSPORT_PeerMonitoringContext *pic);
 656
 657
 658
 659 /**
 660  * Return information about pending address validation operations for a specific
 661  * or all peers
 662  *
 663  * @param cfg configuration to use
 664  * @param peer a specific peer identity to obtain validation entries for,
 665  *      NULL for all peers
 666  * @param one_shot GNUNET_YES to return all entries and then end (with NULL+NULL),
 667  *                 GNUNET_NO to monitor validation entries continuously
 668  * @param timeout how long is the lookup allowed to take at most
 669  * @param validation_callback function to call with the results
 670  * @param validation_callback_cls closure for peer_address_callback
 671  */
 672 struct GNUNET_TRANSPORT_ValidationMonitoringContext *
 673 GNUNET_TRANSPORT_monitor_validation_entries (const struct
 674                                 GNUNET_CONFIGURATION_Handle *cfg,
 675                                 const struct GNUNET_PeerIdentity *peer,
 676                                 int one_shot,
 677                                 struct GNUNET_TIME_Relative timeout,
 678                                 GNUNET_TRANSPORT_ValidationIterateCallback validation_callback,
 679                                 void *validation_callback_cls);
 680
 681
 682 /**
 683  * Return information about all current pending validation operations
 684  *
 685  * @param vic handle for the request to cancel
 686  */
 687 void
 688 GNUNET_TRANSPORT_monitor_validation_entries_cancel (struct GNUNET_TRANSPORT_ValidationMonitoringContext *vic);
 689
 690
 691
 692 /**
 693  * Handle for blacklisting peers.
 694  */
 695 struct GNUNET_TRANSPORT_Blacklist;
 696
 697
 698 /**
 699  * Function that decides if a connection is acceptable or not.
 700  *
 701  * @param cls closure
 702  * @param pid peer to approve or disapproave
 703  * @return GNUNET_OK if the connection is allowed, GNUNET_SYSERR if not
 704  */
 705 typedef int (*GNUNET_TRANSPORT_BlacklistCallback) (void *cls,
 706                                                    const struct
 707                                                    GNUNET_PeerIdentity * pid);
 708
 709
 710 /**
 711  * Install a blacklist callback.  The service will be queried for all
 712  * existing connections as well as any fresh connections to check if
 713  * they are permitted.  If the blacklisting callback is unregistered,
 714  * all hosts that were denied in the past will automatically be
 715  * whitelisted again.  Cancelling the blacklist handle is also the
 716  * only way to re-enable connections from peers that were previously
 717  * blacklisted.
 718  *
 719  * @param cfg configuration to use
 720  * @param cb callback to invoke to check if connections are allowed
 721  * @param cb_cls closure for cb
 722  * @return NULL on error, otherwise handle for cancellation
 723  */
 724 struct GNUNET_TRANSPORT_Blacklist *
 725 GNUNET_TRANSPORT_blacklist (const struct GNUNET_CONFIGURATION_Handle *cfg,
 726                             GNUNET_TRANSPORT_BlacklistCallback cb,
 727                             void *cb_cls);
 728
 729
 730 /**
 731  * Abort the blacklist.  Note that this function is the only way for
 732  * removing a peer from the blacklist.
 733  *
 734  * @param br handle of the request that is to be cancelled
 735  */
 736 void
 737 GNUNET_TRANSPORT_blacklist_cancel (struct GNUNET_TRANSPORT_Blacklist *br);
 738
 739
 740
 741 #if 0                           /* keep Emacsens' auto-indent happy */
 742 {
 743 #endif
 744 #ifdef __cplusplus
 745 }
 746 #endif
 747
 748 /* ifndef GNUNET_TRANSPORT_SERVICE_H */
 749 #endif
 750 /* end of gnunet_transport_service.h */