src/include/gnunet_transport_service.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009-2014 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 0x00000001
  45
  46
  47 /**
  48  * Possible state of a neighbour.  Initially, we are #GNUNET_TRANSPORT_PS_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 (#GNUNET_TRANSPORT_PS_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 (#GNUNET_TRANSPORT_PS_CONNECT_RECV_ATS).
  54  * If ATS makes a suggestion, we ALSO give that suggestion to the blacklist
  55  * (#GNUNET_TRANSPORT_PS_CONNECT_RECV_BLACKLIST).  Once the blacklist approves the
  56  * address we got from ATS, we send our CONNECT_ACK and go to
  57  * #GNUNET_TRANSPORT_PS_CONNECT_RECV_ACK.  If we receive a SESSION_ACK, we go to
  58  * #GNUNET_TRANSPORT_PS_CONNECTED (and notify everyone about the new connection).
  59  * If the operation times out, we go to #GNUNET_TRANSPORT_PS_DISCONNECT.
  60  *
  61  * The other case is where we transmit a CONNECT message first.  We
  62  * start with #GNUNET_TRANSPORT_PS_INIT_ATS.  If we get an address, we enter
  63  * #GNUNET_TRANSPORT_PS_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 #GNUNET_TRANSPORT_PS_CONNECT_SENT.  Once we receive a CONNECT_ACK, we go to
  66  * #GNUNET_TRANSPORT_PS_CONNECTED (and notify everyone about the new connection and send
  67  * back a SESSION_ACK).  If the operation times out, we go to
  68  * #GNUNET_TRANSPORT_PS_DISCONNECT.
  69  *
  70  * If the session is in trouble (i.e. transport-level disconnect or
  71  * timeout), we go to #GNUNET_TRANSPORT_PS_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 #GNUNET_TRANSPORT_PS_RECONNECT_BLACKLIST to check the new
  74  * address against the blacklist.  If the blacklist approves, we enter
  75  * #GNUNET_TRANSPORT_PS_RECONNECT_SENT and send a CONNECT message.  If we receive a
  76  * CONNECT_ACK, we go to #GNUNET_TRANSPORT_PS_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 #GNUNET_TRANSPORT_PS_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 #GNUNET_TRANSPORT_PS_CONNECTED_SWITCHING_BLACKLIST to check the
  83  * new address against the blacklist.  If the blacklist approves, we
  84  * go to #GNUNET_TRANSPORT_PS_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 #GNUNET_TRANSPORT_PS_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 #GNUNET_TRANSPORT_PS_CONNECTED (and notify ATS that the given alternative
  90  * address is "invalid").
  91  *
  92  * Once a session is in #GNUNET_TRANSPORT_PS_DISCONNECT, it is cleaned up and then goes
  93  * to (#GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED).  If we receive an explicit disconnect
  94  * request, we can go from any state to #GNUNET_TRANSPORT_PS_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 #GNUNET_TRANSPORT_PS_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_PS_NOT_CONNECTED = 0,
 114
 115   /**
 116    * Asked to initiate connection, trying to get address from ATS
 117    */
 118   GNUNET_TRANSPORT_PS_INIT_ATS,
 119
 120   /**
 121    * Asked to initiate connection, trying to get address approved
 122    * by blacklist.
 123    */
 124   GNUNET_TRANSPORT_PS_INIT_BLACKLIST,
 125
 126   /**
 127    * Sent CONNECT message to other peer, waiting for CONNECT_ACK
 128    */
 129   GNUNET_TRANSPORT_PS_CONNECT_SENT,
 130
 131   /**
 132    * Received a CONNECT, do a blacklist check for inbound address
 133    */
 134   GNUNET_TRANSPORT_PS_CONNECT_RECV_BLACKLIST_INBOUND,
 135
 136   /**
 137    * Received a CONNECT, asking ATS about address suggestions.
 138    */
 139   GNUNET_TRANSPORT_PS_CONNECT_RECV_ATS,
 140
 141   /**
 142    * Received CONNECT from other peer, got an address, checking with blacklist.
 143    */
 144   GNUNET_TRANSPORT_PS_CONNECT_RECV_BLACKLIST,
 145
 146   /**
 147    * CONNECT request from other peer was SESSION_ACK'ed, waiting for
 148    * SESSION_ACK.
 149    */
 150   GNUNET_TRANSPORT_PS_CONNECT_RECV_ACK,
 151
 152   /**
 153    * Got our CONNECT_ACK/SESSION_ACK, connection is up.
 154    */
 155   GNUNET_TRANSPORT_PS_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_PS_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_PS_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_PS_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_PS_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_PS_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_PS_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_PS_DISCONNECT_FINISHED
 207 };
 208
 209
 210 /**
 211  * Current state of a validation process
 212  */
 213 enum GNUNET_TRANSPORT_ValidationState
 214 {
 215   /**
 216    * Undefined state
 217    *
 218    * Used for final callback indicating operation done
 219    */
 220   GNUNET_TRANSPORT_VS_NONE,
 221
 222   /**
 223    * Fresh validation entry
 224    *
 225    * Entry was just created, no validation process was executed
 226    */
 227   GNUNET_TRANSPORT_VS_NEW,
 228
 229   /**
 230    * Updated validation entry
 231    *
 232    * This is an update for an existing validation entry
 233    */
 234   GNUNET_TRANSPORT_VS_UPDATE,
 235
 236   /**
 237    * Timeout for validation entry
 238    *
 239    * A timeout occured during the validation process
 240    */
 241   GNUNET_TRANSPORT_VS_TIMEOUT,
 242
 243   /**
 244    * Validation entry is removed
 245    *
 246    * The validation entry is getting removed due to a failed validation
 247    */
 248   GNUNET_TRANSPORT_VS_REMOVE
 249 };
 250
 251
 252 /**
 253  * Function called by the transport for each received message.
 254  *
 255  * @param cls closure
 256  * @param peer (claimed) identity of the other peer
 257  * @param message the message
 258  * @param ats performance data
 259  * @param ats_count number of entries in @a ats
 260  */
 261 typedef void
 262 (*GNUNET_TRANSPORT_ReceiveCallback) (void *cls,
 263                                      const struct GNUNET_PeerIdentity *peer,
 264                                      const struct GNUNET_MessageHeader *message);
 265
 266
 267 /**
 268  * Opaque handle to the service.
 269  */
 270 struct GNUNET_TRANSPORT_Handle;
 271
 272
 273 /**
 274  * Function called to notify transport users that another
 275  * peer connected to us.
 276  *
 277  * @param cls closure
 278  * @param peer the peer that connected
 279  * @param ats performance data
 280  * @param ats_count number of entries in @a ats (excluding 0-termination)
 281  */
 282 typedef void
 283 (*GNUNET_TRANSPORT_NotifyConnect) (void *cls,
 284                                    const struct GNUNET_PeerIdentity *peer);
 285
 286 /**
 287  * Function called to notify transport users that another
 288  * peer disconnected from us.
 289  *
 290  * @param cls closure
 291  * @param peer the peer that disconnected
 292  */
 293 typedef void
 294 (*GNUNET_TRANSPORT_NotifyDisconnect) (void *cls,
 295                                       const struct GNUNET_PeerIdentity *peer);
 296
 297
 298 /**
 299  * Function to call with result of the try connect request.
 300  *
 301  *
 302  * @param cls closure
 303  * @param result #GNUNET_OK if message was transmitted to transport service
 304  *               #GNUNET_SYSERR if message was not transmitted to transport service
 305  */
 306 typedef void
 307 (*GNUNET_TRANSPORT_TryConnectCallback) (void *cls,
 308                                         const int result);
 309
 310
 311 /**
 312  * Function to call with a textual representation of an address.
 313  * This function will be called several times with different possible
 314  * textual representations, and a last time with NULL to signal the end
 315  * of the iteration.
 316  *
 317  * @param cls closure
 318  * @param address NULL on error or end of iteration,
 319  *        otherwise 0-terminated printable UTF-8 string
 320  */
 321 typedef void
 322 (*GNUNET_TRANSPORT_AddressToStringCallback) (void *cls,
 323                                              const char *address);
 324
 325
 326 /**
 327  * Function to call with information about a peer
 328  *
 329  * If one_shot was set to #GNUNET_YES to iterate over all peers once,
 330  * a final call with NULL for peer and address will follow when done.
 331  * In this case state and timeout do not contain valid values.
 332  *
 333  * The #GNUNET_TRANSPORT_monitor_peers_cancel call MUST not be called from
 334  * within this function!
 335  *
 336  *
 337  * @param cls closure
 338  * @param peer peer this update is about,
 339  *      NULL if this is the final last callback for a iteration operation
 340  * @param address address, NULL for disconnect notification in monitor mode
 341  * @param state current state this peer is in
 342  * @param state_timeout timeout for the current state of the peer
 343  */
 344 typedef void
 345 (*GNUNET_TRANSPORT_PeerIterateCallback) (void *cls,
 346                                          const struct GNUNET_PeerIdentity *peer,
 347                                          const struct GNUNET_HELLO_Address *address,
 348                                          enum GNUNET_TRANSPORT_PeerState state,
 349                                          struct GNUNET_TIME_Absolute state_timeout);
 350
 351
 352 /**
 353  * Function to call with validation information about a peer
 354  *
 355  * This function is called by the transport validation monitoring api to
 356  * indicate a change to a validation entry. The information included represent
 357  * the current state of the validation entry,
 358  *
 359  * If the monitoring was called with one_shot=GNUNET_YES, a final callback
 360  * with peer==NULL and address==NULL is executed.
 361  *
 362  * @param cls closure
 363  * @param peer peer this update is about,
 364  *      NULL if this is the final last callback for a iteration operation
 365  * @param address address,
 366  *      NULL for disconnect notification in monitor mode
 367  * @param last_validation when was this address last validated
 368  * @param valid_until when does this address expire
 369  * @param next_validation time of the next validation operation
 370  * @param state state in the validation state machine
 371  */
 372 typedef void
 373 (*GNUNET_TRANSPORT_ValidationIterateCallback) (void *cls,
 374                                                const struct GNUNET_PeerIdentity *peer,
 375                                                const struct GNUNET_HELLO_Address *address,
 376                                                struct GNUNET_TIME_Absolute last_validation,
 377                                                struct GNUNET_TIME_Absolute valid_until,
 378                                                struct GNUNET_TIME_Absolute next_validation,
 379                                                enum GNUNET_TRANSPORT_ValidationState state);
 380
 381
 382 /**
 383  * Connect to the transport service.  Note that the connection may
 384  * complete (or fail) asynchronously.
 385  *
 386  * @param cfg configuration to use
 387  * @param self our own identity (API should check that it matches
 388  *             the identity found by transport), or NULL (no check)
 389  * @param cls closure for the callbacks
 390  * @param rec receive function to call, or NULL
 391  * @param nc function to call on connect events, or NULL
 392  * @param nd function to call on disconnect events, or NULL
 393  * @return NULL on error
 394  */
 395 struct GNUNET_TRANSPORT_Handle *
 396 GNUNET_TRANSPORT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 397                           const struct GNUNET_PeerIdentity *self,
 398                           void *cls,
 399                           GNUNET_TRANSPORT_ReceiveCallback rec,
 400                           GNUNET_TRANSPORT_NotifyConnect nc,
 401                           GNUNET_TRANSPORT_NotifyDisconnect nd);
 402
 403
 404 /**
 405  * Function called if we have "excess" bandwidth to a peer.
 406  * The notification will happen the first time we have excess
 407  * bandwidth, and then only again after the client has performed
 408  * some transmission to the peer.
 409  *
 410  * Excess bandwidth is defined as being allowed (by ATS) to send
 411  * more data, and us reaching the limit of the capacity build-up
 412  * (which, if we go past it, means we don't use available bandwidth).
 413  * See also the "max carry" in `struct GNUNET_BANDWIDTH_Tracker`.
 414  *
 415  * @param cls the closure
 416  * @param peer peer that we have excess bandwidth to
 417  */
 418 typedef void
 419 (*GNUNET_TRANSPORT_NotifyExcessBandwidth)(void *cls,
 420                                           const struct GNUNET_PeerIdentity *neighbour);
 421
 422
 423 /**
 424  * Connect to the transport service.  Note that the connection may
 425  * complete (or fail) asynchronously.
 426  *
 427  * @param cfg configuration to use
 428  * @param self our own identity (API should check that it matches
 429  *             the identity found by transport), or NULL (no check)
 430  * @param cls closure for the callbacks
 431  * @param rec receive function to call, or NULL
 432  * @param nc function to call on connect events, or NULL
 433  * @param nd function to call on disconnect events, or NULL
 434  * @param neb function to call if we have excess bandwidth to a peer
 435  * @return NULL on error
 436  */
 437 struct GNUNET_TRANSPORT_Handle *
 438 GNUNET_TRANSPORT_connect2 (const struct GNUNET_CONFIGURATION_Handle *cfg,
 439                            const struct GNUNET_PeerIdentity *self,
 440                            void *cls,
 441                            GNUNET_TRANSPORT_ReceiveCallback rec,
 442                            GNUNET_TRANSPORT_NotifyConnect nc,
 443                            GNUNET_TRANSPORT_NotifyDisconnect nd,
 444                            GNUNET_TRANSPORT_NotifyExcessBandwidth neb);
 445
 446
 447 /**
 448  * Disconnect from the transport service.
 449  *
 450  * @param handle handle returned from connect
 451  */
 452 void
 453 GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle);
 454
 455
 456 /**
 457  * Opaque handle for a transmission-ready request.
 458  */
 459 struct GNUNET_TRANSPORT_TryConnectHandle;
 460
 461
 462 /**
 463  * Ask the transport service to establish a connection to
 464  * the given peer.
 465  *
 466  * @param handle connection to transport service
 467  * @param target who we should try to connect to
 468  * @param cb callback to be called when request was transmitted to transport
 469  *         service
 470  * @param cb_cls closure for the callback @a cb
 471  * @return a `struct GNUNET_TRANSPORT_TryConnectHandle` handle or
 472  *         NULL on failure (@a cb will not be called)
 473  */
 474 struct GNUNET_TRANSPORT_TryConnectHandle *
 475 GNUNET_TRANSPORT_try_connect (struct GNUNET_TRANSPORT_Handle *handle,
 476                               const struct GNUNET_PeerIdentity *target,
 477                               GNUNET_TRANSPORT_TryConnectCallback cb,
 478                               void *cb_cls);
 479
 480
 481 /**
 482  * Cancel the request to transport to try a connect
 483  * Callback will not be called
 484  *
 485  * @param tch GNUNET_TRANSPORT_TryConnectHandle handle to cancel
 486  */
 487 void
 488 GNUNET_TRANSPORT_try_connect_cancel (struct GNUNET_TRANSPORT_TryConnectHandle *tch);
 489
 490
 491 /**
 492  * Opaque handle for a transmission-ready request.
 493  */
 494 struct GNUNET_TRANSPORT_TransmitHandle;
 495
 496
 497 /**
 498  * Function called to notify a client about the connection begin ready
 499  * to queue more data.  @a buf will be NULL and @a size zero if the
 500  * connection was closed for writing in the meantime.
 501  *
 502  * @param cls closure
 503  * @param size number of bytes available in @a buf
 504  * @param buf where the callee should write the message
 505  * @return number of bytes written to @a buf
 506  */
 507 typedef size_t
 508 (*GNUNET_TRANSPORT_TransmitReadyNotify) (void *cls,
 509                                          size_t size,
 510                                          void *buf);
 511
 512
 513 /**
 514  * Check if we could queue a message of the given size for
 515  * transmission.  The transport service will take both its internal
 516  * buffers and bandwidth limits imposed by the other peer into
 517  * consideration when answering this query.
 518  *
 519  * @param handle connection to transport service
 520  * @param target who should receive the message
 521  * @param size how big is the message we want to transmit?
 522  * @param timeout after how long should we give up (and call
 523  *        notify with buf NULL and size 0)?
 524  * @param notify function to call when we are ready to
 525  *        send such a message
 526  * @param notify_cls closure for @a notify
 527  * @return NULL if someone else is already waiting to be notified
 528  *         non-NULL if the notify callback was queued (can be used to cancel
 529  *         using GNUNET_TRANSPORT_notify_transmit_ready_cancel)
 530  */
 531 struct GNUNET_TRANSPORT_TransmitHandle *
 532 GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle *handle,
 533                                         const struct GNUNET_PeerIdentity *target,
 534                                         size_t size,
 535                                         struct GNUNET_TIME_Relative timeout,
 536                                         GNUNET_TRANSPORT_TransmitReadyNotify notify,
 537                                         void *notify_cls);
 538
 539
 540 /**
 541  * Cancel the specified transmission-ready notification.
 542  *
 543  * @param th handle of the transmission notification request to cancel
 544  */
 545 void
 546 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct GNUNET_TRANSPORT_TransmitHandle *th);
 547
 548
 549 /**
 550  * Function called whenever there is an update to the
 551  * HELLO of this peer.
 552  *
 553  * @param cls closure
 554  * @param hello our updated HELLO
 555  */
 556 typedef void
 557 (*GNUNET_TRANSPORT_HelloUpdateCallback) (void *cls,
 558                                          const struct GNUNET_MessageHeader *hello);
 559
 560
 561 /**
 562  * Handle to cancel a #GNUNET_TRANSPORT_get_hello() operation.
 563  */
 564 struct GNUNET_TRANSPORT_GetHelloHandle;
 565
 566
 567 /**
 568  * Checks if a given peer is connected to us
 569  *
 570  * @param handle connection to transport service
 571  * @param peer the peer to check
 572  * @return #GNUNET_YES (connected) or #GNUNET_NO (disconnected)
 573  */
 574 int
 575 GNUNET_TRANSPORT_check_peer_connected (struct GNUNET_TRANSPORT_Handle *handle,
 576                                        const struct GNUNET_PeerIdentity *peer);
 577
 578
 579 /**
 580  * Set transport metrics for a peer and a direction
 581  *
 582  * @param handle transport handle
 583  * @param peer the peer to set the metric for
 584  * @param inbound set inbound direction (#GNUNET_YES or #GNUNET_NO)
 585  * @param outbound set outbound direction (#GNUNET_YES or #GNUNET_NO)
 586  * @param ats the metric as ATS information
 587  * @param ats_count the number of metrics
 588  *
 589  * Supported ATS values:
 590  * #GNUNET_ATS_QUALITY_NET_DELAY  (value in ms)
 591  * #GNUNET_ATS_QUALITY_NET_DISTANCE (value in count(hops))
 592  *
 593  * Example
 594  * To enforce a delay of 10 ms for peer p1 in sending direction use:
 595  *
 596  * struct GNUNET_ATS_Information ats;
 597  * ats.type = ntohl (GNUNET_ATS_QUALITY_NET_DELAY);
 598  * ats.value = ntohl (10);
 599  * GNUNET_TRANSPORT_set_traffic_metric (th, p1, TM_SEND, &ats, 1);
 600  *
 601  * Note:
 602  * Delay restrictions in receiving direction will be enforced with
 603  * 1 message delay.
 604  */
 605 void
 606 GNUNET_TRANSPORT_set_traffic_metric (struct GNUNET_TRANSPORT_Handle *handle,
 607                                      const struct GNUNET_PeerIdentity *peer,
 608                                      int inbound,
 609                                      int outbound,
 610                                      const struct GNUNET_ATS_Information *ats,
 611                                      size_t ats_count);
 612
 613
 614 /**
 615  * Obtain updates on changes to the HELLO message for this peer. The callback
 616  * given in this function is never called synchronously.
 617  *
 618  * @param handle connection to transport service
 619  * @param rec function to call with the HELLO
 620  * @param rec_cls closure for @a rec
 621  * @return handle to cancel the operation
 622  */
 623 struct GNUNET_TRANSPORT_GetHelloHandle *
 624 GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
 625                             GNUNET_TRANSPORT_HelloUpdateCallback rec,
 626                             void *rec_cls);
 627
 628
 629 /**
 630  * Stop receiving updates about changes to our HELLO message.
 631  *
 632  * @param ghh handle to cancel
 633  */
 634 void
 635 GNUNET_TRANSPORT_get_hello_cancel (struct GNUNET_TRANSPORT_GetHelloHandle *ghh);
 636
 637
 638 struct GNUNET_TRANSPORT_OfferHelloHandle;
 639
 640 /**
 641  * Offer the transport service the HELLO of another peer.  Note that
 642  * the transport service may just ignore this message if the HELLO is
 643  * malformed or useless due to our local configuration.
 644  *
 645  * @param handle connection to transport service
 646  * @param hello the hello message
 647  * @param cont continuation to call when HELLO has been sent,
 648  *      tc reason #GNUNET_SCHEDULER_REASON_TIMEOUT for fail
 649  *      tc reasong #GNUNET_SCHEDULER_REASON_READ_READY for success
 650  * @param cls closure for continuation
 651  * @return a GNUNET_TRANSPORT_OfferHelloHandle handle or NULL on failure,
 652  *      in case of failure cont will not be called
 653  *
 654  */
 655 struct GNUNET_TRANSPORT_OfferHelloHandle *
 656 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
 657                               const struct GNUNET_MessageHeader *hello,
 658                               GNUNET_SCHEDULER_Task cont, void *cls);
 659
 660
 661 /**
 662  * Cancel the request to transport to offer the HELLO message
 663  *
 664  * @param ohh the `struct GNUNET_TRANSPORT_OfferHelloHandle` to cancel
 665  */
 666 void
 667 GNUNET_TRANSPORT_offer_hello_cancel (struct GNUNET_TRANSPORT_OfferHelloHandle *ohh);
 668
 669
 670 /**
 671  * Handle to cancel a pending address lookup.
 672  */
 673 struct GNUNET_TRANSPORT_AddressToStringContext;
 674
 675
 676 /**
 677  * Convert a binary address into a human readable address.
 678  *
 679  * @param cfg configuration to use
 680  * @param address address to convert (binary format)
 681  * @param numeric should (IP) addresses be displayed in numeric form
 682  *                (otherwise do reverse DNS lookup)
 683  * @param timeout how long is the lookup allowed to take at most
 684  * @param aluc function to call with the results
 685  * @param aluc_cls closure for @a aluc
 686  * @return handle to cancel the operation, NULL on error
 687  */
 688 struct GNUNET_TRANSPORT_AddressToStringContext *
 689 GNUNET_TRANSPORT_address_to_string (const struct GNUNET_CONFIGURATION_Handle *cfg,
 690                                     const struct GNUNET_HELLO_Address *address,
 691                                     int numeric,
 692                                     struct GNUNET_TIME_Relative timeout,
 693                                     GNUNET_TRANSPORT_AddressToStringCallback aluc,
 694                                     void *aluc_cls);
 695
 696
 697 /**
 698  * Cancel request for address conversion.
 699  *
 700  * @param pic the context handle
 701  */
 702 void
 703 GNUNET_TRANSPORT_address_to_string_cancel (struct GNUNET_TRANSPORT_AddressToStringContext *pic);
 704
 705
 706 /**
 707  * Convert a transport state to a human readable string.
 708  *
 709  * @param state the state
 710  */
 711 const char *
 712 GNUNET_TRANSPORT_ps2s (enum GNUNET_TRANSPORT_PeerState state);
 713
 714
 715 /**
 716  * Check if a state is defined as connected
 717  *
 718  * @param state the state value
 719  * @return #GNUNET_YES or #GNUNET_NO
 720  */
 721 int
 722 GNUNET_TRANSPORT_is_connected (enum GNUNET_TRANSPORT_PeerState state);
 723
 724
 725 /**
 726  * Convert validation state to human-readable string.
 727  *
 728  * @param state the state value
 729  * @return corresponding string
 730  */
 731 const char *
 732 GNUNET_TRANSPORT_vs2s (enum GNUNET_TRANSPORT_ValidationState state);
 733
 734 struct GNUNET_TRANSPORT_PeerMonitoringContext;
 735
 736 /**
 737  * Return information about a specific peer or all peers currently known to
 738  * transport service once or in monitoring mode. To obtain information about
 739  * a specific peer, a peer identity can be passed. To obtain information about
 740  * all peers currently known to transport service, NULL can be passed as peer
 741  * identity.
 742  *
 743  * For each peer, the callback is called with information about the address used
 744  * to communicate with this peer, the state this peer is currently in and the
 745  * the current timeout for this state.
 746  *
 747  * Upon completion, the 'GNUNET_TRANSPORT_PeerIterateCallback' is called one
 748  * more time with 'NULL'. After this, the operation must no longer be
 749  * explicitly canceled.
 750  *
 751  * The #GNUNET_TRANSPORT_monitor_peers_cancel call MUST not be called in the
 752  * the peer_callback!
 753  *
 754  * @param cfg configuration to use
 755  * @param peer a specific peer identity to obtain information for,
 756  *      NULL for all peers
 757  * @param one_shot #GNUNET_YES to return the current state and then end (with NULL+NULL),
 758  *                 #GNUNET_NO to monitor peers continuously
 759  * @param timeout how long is the lookup allowed to take at most
 760  * @param peer_callback function to call with the results
 761  * @param peer_callback_cls closure for @a peer_callback
 762  */
 763 struct GNUNET_TRANSPORT_PeerMonitoringContext *
 764 GNUNET_TRANSPORT_monitor_peers (const struct GNUNET_CONFIGURATION_Handle *cfg,
 765                                 const struct GNUNET_PeerIdentity *peer,
 766                                 int one_shot,
 767                                 struct GNUNET_TIME_Relative timeout,
 768                                 GNUNET_TRANSPORT_PeerIterateCallback peer_callback,
 769                                 void *peer_callback_cls);
 770
 771
 772 /**
 773  * Cancel request to monitor peers
 774  *
 775  * @param pic handle for the request to cancel
 776  */
 777 void
 778 GNUNET_TRANSPORT_monitor_peers_cancel (struct GNUNET_TRANSPORT_PeerMonitoringContext *pic);
 779
 780
 781 struct GNUNET_TRANSPORT_ValidationMonitoringContext;
 782
 783 /**
 784  * Return information about pending address validation operations for a specific
 785  * or all peers
 786  *
 787  * @param cfg configuration to use
 788  * @param peer a specific peer identity to obtain validation entries for,
 789  *      NULL for all peers
 790  * @param one_shot #GNUNET_YES to return all entries and then end (with NULL+NULL),
 791  *                 #GNUNET_NO to monitor validation entries continuously
 792  * @param timeout how long is the lookup allowed to take at most
 793  * @param validation_callback function to call with the results
 794  * @param validation_callback_cls closure for @a validation_callback
 795  */
 796 struct GNUNET_TRANSPORT_ValidationMonitoringContext *
 797 GNUNET_TRANSPORT_monitor_validation_entries (const struct GNUNET_CONFIGURATION_Handle *cfg,
 798                                              const struct GNUNET_PeerIdentity *peer,
 799                                              int one_shot,
 800                                              struct GNUNET_TIME_Relative timeout,
 801                                              GNUNET_TRANSPORT_ValidationIterateCallback validation_callback,
 802                                              void *validation_callback_cls);
 803
 804
 805 /**
 806  * Return information about all current pending validation operations
 807  *
 808  * @param vic handle for the request to cancel
 809  */
 810 void
 811 GNUNET_TRANSPORT_monitor_validation_entries_cancel (struct GNUNET_TRANSPORT_ValidationMonitoringContext *vic);
 812
 813
 814 /**
 815  * Handle for blacklisting peers.
 816  */
 817 struct GNUNET_TRANSPORT_Blacklist;
 818
 819
 820 /**
 821  * Function that decides if a connection is acceptable or not.
 822  *
 823  * @param cls closure
 824  * @param pid peer to approve or disapproave
 825  * @return #GNUNET_OK if the connection is allowed, #GNUNET_SYSERR if not
 826  */
 827 typedef int
 828 (*GNUNET_TRANSPORT_BlacklistCallback) (void *cls,
 829                                        const struct
 830                                        GNUNET_PeerIdentity * pid);
 831
 832
 833 /**
 834  * Install a blacklist callback.  The service will be queried for all
 835  * existing connections as well as any fresh connections to check if
 836  * they are permitted.  If the blacklisting callback is unregistered,
 837  * all hosts that were denied in the past will automatically be
 838  * whitelisted again.  Cancelling the blacklist handle is also the
 839  * only way to re-enable connections from peers that were previously
 840  * blacklisted.
 841  *
 842  * @param cfg configuration to use
 843  * @param cb callback to invoke to check if connections are allowed
 844  * @param cb_cls closure for @a cb
 845  * @return NULL on error, otherwise handle for cancellation
 846  */
 847 struct GNUNET_TRANSPORT_Blacklist *
 848 GNUNET_TRANSPORT_blacklist (const struct GNUNET_CONFIGURATION_Handle *cfg,
 849                             GNUNET_TRANSPORT_BlacklistCallback cb,
 850                             void *cb_cls);
 851
 852
 853 /**
 854  * Abort the blacklist.  Note that this function is the only way for
 855  * removing a peer from the blacklist.
 856  *
 857  * @param br handle of the request that is to be cancelled
 858  */
 859 void
 860 GNUNET_TRANSPORT_blacklist_cancel (struct GNUNET_TRANSPORT_Blacklist *br);
 861
 862
 863
 864 #if 0                           /* keep Emacsens' auto-indent happy */
 865 {
 866 #endif
 867 #ifdef __cplusplus
 868 }
 869 #endif
 870
 871 /* ifndef GNUNET_TRANSPORT_SERVICE_H */
 872 #endif
 873 /* end of gnunet_transport_service.h */
 874
 875