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 msg
 100  * @param timeout when to fail with timeout
 101  * @param cont function to call when done
 102  * @param cont_cls closure for '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  * @param ats performance data
 142  * @param ats_count number of entries in ats
 143  */
 144 void
 145 GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour,
 146                                    const struct GNUNET_ATS_Information *ats,
 147                                    uint32_t ats_count);
 148
 149
 150 /**
 151  * Change the incoming quota for the given peer.
 152  *
 153  * @param neighbour identity of peer to change qutoa for
 154  * @param quota new quota
 155  */
 156 void
 157 GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
 158                                    struct GNUNET_BANDWIDTH_Value32NBO quota);
 159
 160
 161 /**
 162  * If we have an active connection to the given target, it must be shutdown.
 163  *
 164  * @param target peer to disconnect from
 165  */
 166 void
 167 GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target);
 168
 169
 170 /**
 171  * Function called for each connected neighbour.
 172  *
 173  * @param cls closure
 174  * @param neighbour identity of the neighbour
 175  * @param ats performance data
 176  * @param ats_count number of entries in ats (including 0-termination)
 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_ATS_Information *
 185                                        ats, uint32_t ats_count,
 186                                        const struct GNUNET_HELLO_Address *
 187                                        address,
 188                                        struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
 189                                        struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
 190
 191
 192 /**
 193  * Iterate over all connected neighbours.
 194  *
 195  * @param cb function to call
 196  * @param cb_cls closure for cb
 197  */
 198 void
 199 GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls);
 200
 201
 202 /**
 203  * A session was terminated. Take note.
 204  *
 205  * @param peer identity of the peer where the session died
 206  * @param session session that is gone
 207  * @return GNUNET_YES if this was a session used, GNUNET_NO if
 208  *        this session was not in use
 209  */
 210 int
 211 GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
 212                                    struct Session *session);
 213
 214
 215 /**
 216  * For an existing neighbour record, set the active connection to
 217  * use the given address.
 218  *
 219  * @param peer identity of the peer to switch the address for
 220  * @param address address of the other peer, NULL if other peer
 221  *                       connected to us
 222  * @param session session to use (or NULL)
 223  * @param ats performance data
 224  * @param ats_count number of entries in ats
 225  * @param bandwidth_in inbound quota to be used when connection is up
 226  * @param bandwidth_out outbound quota to be used when connection is up
 227  */
 228 void
 229 GST_neighbours_switch_to_address (const struct GNUNET_PeerIdentity *peer,
 230                                        const struct GNUNET_HELLO_Address
 231                                        *address, struct Session *session,
 232                                        const struct GNUNET_ATS_Information *ats,
 233                                        uint32_t ats_count,
 234                                        struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
 235                                        struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
 236
 237
 238 /**
 239  * We received a 'SESSION_CONNECT' message from the other peer.
 240  * Consider switching to it.
 241  *
 242  * @param message possibly a 'struct SessionConnectMessage' (check format)
 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 (excluding 0-termination)
 249   */
 250 void
 251 GST_neighbours_handle_connect (const struct GNUNET_MessageHeader *message,
 252                                const struct GNUNET_PeerIdentity *peer,
 253                                const struct GNUNET_HELLO_Address *address,
 254                                struct Session *session,
 255                                const struct GNUNET_ATS_Information *ats,
 256                                uint32_t ats_count);
 257
 258
 259 /**
 260  * We received a 'SESSION_CONNECT_ACK' message from the other peer.
 261  * Consider switching to it.
 262  *
 263  * @param message possibly a 'struct SessionConnectMessage' (check format)
 264  * @param peer identity of the peer to switch the address for
 265  * @param address address of the other peer, NULL if other peer
 266  *                       connected to us
 267  * @param session session to use (or NULL)
 268  * @param ats performance data
 269  * @param ats_count number of entries in ats
 270  */
 271 void
 272 GST_neighbours_handle_connect_ack (const struct GNUNET_MessageHeader *message,
 273                                    const struct GNUNET_PeerIdentity *peer,
 274                                    const struct GNUNET_HELLO_Address *address,
 275                                    struct Session *session,
 276                                    const struct GNUNET_ATS_Information *ats,
 277                                    uint32_t ats_count);
 278
 279
 280 /**
 281  * We received a 'SESSION_ACK' message from the other peer.
 282  * FIXME: describe what this means!
 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  * @param ats performance data
 290  * @param ats_count number of entries in ats
 291  */
 292 void
 293 GST_neighbours_handle_session_ack (const struct GNUNET_MessageHeader *message,
 294                                    const struct GNUNET_PeerIdentity *peer,
 295                                    const struct GNUNET_HELLO_Address *address,
 296                                    struct Session *session,
 297                                    const struct GNUNET_ATS_Information *ats,
 298                                    uint32_t ats_count);
 299
 300
 301 /**
 302  * Obtain current latency information for the given neighbour.
 303  *
 304  * @param peer
 305  * @return observed latency of the address, FOREVER if the address was
 306  *         never successfully validated
 307  */
 308 struct GNUNET_TIME_Relative
 309 GST_neighbour_get_latency (const struct GNUNET_PeerIdentity *peer);
 310
 311
 312 /**
 313  * Obtain current address information for the given neighbour.
 314  *
 315  * @param peer
 316  * @return address currently used
 317  */
 318 struct GNUNET_HELLO_Address *
 319 GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer);
 320
 321
 322 /**
 323  * We received a disconnect message from the given peer,
 324  * validate and process.
 325  *
 326  * @param peer sender of the message
 327  * @param msg the disconnect message
 328  */
 329 void
 330 GST_neighbours_handle_disconnect_message (const struct GNUNET_PeerIdentity
 331                                           *peer,
 332                                           const struct GNUNET_MessageHeader
 333                                           *msg);
 334
 335
 336 #endif
 337 /* end of file gnunet-service-transport_neighbours.h */