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