2 This file is part of GNUnet.
3 (C) 2013 Christian Grothoff (and other contributing authors)
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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file mesh/gnunet-service-mesh_connection.h
23 * @brief mesh service; dealing with connections
24 * @author Bartlomiej Polot
26 * All functions in this file should use the prefix GMC (Gnunet Mesh Connection)
29 #ifndef GNUNET_SERVICE_MESH_CONNECTION_H
30 #define GNUNET_SERVICE_MESH_CONNECTION_H
35 #if 0 /* keep Emacsens' auto-indent happy */
40 #include "gnunet_util_lib.h"
43 * Struct containing all information regarding a connection to a peer.
45 struct MeshConnection;
48 * Initialize the connections subsystem
50 * @param c Configuration handle.
53 GMC_init (const struct GNUNET_CONFIGURATION_Handle *c);
56 * Shut down the connections subsystem.
62 * Create a connection.
64 * @param cid Connection ID.
66 struct MeshConnection *
67 GMC_new (const struct GNUNET_HashCode *cid);
70 * Connection is no longer needed: destroy it and remove from tunnel.
72 * @param c Connection to destroy.
75 GMC_destroy (struct MeshConnection *c);
78 * Count connections in a DLL.
81 GMC_count (const struct MeshConnection *head);
84 * Send FWD keepalive packets for a connection.
86 * @param cls Closure (connection for which to send the keepalive).
87 * @param tc Notification context.
90 GMC_fwd_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
93 * Send BCK keepalive packets for a connection.
95 * @param cls Closure (connection for which to send the keepalive).
96 * @param tc Notification context.
99 GMC_bck_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
103 * Change the tunnel state.
105 * @param c Connection whose state to change.
106 * @param state New state.
109 GMC_change_state (struct MeshConnection* c, enum MeshConnectionState state);
112 * Notify other peers on a connection of a broken link. Mark connections
113 * to destroy after all traffic has been sent.
115 * @param c Connection on which there has been a disconnection.
116 * @param peer Peer that disconnected.
117 * @param my_full_id My ID (to send to other peers).
120 GMC_notify_broken (struct MeshConnection *c,
121 struct MeshPeer *peer,
122 struct GNUNET_PeerIdentity *my_full_id);
125 * @brief Queue and pass message to core when possible.
127 * @param cls Closure (@c type dependant). It will be used by queue_send to
128 * build the message to be sent if not already prebuilt.
129 * @param type Type of the message, 0 for a raw message.
130 * @param size Size of the message.
131 * @param c Connection this message belongs to (cannot be NULL).
132 * @param ch Channel this message belongs to, if applicable (otherwise NULL).
133 * @param fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
136 GMC_queue_add (void* cls,
139 struct MeshConnection* c,
140 struct MeshChannel* ch,
145 * Free a transmission that was already queued with all resources
146 * associated to the request.
148 * @param queue Queue handler to cancel.
149 * @param clear_cls Is it necessary to free associated cls?
152 GMC_queue_destroy (struct MeshPeerQueue *queue, int clear_cls);
156 * Core callback to write a queued packet to core buffer
158 * @param cls Closure (peer info).
159 * @param size Number of bytes available in buf.
160 * @param buf Where the to write the message.
162 * @return number of bytes written to buf
165 GMC_queue_send (void *cls, size_t size, void *buf);
170 * Is this peer the first one on the connection?
172 * @param c Connection.
173 * @param fwd Is this about fwd traffic?
175 * @return GNUNET_YES if origin, GNUNET_NO if relay/terminal.
178 GMC_is_origin (struct MeshConnection *c, int fwd);
181 * Is this peer the last one on the connection?
183 * @param c Connection.
184 * @param fwd Is this about fwd traffic?
185 * Note that the ROOT is the terminal for BCK traffic!
187 * @return GNUNET_YES if terminal, GNUNET_NO if relay/origin.
190 GMC_is_terminal (struct MeshConnection *c, int fwd);
193 * Sends an already built message on a connection, properly registering
194 * all used resources.
196 * @param message Message to send. Function makes a copy of it.
197 * If message is not hop-by-hop, decrements TTL of copy.
198 * @param c Connection on which this message is transmitted.
199 * @param ch Channel on which this message is transmitted, or NULL.
200 * @param fwd Is this a fwd message?
203 GMC_send_prebuilt_message (const struct GNUNET_MessageHeader *message,
204 struct MeshConnection *c,
205 struct MeshChannel *ch,
209 #if 0 /* keep Emacsens' auto-indent happy */
216 /* ifndef GNUNET_SERVICE_MESH_CONNECTION_H */
218 /* end of gnunet-service-mesh_connection.h */