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-service-transport.h"
  33 #include "transport.h"
  34 #include "gnunet_util_lib.h"
  35
  36 // TODO:
  37 // - ATS and similar info is a bit lacking in the API right now...
  38
  39
  40
  41 /**
  42  * Initialize the neighbours subsystem.
  43  *
  44  * @param cls closure for callbacks
  45  * @param connect_cb function to call if we connect to a peer
  46  * @param disconnect_cb function to call if we disconnect from a peer
  47  * @param peer_address_cb function to call if a neighbour's active address changes
  48  * @param max_fds maximum number of fds to use
  49  */
  50 void
  51 GST_neighbours_start (void *cls,
  52                       NotifyConnect connect_cb,
  53                       GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb,
  54                       GNUNET_TRANSPORT_AddressChangeCallback peer_address_cb,
  55                       unsigned int max_fds);
  56
  57
  58 /**
  59  * Cleanup the neighbours subsystem.
  60  */
  61 void
  62 GST_neighbours_stop (void);
  63
  64
  65 /**
  66  * Try to create a connection to the given target (eventually).
  67  *
  68  * @param target peer to try to connect to
  69  */
  70 void
  71 GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target);
  72
  73
  74 /**
  75  * Test if we're connected to the given peer.
  76  *
  77  * @param target peer to test
  78  * @return #GNUNET_YES if we are connected, #GNUNET_NO if not
  79  */
  80 int
  81 GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target);
  82
  83
  84 /**
  85  * Function called after the transmission is done.
  86  *
  87  * @param cls closure
  88  * @param success #GNUNET_OK on success, #GNUNET_NO on failure, #GNUNET_SYSERR if we're not connected
  89  */
  90 typedef void (*GST_NeighbourSendContinuation) (void *cls, int success,
  91                                                size_t bytes_payload,
  92                                                size_t bytes_on_wire);
  93
  94
  95 /**
  96  * Transmit a message to the given target using the active connection.
  97  *
  98  * @param target destination
  99  * @param msg message to send
 100  * @param msg_size number of bytes in @a msg
 101  * @param timeout when to fail with timeout
 102  * @param cont function to call when done
 103  * @param cont_cls closure for @a cont
 104  */
 105 void
 106 GST_neighbours_send (const struct GNUNET_PeerIdentity *target, const void *msg,
 107                      size_t msg_size, struct GNUNET_TIME_Relative timeout,
 108                      GST_NeighbourSendContinuation cont, void *cont_cls);
 109
 110
 111 /**
 112  * We have received a message from the given sender.
 113  * How long should we delay before receiving more?
 114  * (Also used to keep the peer marked as live).
 115  *
 116  * @param sender sender of the message
 117  * @param size size of the message
 118  * @param do_forward set to #GNUNET_YES if the message should be forwarded to clients
 119  *                   #GNUNET_NO if the neighbour is not connected or violates the quota
 120  * @return how long to wait before reading more from this sender
 121  */
 122 struct GNUNET_TIME_Relative
 123 GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity
 124                                         *sender, ssize_t size, int *do_forward);
 125
 126
 127 /**
 128  * Keep the connection to the given neighbour alive longer,
 129  * we received a KEEPALIVE (or equivalent); send a response.
 130  *
 131  * @param neighbour neighbour to keep alive (by sending keep alive response)
 132  * @param m the keep alive message containing the nonce to respond to
 133  */
 134 void
 135 GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour,
 136                           const struct GNUNET_MessageHeader *m);
 137
 138
 139 /**
 140  * We received a KEEP_ALIVE_RESPONSE message and use this to calculate
 141  * latency to this peer.  Pass the updated information (existing ats
 142  * plus calculated latency) to ATS.
 143  *
 144  * @param neighbour neighbour to keep alive
 145  * @param m the message containing the keep alive response
 146  */
 147 void
 148 GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour,
 149     const struct GNUNET_MessageHeader *m);
 150
 151
 152 /**
 153  * Change the incoming quota for the given peer.
 154  *
 155  * @param neighbour identity of peer to change qutoa for
 156  * @param quota new quota
 157  */
 158 void
 159 GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
 160                                    struct GNUNET_BANDWIDTH_Value32NBO quota);
 161
 162
 163 /**
 164  * If we have an active connection to the given target, it must be shutdown.
 165  *
 166  * @param target peer to disconnect from
 167  */
 168 void
 169 GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target);
 170
 171
 172 /**
 173  * Function called for each connected neighbour.
 174  *
 175  * @param cls closure
 176  * @param neighbour identity of the neighbour
 177  * @param address the address (or NULL)
 178  * @param bandwidth_in inbound quota in NBO
 179  * @param bandwidth_out outbound quota in NBO
 180  */
 181 typedef void (*GST_NeighbourIterator) (void *cls,
 182                                        const struct GNUNET_PeerIdentity *
 183                                        neighbour,
 184                                        const struct GNUNET_HELLO_Address *
 185                                        address,
 186                                        struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
 187                                        struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
 188
 189
 190 /**
 191  * Iterate over all connected neighbours.
 192  *
 193  * @param cb function to call
 194  * @param cb_cls closure for @a cb
 195  */
 196 void
 197 GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls);
 198
 199
 200 /**
 201  * A session was terminated. Take note.
 202  *
 203  * @param peer identity of the peer where the session died
 204  * @param session session that is gone
 205  * @return #GNUNET_YES if this was a session used, #GNUNET_NO if
 206  *        this session was not in use
 207  */
 208 int
 209 GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
 210                                    struct Session *session);
 211
 212
 213 void
 214 GST_neighbours_notify_data_recv (const struct GNUNET_PeerIdentity *peer,
 215                                  const struct GNUNET_HELLO_Address *address,
 216                                  struct Session *session,
 217                                  const struct GNUNET_MessageHeader *message);
 218
 219
 220 void
 221 GST_neighbours_notify_payload_recv (const struct GNUNET_PeerIdentity *peer,
 222                                     const struct GNUNET_HELLO_Address *address,
 223                                     struct Session *session,
 224                                     const struct GNUNET_MessageHeader *message);
 225
 226
 227 void
 228 GST_neighbours_notify_payload_sent (const struct GNUNET_PeerIdentity *peer,
 229                                     size_t size);
 230
 231
 232 void
 233 GST_neighbours_notify_data_sent (const struct GNUNET_PeerIdentity *peer,
 234                                  const struct GNUNET_HELLO_Address *address,
 235                                  struct Session *session,
 236                                  size_t size);
 237
 238
 239 /**
 240  * For an existing neighbour record, set the active connection to
 241  * use the given address.
 242  *
 243  * @param peer identity of the peer to switch the address for
 244  * @param address address of the other peer, NULL if other peer
 245  *                       connected to us
 246  * @param session session to use (or NULL)
 247  * @param ats performance data
 248  * @param ats_count number of entries in ats
 249  * @param bandwidth_in inbound quota to be used when connection is up
 250  * @param bandwidth_out outbound quota to be used when connection is up
 251  */
 252 void
 253 GST_neighbours_switch_to_address (const struct GNUNET_PeerIdentity *peer,
 254                                   const struct GNUNET_HELLO_Address *address,
 255                                   struct Session *session,
 256                                   const struct GNUNET_ATS_Information *ats,
 257                                   uint32_t ats_count,
 258                                   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
 259                                   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
 260
 261
 262 /**
 263  * We received a 'SESSION_CONNECT' message from the other peer.
 264  * Consider switching to it.
 265  *
 266  * @param message possibly a 'struct SessionConnectMessage' (check format)
 267  * @param peer identity of the peer to switch the address for
 268  * @param address address of the other peer, NULL if other peer
 269  *                       connected to us
 270  * @param session session to use (or NULL)
 271  * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
 272  */
 273 int
 274 GST_neighbours_handle_connect (const struct GNUNET_MessageHeader *message,
 275                                const struct GNUNET_PeerIdentity *peer,
 276                                const struct GNUNET_HELLO_Address *address,
 277                                struct Session *session);
 278
 279
 280 /**
 281  * We received a 'SESSION_CONNECT_ACK' message from the other peer.
 282  * Consider switching to it.
 283  *
 284  * @param message possibly a 'struct SessionConnectMessage' (check format)
 285  * @param peer identity of the peer to switch the address for
 286  * @param address address of the other peer, NULL if other peer
 287  *                       connected to us
 288  * @param session session to use (or NULL)
 289  * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
 290  */
 291 int
 292 GST_neighbours_handle_connect_ack (const struct GNUNET_MessageHeader *message,
 293                                    const struct GNUNET_PeerIdentity *peer,
 294                                    const struct GNUNET_HELLO_Address *address,
 295                                    struct Session *session);
 296
 297
 298 /**
 299  * We received a 'SESSION_ACK' message from the other peer.
 300  * If we sent a 'CONNECT_ACK' last, this means we are now
 301  * connected.  Otherwise, do nothing.
 302  *
 303  * @param message possibly a 'struct SessionConnectMessage' (check format)
 304  * @param peer identity of the peer to switch the address for
 305  * @param address address of the other peer, NULL if other peer
 306  *                       connected to us
 307  * @param session session to use (or NULL)
 308  * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
 309  */
 310 int
 311 GST_neighbours_handle_session_ack (const struct GNUNET_MessageHeader *message,
 312                                    const struct GNUNET_PeerIdentity *peer,
 313                                    const struct GNUNET_HELLO_Address *address,
 314                                    struct Session *session);
 315
 316
 317 /**
 318  * Obtain current latency information for the given neighbour.
 319  *
 320  * @param peer
 321  * @return observed latency of the address, FOREVER if the address was
 322  *         never successfully validated
 323  */
 324 struct GNUNET_TIME_Relative
 325 GST_neighbour_get_latency (const struct GNUNET_PeerIdentity *peer);
 326
 327
 328 /**
 329  * Obtain current address information for the given neighbour.
 330  *
 331  * @param peer
 332  * @return address currently used
 333  */
 334 struct GNUNET_HELLO_Address *
 335 GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer);
 336
 337
 338 /**
 339  * We received a disconnect message from the given peer,
 340  * validate and process.
 341  *
 342  * @param peer sender of the message
 343  * @param msg the disconnect message
 344  */
 345 void
 346 GST_neighbours_handle_disconnect_message (const struct GNUNET_PeerIdentity
 347                                           *peer,
 348                                           const struct GNUNET_MessageHeader
 349                                           *msg);
 350
 351
 352 #endif
 353 /* end of file gnunet-service-transport_neighbours.h */