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, 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, GNUNET_SYSERR if we're not connected
  82  */
  83 typedef void (*GST_NeighbourSendContinuation) (void *cls, int success);
  84
  85
  86 /**
  87  * Transmit a message to the given target using the active connection.
  88  *
  89  * @param target destination
  90  * @param msg message to send
  91  * @param msg_size number of bytes in msg
  92  * @param timeout when to fail with timeout
  93  * @param cont function to call when done
  94  * @param cont_cls closure for 'cont'
  95  */
  96 void
  97 GST_neighbours_send (const struct GNUNET_PeerIdentity *target, const void *msg,
  98                      size_t msg_size, 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
 125 GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour);
 126
 127 /**
 128  * We received a KEEP_ALIVE_RESPONSE message and use this to calculate latency
 129  * to this peer
 130  *
 131  * @param neighbour neighbour to keep alive
 132  * @param ats performance data
 133  * @param ats_count number of entries in ats
 134  */
 135 void
 136 GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour,
 137                                    const struct GNUNET_ATS_Information *ats,
 138                                    uint32_t ats_count);
 139
 140
 141 /**
 142  * Change the incoming quota for the given peer.
 143  *
 144  * @param neighbour identity of peer to change qutoa for
 145  * @param quota new quota
 146  */
 147 void
 148 GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
 149                                    struct GNUNET_BANDWIDTH_Value32NBO quota);
 150
 151
 152 /**
 153  * If we have an active connection to the given target, it must be shutdown.
 154  *
 155  * @param target peer to disconnect from
 156  */
 157 void
 158 GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target);
 159
 160
 161 /**
 162  * Function called for each connected neighbour.
 163  *
 164  * @param cls closure
 165  * @param neighbour identity of the neighbour
 166  * @param ats performance data
 167  * @param ats_count number of entries in ats (including 0-termination)
 168  * @param address the address (or NULL)
 169  */
 170 typedef void (*GST_NeighbourIterator) (void *cls,
 171                                        const struct GNUNET_PeerIdentity *
 172                                        neighbour,
 173                                        const struct GNUNET_ATS_Information *
 174                                        ats, uint32_t ats_count,
 175                                        const struct GNUNET_HELLO_Address *
 176                                        address);
 177
 178
 179 /**
 180  * Iterate over all connected neighbours.
 181  *
 182  * @param cb function to call
 183  * @param cb_cls closure for cb
 184  */
 185 void
 186 GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls);
 187
 188
 189 /**
 190  * A session was terminated. Take note.
 191  *
 192  * @param peer identity of the peer where the session died
 193  * @param session session that is gone
 194  */
 195 void
 196 GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
 197                                    struct Session *session);
 198
 199
 200 /**
 201  * For an existing neighbour record, set the active connection to
 202  * use the given address.
 203  *
 204  * @param peer identity of the peer to switch the address for
 205  * @param address address of the other peer, NULL if other peer
 206  *                       connected to us
 207  * @param session session to use (or NULL)
 208  * @param ats performance data
 209  * @param ats_count number of entries in ats
 210  * @param bandwidth_in inbound quota to be used when connection is up
 211  * @param bandwidth_out outbound quota to be used when connection is up
 212  * @return GNUNET_YES if we are currently connected, GNUNET_NO if the
 213  *         connection is not up (yet)
 214  */
 215 int
 216 GST_neighbours_switch_to_address (const struct GNUNET_PeerIdentity *peer,
 217                                        const struct GNUNET_HELLO_Address
 218                                        *address, struct Session *session,
 219                                        const struct GNUNET_ATS_Information *ats,
 220                                        uint32_t ats_count,
 221                                        struct GNUNET_BANDWIDTH_Value32NBO
 222                                        bandwidth_in,
 223                                        struct GNUNET_BANDWIDTH_Value32NBO
 224                                        bandwidth_out);
 225
 226
 227 /**
 228  * We received a 'SESSION_CONNECT' message from the other peer.
 229  * Consider switching to it.
 230  *
 231  * @param message possibly a 'struct SessionConnectMessage' (check format)
 232  * @param peer identity of the peer to switch the address for
 233  * @param address address of the other peer, NULL if other peer
 234  *                       connected to us
 235  * @param session session to use (or NULL)
 236  * @param ats performance data
 237  * @param ats_count number of entries in ats (excluding 0-termination)
 238   */
 239 void
 240 GST_neighbours_handle_connect (const struct GNUNET_MessageHeader *message,
 241                                const struct GNUNET_PeerIdentity *peer,
 242                                const struct GNUNET_HELLO_Address *address,
 243                                struct Session *session,
 244                                const struct GNUNET_ATS_Information *ats,
 245                                uint32_t ats_count);
 246
 247
 248 /**
 249  * We received a 'SESSION_CONNECT_ACK' message from the other peer.
 250  * Consider switching to it.
 251  *
 252  * @param message possibly a 'struct SessionConnectMessage' (check format)
 253  * @param peer identity of the peer to switch the address for
 254  * @param address address of the other peer, NULL if other peer
 255  *                       connected to us
 256  * @param session session to use (or NULL)
 257  * @param ats performance data
 258  * @param ats_count number of entries in ats
 259  */
 260 void
 261 GST_neighbours_handle_connect_ack (const struct GNUNET_MessageHeader *message,
 262                                    const struct GNUNET_PeerIdentity *peer,
 263                                    const struct GNUNET_HELLO_Address *address,
 264                                    struct Session *session,
 265                                    const struct GNUNET_ATS_Information *ats,
 266                                    uint32_t ats_count);
 267
 268 void
 269 GST_neighbours_handle_ack (const struct GNUNET_MessageHeader *message,
 270                            const struct GNUNET_PeerIdentity *peer,
 271                            const struct GNUNET_HELLO_Address *address,
 272                            struct Session *session,
 273                            const struct GNUNET_ATS_Information *ats,
 274                            uint32_t ats_count);
 275
 276
 277 /**
 278  * Obtain current latency information for the given neighbour.
 279  *
 280  * @param peer
 281  * @return observed latency of the address, FOREVER if the address was
 282  *         never successfully validated
 283  */
 284 struct GNUNET_TIME_Relative
 285 GST_neighbour_get_latency (const struct GNUNET_PeerIdentity *peer);
 286
 287
 288 /**
 289  * Obtain current address information for the given neighbour.
 290  *
 291  * @param peer
 292  * @return address currently used
 293  */
 294 struct GNUNET_HELLO_Address *
 295 GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer);
 296
 297
 298 /**
 299  * We received a disconnect message from the given peer,
 300  * validate and process.
 301  *
 302  * @param peer sender of the message
 303  * @param msg the disconnect message
 304  */
 305 void
 306 GST_neighbours_handle_disconnect_message (const struct GNUNET_PeerIdentity
 307                                           *peer,
 308                                           const struct GNUNET_MessageHeader
 309                                           *msg);
 310
 311
 312 #endif
 313 /* end of file gnunet-service-transport_neighbours.h */