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  * @param peer_address_cb function to call if a neighbour's active address changes
  46  */
  47 void
  48 GST_neighbours_start (void *cls,
  49                       GNUNET_TRANSPORT_NotifyConnect connect_cb,
  50                       GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb,
  51                       GNUNET_TRANSPORT_PeerIterateCallback peer_address_cb);
  52
  53
  54 /**
  55  * Cleanup the neighbours subsystem.
  56  */
  57 void
  58 GST_neighbours_stop (void);
  59
  60
  61 /**
  62  * Try to create a connection to the given target (eventually).
  63  *
  64  * @param target peer to try to connect to
  65  */
  66 void
  67 GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target);
  68
  69
  70 /**
  71  * Test if we're connected to the given peer.
  72  *
  73  * @param target peer to test
  74  * @return GNUNET_YES if we are connected, GNUNET_NO if not
  75  */
  76 int
  77 GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target);
  78
  79
  80 /**
  81  * Function called after the transmission is done.
  82  *
  83  * @param cls closure
  84  * @param success GNUNET_OK on success, GNUNET_NO on failure, GNUNET_SYSERR if we're not connected
  85  */
  86 typedef void (*GST_NeighbourSendContinuation) (void *cls, int success);
  87
  88
  89 /**
  90  * Transmit a message to the given target using the active connection.
  91  *
  92  * @param target destination
  93  * @param msg message to send
  94  * @param msg_size number of bytes in msg
  95  * @param timeout when to fail with timeout
  96  * @param cont function to call when done
  97  * @param cont_cls closure for 'cont'
  98  */
  99 void
 100 GST_neighbours_send (const struct GNUNET_PeerIdentity *target, const void *msg,
 101                      size_t msg_size, struct GNUNET_TIME_Relative timeout,
 102                      GST_NeighbourSendContinuation cont, void *cont_cls);
 103
 104
 105 /**
 106  * We have received a message from the given sender.
 107  * How long should we delay before receiving more?
 108  * (Also used to keep the peer marked as live).
 109  *
 110  * @param sender sender of the message
 111  * @param size size of the message
 112  * @param do_forward set to GNUNET_YES if the message should be forwarded to clients
 113  *                   GNUNET_NO if the neighbour is not connected or violates the quota
 114  * @return how long to wait before reading more from this sender
 115  */
 116 struct GNUNET_TIME_Relative
 117 GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity
 118                                         *sender, ssize_t size, int *do_forward);
 119
 120
 121 /**
 122  * Keep the connection to the given neighbour alive longer,
 123  * we received a KEEPALIVE (or equivalent).
 124  *
 125  * @param neighbour neighbour to keep alive
 126  */
 127 void
 128 GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour);
 129
 130
 131 /**
 132  * We received a KEEP_ALIVE_RESPONSE message and use this to calculate latency
 133  * to this peer
 134  *
 135  * @param neighbour neighbour to keep alive
 136  * @param ats performance data
 137  * @param ats_count number of entries in ats
 138  */
 139 void
 140 GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour,
 141                                    const struct GNUNET_ATS_Information *ats,
 142                                    uint32_t ats_count);
 143
 144
 145 /**
 146  * Change the incoming quota for the given peer.
 147  *
 148  * @param neighbour identity of peer to change qutoa for
 149  * @param quota new quota
 150  */
 151 void
 152 GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
 153                                    struct GNUNET_BANDWIDTH_Value32NBO quota);
 154
 155
 156 /**
 157  * If we have an active connection to the given target, it must be shutdown.
 158  *
 159  * @param target peer to disconnect from
 160  */
 161 void
 162 GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target);
 163
 164
 165 /**
 166  * Function called for each connected neighbour.
 167  *
 168  * @param cls closure
 169  * @param neighbour identity of the neighbour
 170  * @param ats performance data
 171  * @param ats_count number of entries in ats (including 0-termination)
 172  * @param address the address (or NULL)
 173  */
 174 typedef void (*GST_NeighbourIterator) (void *cls,
 175                                        const struct GNUNET_PeerIdentity *
 176                                        neighbour,
 177                                        const struct GNUNET_ATS_Information *
 178                                        ats, uint32_t ats_count,
 179                                        const struct GNUNET_HELLO_Address *
 180                                        address);
 181
 182
 183 /**
 184  * Iterate over all connected neighbours.
 185  *
 186  * @param cb function to call
 187  * @param cb_cls closure for cb
 188  */
 189 void
 190 GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls);
 191
 192
 193 /**
 194  * A session was terminated. Take note.
 195  *
 196  * @param peer identity of the peer where the session died
 197  * @param session session that is gone
 198  */
 199 void
 200 GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
 201                                    struct Session *session);
 202
 203
 204 /**
 205  * For an existing neighbour record, set the active connection to
 206  * use the given address.
 207  *
 208  * @param peer identity of the peer to switch the address for
 209  * @param address address of the other peer, NULL if other peer
 210  *                       connected to us
 211  * @param session session to use (or NULL)
 212  * @param ats performance data
 213  * @param ats_count number of entries in ats
 214  * @param bandwidth_in inbound quota to be used when connection is up
 215  * @param bandwidth_out outbound quota to be used when connection is up
 216  */
 217 void
 218 GST_neighbours_switch_to_address (const struct GNUNET_PeerIdentity *peer,
 219                                        const struct GNUNET_HELLO_Address
 220                                        *address, struct Session *session,
 221                                        const struct GNUNET_ATS_Information *ats,
 222                                        uint32_t ats_count,
 223                                        struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
 224                                        struct GNUNET_BANDWIDTH_Value32NBO 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
 269 /**
 270  * We received a 'SESSION_ACK' message from the other peer.
 271  * FIXME: describe what this means!
 272  *
 273  * @param message possibly a 'struct SessionConnectMessage' (check format)
 274  * @param peer identity of the peer to switch the address for
 275  * @param address address of the other peer, NULL if other peer
 276  *                       connected to us
 277  * @param session session to use (or NULL)
 278  * @param ats performance data
 279  * @param ats_count number of entries in ats
 280  */
 281 void
 282 GST_neighbours_handle_session_ack (const struct GNUNET_MessageHeader *message,
 283                                    const struct GNUNET_PeerIdentity *peer,
 284                                    const struct GNUNET_HELLO_Address *address,
 285                                    struct Session *session,
 286                                    const struct GNUNET_ATS_Information *ats,
 287                                    uint32_t ats_count);
 288
 289
 290 /**
 291  * Obtain current latency information for the given neighbour.
 292  *
 293  * @param peer
 294  * @return observed latency of the address, FOREVER if the address was
 295  *         never successfully validated
 296  */
 297 struct GNUNET_TIME_Relative
 298 GST_neighbour_get_latency (const struct GNUNET_PeerIdentity *peer);
 299
 300
 301 /**
 302  * Obtain current address information for the given neighbour.
 303  *
 304  * @param peer
 305  * @return address currently used
 306  */
 307 struct GNUNET_HELLO_Address *
 308 GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer);
 309
 310
 311 /**
 312  * We received a disconnect message from the given peer,
 313  * validate and process.
 314  *
 315  * @param peer sender of the message
 316  * @param msg the disconnect message
 317  */
 318 void
 319 GST_neighbours_handle_disconnect_message (const struct GNUNET_PeerIdentity
 320                                           *peer,
 321                                           const struct GNUNET_MessageHeader
 322                                           *msg);
 323
 324
 325 #endif
 326 /* end of file gnunet-service-transport_neighbours.h */