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