2 This file is part of GNUnet.
3 Copyright (C) 2008--2013 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * @file testbed/gnunet-service-testbed_links.h
21 * @brief TESTBED service components that deals with starting slave controllers
22 * and establishing lateral links between controllers
23 * @author Sree Harsha Totakura
28 * A connected controller which is not our child
34 * Structure representing a connected(directly-linked) controller
39 * The controller process handle if we had started the controller
41 struct GNUNET_TESTBED_ControllerProc *controller_proc;
44 * The controller handle
46 struct GNUNET_TESTBED_Controller *controller;
49 * handle to lcc which is associated with this slave startup. Should be set to
50 * NULL when the slave has successfully started up
52 struct LinkControllersContext *lcc;
55 * Head of the host registration DLL
57 struct HostRegistration *hr_dll_head;
60 * Tail of the host registration DLL
62 struct HostRegistration *hr_dll_tail;
65 * The current host registration handle
67 struct GNUNET_TESTBED_HostRegistrationHandle *rhandle;
70 * Hashmap to hold Registered host contexts
72 struct GNUNET_CONTAINER_MultiHashMap *reghost_map;
75 * The id of the host this controller is running on
81 * A list of directly linked neighbours
83 extern struct Slave **GST_slave_list;
86 * The size of directly linked neighbours list
88 extern unsigned int GST_slave_list_size;
92 * Cleans up the neighbour list
95 GST_neighbour_list_clean (void);
99 * Get a neighbour from the neighbour list
101 * @param id the index of the neighbour in the neighbour list
102 * @return the Neighbour; NULL if the given index in invalid (index greater than
103 * the list size or neighbour at that index is NULL)
106 GST_get_neighbour (uint32_t id);
110 * Function to cleanup the neighbour connect contexts
113 GST_free_nccq (void);
117 * Notification context to be used to notify when connection to the neighbour's
118 * controller is opened
120 struct NeighbourConnectNotification;
124 * The notification callback to call when we are connect to neighbour
126 * @param cls the closure given to GST_neighbour_get_connection()
127 * @param controller the controller handle to the neighbour
130 (*GST_NeigbourConnectNotifyCallback) (void *cls,
131 struct GNUNET_TESTBED_Controller *controller);
135 * Try to open a connection to the given neigbour. If the connection is open
136 * already, then it is re-used. If not, the request is queued in the operation
137 * queues responsible for bounding the total number of file descriptors. The
138 * actual connection will happen when the operation queue marks the
139 * corresponding operation as active.
141 * @param n the neighbour to open a connection to
142 * @param cb the notification callback to call when the connection is opened
143 * @param cb_cls the closure for the above callback
145 struct NeighbourConnectNotification *
146 GST_neighbour_get_connection (struct Neighbour *n,
147 GST_NeigbourConnectNotifyCallback cb,
152 * Cancel the request for opening a connection to the neighbour
154 * @param h the notification handle
157 GST_neighbour_get_connection_cancel (struct NeighbourConnectNotification *h);
161 * Release the connection to the neighbour. The actual connection will be
162 * closed if connections to other neighbour are waiting (to maintain a bound on
163 * the total number of connections that are open).
165 * @param n the neighbour whose connection can be closed
168 GST_neighbour_release_connection (struct Neighbour *n);
172 * Function to create a neigbour and add it into the neighbour list
174 * @param host the host of the neighbour
177 GST_create_neighbour (struct GNUNET_TESTBED_Host *host);
181 * Message handler for #GNUNET_MESSAGE_TYPE_TESTBED_LCONTROLLERS message
183 * @param cls identification of the client
184 * @param msg the actual message
187 handle_link_controllers (void *cls,
188 const struct GNUNET_TESTBED_ControllerLinkRequest *msg);
192 * Clean up @a client handle if we stored any via #handle_link_controllers(),
193 * the given client disconnected.
195 * @param client the client that is history
198 GST_link_notify_disconnect (struct GNUNET_SERVICE_Client *client);
202 * Cleans up the slave list
205 GST_slave_list_clear (void);