src/transport/gnunet-service-transport_neighbours.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 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 transport/gnunet-service-transport_neighbours.h
  23  * @brief neighbour management API
  24  * @author Christian Grothoff
  25  */
  26 #ifndef GNUNET_SERVICE_TRANSPORT_NEIGHBOURS_H
  27 #define GNUNET_SERVICE_TRANSPORT_NEIGHBOURS_H
  28
  29 #include "gnunet_statistics_service.h"
  30 #include "gnunet_transport_service.h"
  31 #include "gnunet_transport_plugin.h"
  32 #include "gnunet_util_lib.h"
  33
  34 // TODO:
  35 // - ATS and similar info is a bit lacking in the API right now...
  36
  37
  38
  39 /**
  40  * Initialize the neighbours subsystem.
  41  *
  42  * @param cls closure for callbacks
  43  * @param connect_cb function to call if we connect to a peer
  44  * @param disconnect_cb function to call if we disconnect from a peer
  45  */
  46 void
  47 GST_neighbours_start (void *cls,
  48                       GNUNET_TRANSPORT_NotifyConnect connect_cb,
  49                       GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb);
  50
  51
  52 /**
  53  * Cleanup the neighbours subsystem.
  54  */
  55 void GST_neighbours_stop (void);
  56
  57
  58 /**
  59  * Try to create a connection to the given target (eventually).
  60  *
  61  * @param target peer to try to connect to
  62  */
  63 void GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target);
  64
  65
  66 /**
  67  * Test if we're connected to the given peer.
  68  *
  69  * @param target peer to test
  70  * @return GNUNET_YES if we are connected, GNUNET_NO if not
  71  */
  72 int GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target);
  73
  74
  75 /**
  76  * Function called after the transmission is done.
  77  *
  78  * @param cls closure
  79  * @param success GNUNET_OK on success, GNUNET_NO on failure, GNUNET_SYSERR if we're not connected
  80  */
  81 typedef void (*GST_NeighbourSendContinuation) (void *cls, int success);
  82
  83
  84 /**
  85  * Transmit a message to the given target using the active connection.
  86  *
  87  * @param target destination
  88  * @param msg message to send
  89  * @param msg_size number of bytes in msg
  90  * @param timeout when to fail with timeout
  91  * @param cont function to call when done
  92  * @param cont_cls closure for 'cont'
  93  */
  94 void
  95 GST_neighbours_send (const struct GNUNET_PeerIdentity *target,
  96                      const void *msg,
  97                      size_t msg_size,
  98                      struct GNUNET_TIME_Relative timeout,
  99                      GST_NeighbourSendContinuation cont, void *cont_cls);
 100
 101
 102 /**
 103  * We have received a message from the given sender.
 104  * How long should we delay before receiving more?
 105  * (Also used to keep the peer marked as live).
 106  *
 107  * @param sender sender of the message
 108  * @param size size of the message
 109  * @param do_forward set to GNUNET_YES if the message should be forwarded to clients
 110  *                   GNUNET_NO if the neighbour is not connected or violates the quota
 111  * @return how long to wait before reading more from this sender
 112  */
 113 struct GNUNET_TIME_Relative
 114 GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity
 115                                         *sender, ssize_t size, int *do_forward);
 116
 117
 118 /**
 119  * Keep the connection to the given neighbour alive longer,
 120  * we received a KEEPALIVE (or equivalent).
 121  *
 122  * @param neighbour neighbour to keep alive
 123  */
 124 void GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour);
 125
 126
 127 /**
 128  * Change the incoming quota for the given peer.
 129  *
 130  * @param neighbour identity of peer to change qutoa for
 131  * @param quota new quota
 132  */
 133 void
 134 GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
 135                                    struct GNUNET_BANDWIDTH_Value32NBO quota);
 136
 137
 138 /**
 139  * If we have an active connection to the given target, it must be shutdown.
 140  *
 141  * @param target peer to disconnect from
 142  */
 143 void GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target);
 144
 145
 146 /**
 147  * Function called for each connected neighbour.
 148  *
 149  * @param cls closure
 150  * @param neighbour identity of the neighbour
 151  * @param ats performance data
 152  * @param ats_count number of entries in ats (excluding 0-termination)
 153  */
 154 typedef void (*GST_NeighbourIterator) (void *cls,
 155                                        const struct GNUNET_PeerIdentity *
 156                                        neighbour,
 157                                        const struct
 158                                        GNUNET_TRANSPORT_ATS_Information * ats,
 159                                        uint32_t ats_count);
 160
 161
 162 /**
 163  * Iterate over all connected neighbours.
 164  *
 165  * @param cb function to call
 166  * @param cb_cls closure for cb
 167  */
 168 void GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls);
 169
 170
 171 /**
 172  * A session was terminated. Take note.
 173  *
 174  * @param peer identity of the peer where the session died
 175  * @param session session that is gone
 176  */
 177 void
 178 GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
 179                                    struct Session *session);
 180
 181
 182 /**
 183  * For an existing neighbour record, set the active connection to
 184  * use the given address.
 185  *
 186  * @param peer identity of the peer to switch the address for
 187  * @param plugin_name name of transport that delivered the PONG
 188  * @param address address of the other peer, NULL if other peer
 189  *                       connected to us
 190  * @param address_len number of bytes in address
 191  * @param session session to use (or NULL)
 192  * @param ats performance data
 193  * @param ats_count number of entries in ats (excluding 0-termination)
 194  */
 195 void
 196 GST_neighbours_switch_to_address (const struct GNUNET_PeerIdentity *peer,
 197                                   const char *plugin_name,
 198                                   const void *address,
 199                                   size_t address_len,
 200                                   struct Session *session,
 201                                   const struct GNUNET_TRANSPORT_ATS_Information
 202                                   *ats, uint32_t ats_count);
 203
 204
 205 #endif
 206 /* end of file gnunet-service-transport_neighbours.h */