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_local.h
23 * @brief mesh service; dealing with local clients
24 * @author Bartlomiej Polot
26 * All functions in this file should use the prefix GML (Gnunet Mesh Local)
29 #ifndef GNUNET_SERVICE_MESH_LOCAL_H
30 #define GNUNET_SERVICE_MESH_LOCAL_H
35 #if 0 /* keep Emacsens' auto-indent happy */
41 #include "gnunet_util_lib.h"
43 #include "gnunet-service-mesh_channel.h"
46 * Struct containing information about a client of the service
50 /******************************************************************************/
51 /******************************** API ***********************************/
52 /******************************************************************************/
55 * Initialize server subsystem.
57 * @param handle Server handle.
60 GML_init (struct GNUNET_SERVER_Handle *handle);
63 * Install server (service) handlers and start listening to clients.
75 * Get a chennel from a client
77 * @param client the client to check
78 * @param chid Channel ID
80 * @return non-NULL if channel exists in the global DLL
83 GML_channel_get (struct MeshClient *client, uint32_t chid);
86 * Check if client has registered with the service and has not disconnected
88 * @param client the client to check
90 * @return non-NULL if client exists in the global DLL
93 GML_client_get (struct GNUNET_SERVER_Client *client);
96 * Find a client that has opened a port
98 * @param port Port to check.
100 * @return non-NULL if a client has the port.
103 GML_client_get_by_port (uint32_t port);
106 * Deletes a tunnel from a client (either owner or destination).
108 * @param c Client whose tunnel to delete.
109 * @param ch Channel which should be deleted.
112 GML_client_delete_channel (struct MeshClient *c, struct MeshChannel *ch);
115 * Build a local ACK message and send it to a local client, if needed.
117 * If the client was already allowed to send data, do nothing.
119 * @param ch Channel on which to send the ACK.
120 * @param c Client to whom send the ACK.
121 * @param fwd Set to GNUNET_YES for FWD ACK (dest->root)
124 GML_send_ack (struct MeshChannel *ch, int fwd);
127 * Notify the appropriate client that a new incoming channel was created.
129 * @param ch Channel that was created.
132 GML_send_channel_create (struct MeshClient *c,
133 uint32_t id, uint32_t port, uint32_t opt,
134 struct GNUNET_PeerIdentity *peer);
137 * Notify a client that a channel is no longer valid.
140 * @param id ID of the channel that is destroyed.
143 GML_send_channel_destroy (struct MeshClient *c, uint32_t id);
146 * Modify the mesh message TID from global to local and send to client.
148 * @param ch Channel on which to send the message.
149 * @param msg Message to modify and send.
150 * @param c Client to send to.
151 * @param tid Tunnel ID to use (c can be both owner and client).
154 GML_send_data (struct MeshChannel *ch,
155 const struct GNUNET_MESH_Data *msg,
156 struct MeshClient *c, MESH_ChannelNumber id);
159 #if 0 /* keep Emacsens' auto-indent happy */
166 /* ifndef GNUNET_MESH_SERVICE_LOCAL_H */
168 /* end of gnunet-mesh-service_LOCAL.h */