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_util_lib.h"
  32
  33 // TODO:
  34 // - ATS and similar info is a bit lacking in the API right now...
  35
  36
  37
  38 /**
  39  * Initialize the neighbours subsystem.
  40  *
  41  * @param cls closure for callbacks
  42  * @param connect_cb function to call if we connect to a peer
  43  * @param disconnect_cb function to call if we disconnect from a peer
  44  */
  45 void
  46 GST_neighbours_start (void *cls,
  47                       GNUNET_TRANSPORT_NotifyConnect connect_cb,
  48                       GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb);
  49
  50
  51 /**
  52  * Cleanup the neighbours subsystem.
  53  */
  54 void
  55 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
  64 GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target);
  65
  66
  67 /**
  68  * Test if we're connected to the given peer.
  69  *
  70  * @param target peer to test
  71  * @return GNUNET_YES if we are connected, GNUNET_NO if not
  72  */
  73 int
  74 GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target);
  75
  76
  77 /**
  78  * Function called after the transmission is done.
  79  *
  80  * @param cls closure
  81  * @param success GNUNET_OK on success, GNUNET_NO on failure
  82  */
  83 typedef void (*GST_NeighbourSendContinuation)(void *cls,
  84                                               int success);
  85
  86
  87 /**
  88  * Transmit a message to the given target using the active connection.
  89  *
  90  * @param target destination
  91  * @param msg message to send
  92  * @param cont function to call when done
  93  * @param cont_cls closure for 'cont'
  94  */
  95 void
  96 GST_neighbours_send (const struct GNUNET_PeerIdentity *target,
  97                      const struct GNUNET_MessageHeader *msg,
  98                      GST_NeighbourSendContinuation cont,
  99                      void *cont_cls);
 100
 101 /**
 102  * Change the quota for the given peer.
 103  * FIXME: inbound or outbound quota?
 104  *
 105  * @param neighbour identity of peer to change qutoa for
 106  * @param quota new quota FIXME: fix type!
 107  */
 108 void
 109 GST_neighbours_set_quota (const struct GNUNET_PeerIdentity *neighbour,
 110                           const float quota);
 111
 112
 113 /**
 114  * If we have an active connection to the given target, it must be shutdown.
 115  *
 116  * @param target peer to disconnect from
 117  */
 118 void
 119 GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target);
 120
 121
 122 /**
 123  * Function called for each connected neighbour.
 124  *
 125  * @param cls closure
 126  * @param neighbour identity of the neighbour
 127  * @param ats performance data
 128  * @param ats_count number of entries in ats (excluding 0-termination)
 129  */
 130 typedef void (*GST_NeighbourIterator)(void *cls,
 131                                       const struct GNUNET_PeerIdentity *neighbour,
 132                                       const struct GNUNET_TRANSPORT_ATS_Information *ats,
 133                                       uint32_t ats_count);
 134
 135
 136 /**
 137  * Iterate over all connected neighbours.
 138  *
 139  * @param cb function to call
 140  * @param cb_cls closure for cb
 141  */
 142 void
 143 GST_neighbours_iterate (GST_NeighbourIterator cb,
 144                         void *cb_cls);
 145
 146
 147 /**
 148  * We have received a PONG.  Update lifeness of the neighbour.
 149  *
 150  * @param sender peer sending the PONG
 151  * @param hdr the PONG message (presumably)
 152  * @param plugin_name name of transport that delivered the PONG
 153  * @param sender_address address of the other peer, NULL if other peer
 154  *                       connected to us
 155  * @param sender_address_len number of bytes in sender_address
 156  * @return GNUNET_OK if the message was well-formed, GNUNET_SYSERR if not
 157  */
 158 int
 159 GST_neighbours_handle_pong (const struct GNUNET_PeerIdentity *sender,
 160                             const struct GNUNET_MessageHeader *hdr,
 161                             const char *plugin_name,
 162                             const void *sender_address,
 163                             size_t sender_address_len);
 164
 165
 166 /**
 167  * We have received a CONNECT.  Set the peer to connected.
 168  *
 169  * @param sender peer sending the PONG
 170  * @param hdr the PONG message (presumably)
 171  * @param plugin_name name of transport that delivered the PONG
 172  * @param sender_address address of the other peer, NULL if other peer
 173  *                       connected to us
 174  * @param sender_address_len number of bytes in sender_address
 175  * @return GNUNET_OK if the message was well-formed, GNUNET_SYSERR if not
 176  */
 177 int
 178 GST_neighbours_handle_connect (const struct GNUNET_PeerIdentity *sender,
 179                                const struct GNUNET_MessageHeader *hdr,
 180                                const char *plugin_name,
 181                                const void *sender_address,
 182                                size_t sender_address_len);
 183
 184
 185 /**
 186  * We have received a DISCONNECT.  Set the peer to disconnected.
 187  *
 188  * @param sender peer sending the PONG
 189  * @param hdr the PONG message (presumably)
 190  * @param plugin_name name of transport that delivered the PONG
 191  * @param sender_address address of the other peer, NULL if other peer
 192  *                       connected to us
 193  * @param sender_address_len number of bytes in sender_address
 194  * @return GNUNET_OK if the message was well-formed, GNUNET_SYSERR if not
 195  */
 196 int
 197 GST_neighbours_handle_disconnect (const struct GNUNET_PeerIdentity *sender,
 198                                   const struct GNUNET_MessageHeader *hdr,
 199                                   const char *plugin_name,
 200                                   const void *sender_address,
 201                                   size_t sender_address_len);
 202
 203
 204 #endif
 205 /* end of file gnunet-service-transport_neighbours.h */