2 This file is part of GNUnet.
3 Copyright (C) 2013 GNUnet e.V.
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.
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.
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.
22 * @file cadet/gnunet-service-cadet_connection.h
23 * @brief cadet service; dealing with connections
24 * @author Bartlomiej Polot
26 * All functions in this file use the prefix GCC (GNUnet Cadet Connection)
29 #ifndef GNUNET_SERVICE_CADET_CONNECTION_H
30 #define GNUNET_SERVICE_CADET_CONNECTION_H
35 #if 0 /* keep Emacsens' auto-indent happy */
40 #include "gnunet_util_lib.h"
44 * All the states a connection can be in.
46 enum CadetConnectionState
49 * Uninitialized status, should never appear in operation.
54 * Connection create message sent, waiting for ACK.
56 CADET_CONNECTION_SENT,
59 * Connection ACK sent, waiting for ACK.
64 * Connection confirmed, ready to carry traffic.
66 CADET_CONNECTION_READY,
69 * Connection to be destroyed, just waiting to empty queues.
71 CADET_CONNECTION_DESTROYED,
74 * Connection to be destroyed because of a distant peer, same as DESTROYED.
76 CADET_CONNECTION_BROKEN,
81 * Struct containing all information regarding a connection to a peer.
83 struct CadetConnection;
86 * Handle for messages queued but not yet sent.
88 struct CadetConnectionQueue;
90 #include "cadet_path.h"
91 #include "gnunet-service-cadet_channel.h"
92 #include "gnunet-service-cadet_peer.h"
96 * Check invariants for all connections using #check_neighbours().
99 GCC_check_connections (void);
103 * Callback called when a queued message is sent.
105 * @param cls Closure.
106 * @param c Connection this message was on.
107 * @param type Type of message sent.
108 * @param fwd Was this a FWD going message?
109 * @param size Size of the message.
112 (*GCC_sent) (void *cls,
113 struct CadetConnection *c,
114 struct CadetConnectionQueue *q,
121 * Handler for connection creation.
123 * @param peer Message sender (neighbor).
124 * @param msg Message itself.
127 GCC_handle_create (struct CadetPeer *peer,
128 const struct GNUNET_CADET_ConnectionCreateMessage *msg);
132 * Handler for connection confirmations.
134 * @param peer Message sender (neighbor).
135 * @param msg Message itself.
138 GCC_handle_confirm (struct CadetPeer *peer,
139 const struct GNUNET_CADET_ConnectionCreateAckMessage *msg);
143 * Handler for notifications of broken connections.
145 * @param peer Message sender (neighbor).
146 * @param msg Message itself.
149 GCC_handle_broken (struct CadetPeer *peer,
150 const struct GNUNET_CADET_ConnectionBrokenMessage *msg);
153 * Handler for notifications of destroyed connections.
155 * @param peer Message sender (neighbor).
156 * @param msg Message itself.
159 GCC_handle_destroy (struct CadetPeer *peer,
160 const struct GNUNET_CADET_ConnectionDestroyMessage *msg);
163 * Handler for cadet network traffic hop-by-hop acks.
165 * @param peer Message sender (neighbor).
166 * @param msg Message itself.
169 GCC_handle_ack (struct CadetPeer *peer,
170 const struct GNUNET_CADET_ConnectionEncryptedAckMessage *msg);
173 * Handler for cadet network traffic hop-by-hop data counter polls.
175 * @param peer Message sender (neighbor).
176 * @param msg Message itself.
179 GCC_handle_poll (struct CadetPeer *peer,
180 const struct GNUNET_CADET_ConnectionHopByHopPollMessage *msg);
183 * Handler for key exchange traffic (Axolotl KX).
185 * @param peer Message sender (neighbor).
186 * @param msg Message itself.
189 GCC_handle_kx (struct CadetPeer *peer,
190 const struct GNUNET_CADET_TunnelKeyExchangeMessage *msg);
193 * Handler for encrypted cadet network traffic (channel mgmt, data).
195 * @param peer Message sender (neighbor).
196 * @param msg Message itself.
199 GCC_handle_encrypted (struct CadetPeer *peer,
200 const struct GNUNET_CADET_TunnelEncryptedMessage *msg);
203 * Core handler for axolotl key exchange traffic.
205 * @param cls Closure (unused).
206 * @param message Message received.
207 * @param peer Neighbor who sent the message.
209 * @return GNUNET_OK, to keep the connection open.
212 GCC_handle_ax_kx (void *cls, const struct GNUNET_PeerIdentity *peer,
213 const struct GNUNET_MessageHeader *message);
216 * Core handler for axolotl encrypted cadet network traffic.
218 * @param cls Closure (unused).
219 * @param message Message received.
220 * @param peer Neighbor who sent the message.
222 * @return GNUNET_OK, to keep the connection open.
225 GCC_handle_ax (void *cls, const struct GNUNET_PeerIdentity *peer,
226 struct GNUNET_MessageHeader *message);
229 * Core handler for cadet keepalives.
232 * @param message message
233 * @param peer peer identity this notification is about
234 * @return GNUNET_OK to keep the connection open,
235 * GNUNET_SYSERR to close it (signal serious error)
237 * TODO: Check who we got this from, to validate route.
240 GCC_handle_keepalive (void *cls, const struct GNUNET_PeerIdentity *peer,
241 const struct GNUNET_MessageHeader *message);
244 * Send an ACK on the appropriate connection/channel, depending on
245 * the direction and the position of the peer.
247 * @param c Which connection to send the hop-by-hop ACK.
248 * @param fwd Is this a fwd ACK? (will go dest->root).
249 * @param force Send the ACK even if suboptimal (e.g. requested by POLL).
252 GCC_send_ack (struct CadetConnection *c, int fwd, int force);
255 * Initialize the connections subsystem
257 * @param c Configuration handle.
260 GCC_init (const struct GNUNET_CONFIGURATION_Handle *c);
263 * Shut down the connections subsystem.
269 * Create a connection.
271 * @param cid Connection ID (either created locally or imposed remotely).
272 * @param t Tunnel this connection belongs to (or NULL for transit connections);
273 * @param path Path this connection has to use (copy is made).
274 * @param own_pos Own position in the @c path path.
276 * @return Newly created connection.
277 * NULL in case of error: own id not in path, wrong neighbors, ...
279 struct CadetConnection *
280 GCC_new (const struct GNUNET_CADET_ConnectionTunnelIdentifier *cid,
281 struct CadetTunnel *t,
282 struct CadetPeerPath *path,
283 unsigned int own_pos);
286 * Connection is no longer needed: destroy it.
288 * Cancels all pending traffic (including possible DESTROY messages), all
289 * maintenance tasks and removes the connection from neighbor peers and tunnel.
291 * @param c Connection to destroy.
294 GCC_destroy (struct CadetConnection *c);
297 * Get the connection ID.
299 * @param c Connection to get the ID from.
301 * @return ID of the connection.
303 const struct GNUNET_CADET_ConnectionTunnelIdentifier *
304 GCC_get_id (const struct CadetConnection *c);
308 * Get the connection path.
310 * @param c Connection to get the path from.
312 * @return path used by the connection.
314 const struct CadetPeerPath *
315 GCC_get_path (const struct CadetConnection *c);
318 * Get the connection state.
320 * @param c Connection to get the state from.
322 * @return state of the connection.
324 enum CadetConnectionState
325 GCC_get_state (const struct CadetConnection *c);
328 * Get the connection tunnel.
330 * @param c Connection to get the tunnel from.
332 * @return tunnel of the connection.
335 GCC_get_tunnel (const struct CadetConnection *c);
338 * Get free buffer space in a connection.
340 * @param c Connection.
341 * @param fwd Is query about FWD traffic?
343 * @return Free buffer space [0 - max_msgs_queue/max_connections]
346 GCC_get_buffer (struct CadetConnection *c, int fwd);
349 * Get how many messages have we allowed to send to us from a direction.
351 * @param c Connection.
352 * @param fwd Are we asking about traffic from FWD (BCK messages)?
354 * @return last_ack_sent - last_pid_recv
357 GCC_get_allowed (struct CadetConnection *c, int fwd);
360 * Get messages queued in a connection.
362 * @param c Connection.
363 * @param fwd Is query about FWD traffic?
365 * @return Number of messages queued.
368 GCC_get_qn (struct CadetConnection *c, int fwd);
371 * Get next PID to use.
373 * @param c Connection.
374 * @param fwd Is query about FWD traffic?
375 * @return Next PID to use.
377 struct CadetEncryptedMessageIdentifier
378 GCC_get_pid (struct CadetConnection *c, int fwd);
381 * Allow the connection to advertise a buffer of the given size.
383 * The connection will send an @c fwd ACK message (so: in direction !fwd)
384 * allowing up to last_pid_recv + buffer.
386 * @param c Connection.
387 * @param buffer How many more messages the connection can accept.
388 * @param fwd Is this about FWD traffic? (The ack will go dest->root).
391 GCC_allow (struct CadetConnection *c, unsigned int buffer, int fwd);
394 * Send FWD keepalive packets for a connection.
396 * @param cls Closure (connection for which to send the keepalive).
397 * @param tc Notification context.
400 GCC_fwd_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
403 * Send BCK keepalive packets for a connection.
405 * @param cls Closure (connection for which to send the keepalive).
406 * @param tc Notification context.
409 GCC_bck_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
413 * Notify other peers on a connection of a broken link. Mark connections
414 * to destroy after all traffic has been sent.
416 * @param c Connection on which there has been a disconnection.
417 * @param peer Peer that disconnected.
420 GCC_neighbor_disconnected (struct CadetConnection *c, struct CadetPeer *peer);
423 * Is this peer the first one on the connection?
425 * @param c Connection.
426 * @param fwd Is this about fwd traffic?
428 * @return #GNUNET_YES if origin, #GNUNET_NO if relay/terminal.
431 GCC_is_origin (struct CadetConnection *c, int fwd);
434 * Is this peer the last one on the connection?
436 * @param c Connection.
437 * @param fwd Is this about fwd traffic?
438 * Note that the ROOT is the terminal for BCK traffic!
440 * @return #GNUNET_YES if terminal, #GNUNET_NO if relay/origin.
443 GCC_is_terminal (struct CadetConnection *c, int fwd);
446 * See if we are allowed to send by the next hop in the given direction.
448 * @param c Connection.
449 * @param fwd Is this about fwd traffic?
451 * @return #GNUNET_YES in case it's OK to send.
454 GCC_is_sendable (struct CadetConnection *c, int fwd);
457 * Check if this connection is a direct one (never trim a direct connection).
459 * @param c Connection.
461 * @return #GNUNET_YES in case it's a direct connection, #GNUNET_NO otherwise.
464 GCC_is_direct (struct CadetConnection *c);
467 * Cancel a previously sent message while it's in the queue.
469 * ONLY can be called before the continuation given to the send function
470 * is called. Once the continuation is called, the message is no longer in the
473 * @param q Handle to the queue.
476 GCC_cancel (struct CadetConnectionQueue *q);
479 * Sends an already built message on a connection, properly registering
480 * all used resources.
482 * @param message Message to send.
483 * @param payload_type Type of payload, in case the message is encrypted.
484 * 0 for restransmissions (when type is no longer known)
485 * UINT16_MAX when not applicable.
486 * @param payload_id ID of the payload (PID, ACK, ...).
487 * @param c Connection on which this message is transmitted.
488 * @param fwd Is this a fwd message?
489 * @param force Force the connection to accept the message (buffer overfill).
490 * @param cont Continuation called once message is sent. Can be NULL.
491 * @param cont_cls Closure for @c cont.
493 * @return Handle to cancel the message before it's sent.
495 * Invalid on @c cont call.
497 struct CadetConnectionQueue *
498 GCC_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
499 uint16_t payload_type,
500 struct CadetEncryptedMessageIdentifier payload_id,
501 struct CadetConnection *c, int fwd, int force,
502 GCC_sent cont, void *cont_cls);
505 * Sends a CREATE CONNECTION message for a path to a peer.
506 * Changes the connection and tunnel states if necessary.
508 * @param connection Connection to create.
511 GCC_send_create (struct CadetConnection *connection);
514 * Send a message to all peers in this connection that the connection
515 * is no longer valid.
517 * If some peer should not receive the message, it should be zero'ed out
518 * before calling this function.
520 * @param c The connection whose peers to notify.
523 GCC_send_destroy (struct CadetConnection *c);
526 * @brief Start a polling timer for the connection.
528 * When a neighbor does not accept more traffic on the connection it could be
529 * caused by a simple congestion or by a lost ACK. Polling enables to check
530 * for the lastest ACK status for a connection.
532 * @param c Connection.
533 * @param fwd Should we poll in the FWD direction?
536 GCC_start_poll (struct CadetConnection *c, int fwd);
540 * @brief Stop polling a connection for ACKs.
542 * Once we have enough ACKs for future traffic, polls are no longer necessary.
544 * @param c Connection.
545 * @param fwd Should we stop the poll in the FWD direction?
548 GCC_stop_poll (struct CadetConnection *c, int fwd);
551 * Get a (static) string for a connection.
553 * @param c Connection.
556 GCC_2s (const struct CadetConnection *c);
559 * Log all possible info about the connection state.
561 * @param c Connection to debug.
562 * @param level Debug level to use.
565 GCC_debug (const struct CadetConnection *c, enum GNUNET_ErrorType level);
567 #if 0 /* keep Emacsens' auto-indent happy */
574 /* ifndef GNUNET_SERVICE_CADET_CONNECTION_H */
576 /* end of gnunet-service-cadet_connection.h */