src/transport/gnunet-service-transport_neighbours.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2010-2015 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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, 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
  37 /**
  38  * Initialize the neighbours subsystem.
  39  *
  40  * @param max_fds maximum number of fds to use
  41  */
  42 void
  43 GST_neighbours_start (unsigned int max_fds);
  44
  45
  46 /**
  47  * Cleanup the neighbours subsystem.
  48  */
  49 void
  50 GST_neighbours_stop (void);
  51
  52
  53 /**
  54  * Try to create a connection to the given target (eventually).
  55  *
  56  * @param target peer to try to connect to
  57  */
  58 void
  59 GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target);
  60
  61
  62 /**
  63  * Test if we're connected to the given peer.
  64  *
  65  * @param target peer to test
  66  * @return #GNUNET_YES if we are connected, #GNUNET_NO if not
  67  */
  68 int
  69 GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target);
  70
  71
  72 /**
  73  * Function called after the transmission is done.
  74  *
  75  * @param cls closure
  76  * @param success #GNUNET_OK on success, #GNUNET_NO on failure, #GNUNET_SYSERR if we're not connected
  77  * @param bytes_payload how much payload was transmitted
  78  * @param bytes_on_wire how many bytes were used on the wire
  79  */
  80 typedef void
  81 (*GST_NeighbourSendContinuation) (void *cls,
  82                                   int success,
  83                                   size_t bytes_payload,
  84                                   size_t bytes_on_wire);
  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 msg_size number of bytes in @a msg
  93  * @param timeout when to fail with timeout
  94  * @param cont function to call when done
  95  * @param cont_cls closure for @a cont
  96  */
  97 void
  98 GST_neighbours_send (const struct GNUNET_PeerIdentity *target,
  99                      const void *msg,
 100                      size_t msg_size,
 101                      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 *sender,
 118                                         ssize_t size,
 119                                         int *do_forward);
 120
 121
 122 /**
 123  * Keep the connection to the given neighbour alive longer,
 124  * we received a KEEPALIVE (or equivalent); send a response.
 125  *
 126  * @param neighbour neighbour to keep alive (by sending keep alive response)
 127  * @param m the keep alive message containing the nonce to respond to
 128  */
 129 void
 130 GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour,
 131                           const struct GNUNET_MessageHeader *m);
 132
 133
 134 /**
 135  * We received a KEEP_ALIVE_RESPONSE message and use this to calculate
 136  * latency to this peer.  Pass the updated information (existing ats
 137  * plus calculated latency) to ATS.
 138  *
 139  * @param neighbour neighbour to keep alive
 140  * @param m the message containing the keep alive response
 141  */
 142 void
 143 GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour,
 144                                    const struct GNUNET_MessageHeader *m);
 145
 146
 147 /**
 148  * If we have an active connection to the given target, it must be shutdown.
 149  *
 150  * @param target peer to disconnect from
 151  */
 152 void
 153 GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target);
 154
 155
 156 /**
 157  * Function called for each neighbour.
 158  *
 159  * @param cls closure
 160  * @param peer identity of the neighbour
 161  * @param address the address of the neighbour
 162  * @param state current state the peer is in
 163  * @param state_timeout timeout for this state
 164  * @param bandwidth_in inbound quota in NBO
 165  * @param bandwidth_out outbound quota in NBO
 166  */
 167 typedef void
 168 (*GST_NeighbourIterator) (void *cls,
 169                           const struct GNUNET_PeerIdentity *peer,
 170                           const struct GNUNET_HELLO_Address *address,
 171                           enum GNUNET_TRANSPORT_PeerState state,
 172                           struct GNUNET_TIME_Absolute state_timeout,
 173                           struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
 174                           struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
 175
 176
 177 /**
 178  * Iterate over all connected neighbours.
 179  *
 180  * @param cb function to call
 181  * @param cb_cls closure for @a cb
 182  */
 183 void
 184 GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls);
 185
 186
 187 /**
 188  * A session was terminated. Take note.
 189  *
 190  * @param peer identity of the peer where the session died
 191  * @param session session that is gone
 192  * @return #GNUNET_YES if this was a session used, #GNUNET_NO if
 193  *        this session was not in use
 194  */
 195 int
 196 GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
 197                                    struct GNUNET_ATS_Session *session);
 198
 199
 200 /**
 201  * Track information about data we received from the
 202  * given address (used to notify ATS about our utilization
 203  * of allocated resources).
 204  *
 205  * @param address the address we got data from
 206  * @param message the message we received (really only the size is used)
 207  */
 208 void
 209 GST_neighbours_notify_data_recv (const struct GNUNET_HELLO_Address *address,
 210                                  const struct GNUNET_MessageHeader *message);
 211
 212
 213 /**
 214  * Track information about data we transmitted using the given @a
 215  * address and @a session (used to notify ATS about our utilization of
 216  * allocated resources).
 217  *
 218  * @param address the address we transmitted data to
 219  * @param session session we used to transmit data
 220  * @param message the message we sent (really only the size is used)
 221  */
 222 void
 223 GST_neighbours_notify_data_sent (const struct GNUNET_HELLO_Address *address,
 224                                  struct GNUNET_ATS_Session *session,
 225                                  size_t size);
 226
 227
 228 /**
 229  * For an existing neighbour record, set the active connection to
 230  * use the given address.
 231  *
 232  * @param address address of the other peer to start using
 233  * @param session session to use (or NULL)
 234  * @param bandwidth_in inbound quota to be used when connection is up
 235  * @param bandwidth_out outbound quota to be used when connection is up
 236  */
 237 void
 238 GST_neighbours_switch_to_address (const struct GNUNET_HELLO_Address *address,
 239                                   struct GNUNET_ATS_Session *session,
 240                                   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
 241                                   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
 242
 243
 244 /**
 245  * We received a 'SESSION_CONNECT' message from the other peer.
 246  * Consider switching to it.
 247  *
 248  * @param message possibly a 'struct GNUNET_ATS_SessionConnectMessage' (check format)
 249  * @param peer identity of the peer to switch the address for
 250  * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
 251  */
 252 int
 253 GST_neighbours_handle_session_syn (const struct GNUNET_MessageHeader *message,
 254                                    const struct GNUNET_PeerIdentity *peer);
 255
 256
 257 /**
 258  * We received a 'SESSION_CONNECT_ACK' message from the other peer.
 259  * Consider switching to it.
 260  *
 261  * @param message possibly a `struct GNUNET_ATS_SessionConnectMessage` (check format)
 262  * @param address address of the other peer
 263  * @param session session to use (or NULL)
 264  * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
 265  */
 266 int
 267 GST_neighbours_handle_session_syn_ack (const struct GNUNET_MessageHeader *message,
 268                                        const struct GNUNET_HELLO_Address *address,
 269                                        struct GNUNET_ATS_Session *session);
 270
 271
 272 /**
 273  * We received a 'SESSION_ACK' message from the other peer.
 274  * If we sent a 'CONNECT_ACK' last, this means we are now
 275  * connected.  Otherwise, do nothing.
 276  *
 277  * @param message possibly a 'struct GNUNET_ATS_SessionConnectMessage' (check format)
 278  * @param address address of the other peer
 279  * @param session session to use (or NULL)
 280  * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
 281  */
 282 int
 283 GST_neighbours_handle_session_ack (const struct GNUNET_MessageHeader *message,
 284                                    const struct GNUNET_HELLO_Address *address,
 285                                    struct GNUNET_ATS_Session *session);
 286
 287
 288 /**
 289  * Obtain current address information for the given neighbour.
 290  *
 291  * @param peer
 292  * @return address currently used
 293  */
 294 const struct GNUNET_HELLO_Address *
 295 GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer);
 296
 297
 298 /**
 299  * We received a quoat message from the given peer,
 300  * validate and process.
 301  *
 302  * @param peer sender of the message
 303  * @param msg the quota message
 304  */
 305 void
 306 GST_neighbours_handle_quota_message (const struct GNUNET_PeerIdentity *peer,
 307                                      const struct GNUNET_MessageHeader *msg);
 308
 309
 310 /**
 311  * We received a disconnect message from the given peer,
 312  * validate and process.
 313  *
 314  * @param peer sender of the message
 315  * @param msg the disconnect message
 316  */
 317 void
 318 GST_neighbours_handle_disconnect_message (const struct GNUNET_PeerIdentity *peer,
 319                                           const struct GNUNET_MessageHeader *msg);
 320
 321
 322 #endif
 323 /* end of file gnunet-service-transport_neighbours.h */