src/mesh/gnunet-service-mesh_connection.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2013 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 mesh/gnunet-service-mesh_connection.h
  23  * @brief mesh service; dealing with connections
  24  * @author Bartlomiej Polot
  25  *
  26  * All functions in this file should use the prefix GMC (Gnunet Mesh Connection)
  27  */
  28
  29 #ifndef GNUNET_SERVICE_MESH_CONNECTION_H
  30 #define GNUNET_SERVICE_MESH_CONNECTION_H
  31
  32 #ifdef __cplusplus
  33 extern "C"
  34 {
  35 #if 0                           /* keep Emacsens' auto-indent happy */
  36 }
  37 #endif
  38 #endif
  39
  40 #include "gnunet_util_lib.h"
  41
  42 #include "mesh_path.h"
  43 #include "gnunet-service-mesh_channel.h"
  44 #include "gnunet-service-mesh_peer.h"
  45
  46
  47 /**
  48  * All the states a connection can be in.
  49  */
  50 enum MeshConnectionState
  51 {
  52   /**
  53    * Uninitialized status, should never appear in operation.
  54    */
  55   MESH_CONNECTION_NEW,
  56
  57   /**
  58    * Connection create message sent, waiting for ACK.
  59    */
  60   MESH_CONNECTION_SENT,
  61
  62   /**
  63    * Connection ACK sent, waiting for ACK.
  64    */
  65   MESH_CONNECTION_ACK,
  66
  67   /**
  68    * Connection confirmed, ready to carry traffic.
  69    */
  70   MESH_CONNECTION_READY,
  71 };
  72
  73
  74 /**
  75  * Struct containing all information regarding a connection to a peer.
  76  */
  77 struct MeshConnection;
  78
  79
  80
  81
  82 /**
  83  * Core handler for connection creation.
  84  *
  85  * @param cls Closure (unused).
  86  * @param peer Sender (neighbor).
  87  * @param message Message.
  88  *
  89  * @return GNUNET_OK to keep the connection open,
  90  *         GNUNET_SYSERR to close it (signal serious error)
  91  */
  92 int
  93 GMC_handle_create (void *cls, const struct GNUNET_PeerIdentity *peer,
  94                    const struct GNUNET_MessageHeader *message);
  95
  96 /**
  97  * Core handler for path confirmations.
  98  *
  99  * @param cls closure
 100  * @param message message
 101  * @param peer peer identity this notification is about
 102  *
 103  * @return GNUNET_OK to keep the connection open,
 104  *         GNUNET_SYSERR to close it (signal serious error)
 105  */
 106 int
 107 GMC_handle_confirm (void *cls, const struct GNUNET_PeerIdentity *peer,
 108                     const struct GNUNET_MessageHeader *message);
 109
 110 /**
 111  * Core handler for notifications of broken paths
 112  *
 113  * @param cls Closure (unused).
 114  * @param peer Peer identity of sending neighbor.
 115  * @param message Message.
 116  *
 117  * @return GNUNET_OK to keep the connection open,
 118  *         GNUNET_SYSERR to close it (signal serious error)
 119  */
 120 int
 121 GMC_handle_broken (void *cls, const struct GNUNET_PeerIdentity *peer,
 122                    const struct GNUNET_MessageHeader *message);
 123
 124 /**
 125  * Core handler for tunnel destruction
 126  *
 127  * @param cls Closure (unused).
 128  * @param peer Peer identity of sending neighbor.
 129  * @param message Message.
 130  *
 131  * @return GNUNET_OK to keep the connection open,
 132  *         GNUNET_SYSERR to close it (signal serious error)
 133  */
 134 int
 135 GMC_handle_destroy (void *cls, const struct GNUNET_PeerIdentity *peer,
 136                     const struct GNUNET_MessageHeader *message);
 137
 138 /**
 139  * Core handler for mesh network traffic going orig->dest.
 140  *
 141  * @param cls Closure (unused).
 142  * @param message Message received.
 143  * @param peer Peer who sent the message.
 144  *
 145  * @return GNUNET_OK to keep the connection open,
 146  *         GNUNET_SYSERR to close it (signal serious error)
 147  */
 148 int
 149 GMC_handle_fwd (void *cls, const struct GNUNET_PeerIdentity *peer,
 150                 const struct GNUNET_MessageHeader *message);
 151
 152
 153 /**
 154  * Core handler for mesh network traffic going dest->orig.
 155  *
 156  * @param cls Closure (unused).
 157  * @param message Message received.
 158  * @param peer Peer who sent the message.
 159  *
 160  * @return GNUNET_OK to keep the connection open,
 161  *         GNUNET_SYSERR to close it (signal serious error)
 162  */
 163 int
 164 GMC_handle_bck (void *cls, const struct GNUNET_PeerIdentity *peer,
 165                 const struct GNUNET_MessageHeader *message);
 166
 167 /**
 168  * Core handler for mesh network traffic point-to-point acks.
 169  *
 170  * @param cls closure
 171  * @param message message
 172  * @param peer peer identity this notification is about
 173  *
 174  * @return GNUNET_OK to keep the connection open,
 175  *         GNUNET_SYSERR to close it (signal serious error)
 176  */
 177 int
 178 GMC_handle_ack (void *cls, const struct GNUNET_PeerIdentity *peer,
 179                 const struct GNUNET_MessageHeader *message);
 180
 181 /**
 182  * Core handler for mesh network traffic point-to-point ack polls.
 183  *
 184  * @param cls closure
 185  * @param message message
 186  * @param peer peer identity this notification is about
 187  *
 188  * @return GNUNET_OK to keep the connection open,
 189  *         GNUNET_SYSERR to close it (signal serious error)
 190  */
 191 int
 192 GMC_handle_poll (void *cls, const struct GNUNET_PeerIdentity *peer,
 193                  const struct GNUNET_MessageHeader *message);
 194
 195 /**
 196  * Core handler for mesh keepalives.
 197  *
 198  * @param cls closure
 199  * @param message message
 200  * @param peer peer identity this notification is about
 201  * @return GNUNET_OK to keep the connection open,
 202  *         GNUNET_SYSERR to close it (signal serious error)
 203  *
 204  * TODO: Check who we got this from, to validate route.
 205  */
 206 int
 207 GMC_handle_keepalive (void *cls, const struct GNUNET_PeerIdentity *peer,
 208                       const struct GNUNET_MessageHeader *message);
 209
 210 /**
 211  * Initialize the connections subsystem
 212  *
 213  * @param c Configuration handle.
 214  */
 215 void
 216 GMC_init (const struct GNUNET_CONFIGURATION_Handle *c);
 217
 218 /**
 219  * Shut down the connections subsystem.
 220  */
 221 void
 222 GMC_shutdown (void);
 223
 224 /**
 225  * Create a connection.
 226  *
 227  * @param cid Connection ID (either created locally or imposed remotely).
 228  * @param t Tunnel this connection belongs to (or NULL);
 229  * @param p Path this connection has to use.
 230  * @param own_pos Own position in the @c p path.
 231  */
 232 struct MeshConnection *
 233 GMC_new (const struct GNUNET_HashCode *cid,
 234          struct MeshTunnel3 *t,
 235          struct MeshPeerPath *p,
 236          unsigned int own_pos);
 237
 238 /**
 239  * Connection is no longer needed: destroy it and remove from tunnel.
 240  *
 241  * @param c Connection to destroy.
 242  */
 243 void
 244 GMC_destroy (struct MeshConnection *c);
 245
 246 struct MeshConnection *
 247 GMC_next (struct MeshConnection *c);
 248
 249 /**
 250  * Get the connection ID.
 251  *
 252  * @param c Connection to get the ID from.
 253  *
 254  * @return ID of the connection.
 255  */
 256 const struct GNUNET_HashCode *
 257 GMC_get_id (const struct MeshConnection *c);
 258
 259 /**
 260  * Get the connection state.
 261  *
 262  * @param c Connection to get the state from.
 263  *
 264  * @return state of the connection.
 265  */
 266 enum MeshConnectionState
 267 GMC_get_state (const struct MeshConnection *c);
 268
 269 /**
 270  * Get free buffer space in a connection.
 271  *
 272  * @param c Connection.
 273  * @param fwd Is query about FWD traffic?
 274  *
 275  * @return Free buffer space [0 - max_msgs_queue/max_connections]
 276  */
 277 unsigned int
 278 GMC_get_buffer (struct MeshConnection *c, int fwd);
 279
 280 /**
 281  * Get messages queued in a connection.
 282  *
 283  * @param c Connection.
 284  * @param fwd Is query about FWD traffic?
 285  *
 286  * @return Number of messages queued.
 287  */
 288 unsigned int
 289 GMC_get_qn (struct MeshConnection *c, int fwd);
 290
 291 /**
 292  * Send FWD keepalive packets for a connection.
 293  *
 294  * @param cls Closure (connection for which to send the keepalive).
 295  * @param tc Notification context.
 296  */
 297 void
 298 GMC_fwd_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 299
 300 /**
 301  * Send BCK keepalive packets for a connection.
 302  *
 303  * @param cls Closure (connection for which to send the keepalive).
 304  * @param tc Notification context.
 305  */
 306 void
 307 GMC_bck_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 308
 309
 310 /**
 311  * Change the tunnel state.
 312  *
 313  * @param c Connection whose state to change.
 314  * @param state New state.
 315  */
 316 void
 317 GMC_change_state (struct MeshConnection* c, enum MeshConnectionState state);
 318
 319 /**
 320  * Notify other peers on a connection of a broken link. Mark connections
 321  * to destroy after all traffic has been sent.
 322  *
 323  * @param c Connection on which there has been a disconnection.
 324  * @param peer Peer that disconnected.
 325  * @param my_full_id My ID (to send to other peers).
 326  */
 327 void
 328 GMC_notify_broken (struct MeshConnection *c,
 329                    struct MeshPeer *peer,
 330                    struct GNUNET_PeerIdentity *my_full_id);
 331
 332 /**
 333  * Is this peer the first one on the connection?
 334  *
 335  * @param c Connection.
 336  * @param fwd Is this about fwd traffic?
 337  *
 338  * @return GNUNET_YES if origin, GNUNET_NO if relay/terminal.
 339  */
 340 int
 341 GMC_is_origin (struct MeshConnection *c, int fwd);
 342
 343 /**
 344  * Is this peer the last one on the connection?
 345  *
 346  * @param c Connection.
 347  * @param fwd Is this about fwd traffic?
 348  *            Note that the ROOT is the terminal for BCK traffic!
 349  *
 350  * @return GNUNET_YES if terminal, GNUNET_NO if relay/origin.
 351  */
 352 int
 353 GMC_is_terminal (struct MeshConnection *c, int fwd);
 354
 355 /**
 356  * Sends an already built message on a connection, properly registering
 357  * all used resources.
 358  *
 359  * @param message Message to send. Function makes a copy of it.
 360  *                If message is not hop-by-hop, decrements TTL of copy.
 361  * @param c Connection on which this message is transmitted.
 362  * @param ch Channel on which this message is transmitted, or NULL.
 363  * @param fwd Is this a fwd message?
 364  */
 365 void
 366 GMC_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
 367                            struct MeshConnection *c,
 368                            struct MeshChannel *ch,
 369                            int fwd);
 370
 371 /**
 372  * Send a message to all peers in this connection that the connection
 373  * is no longer valid.
 374  *
 375  * If some peer should not receive the message, it should be zero'ed out
 376  * before calling this function.
 377  *
 378  * @param c The connection whose peers to notify.
 379  */
 380 void
 381 GMC_send_destroy (struct MeshConnection *c);
 382
 383 #if 0                           /* keep Emacsens' auto-indent happy */
 384 {
 385 #endif
 386 #ifdef __cplusplus
 387 }
 388 #endif
 389
 390 /* ifndef GNUNET_SERVICE_MESH_CONNECTION_H */
 391 #endif
 392 /* end of gnunet-service-mesh_connection.h */