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/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @file testbed/testbed_api_hosts.h
23 * @brief internal API to access the 'hosts' subsystem
24 * @author Christian Grothoff
27 #ifndef TESTBED_API_HOSTS_H
28 #define TESTBED_API_HOSTS_H
30 //#include "gnunet_testbed_service.h"
31 //#include "testbed_helper.h"
36 * handle for host registration
38 struct GNUNET_TESTBED_HostRegistrationHandle
41 * The host being registered
43 struct GNUNET_TESTBED_Host *host;
46 * The controller at which this host is being registered
48 struct GNUNET_TESTBED_Controller *c;
51 * The Registartion completion callback
53 GNUNET_TESTBED_HostRegistrationCompletion cc;
56 * The closure for above callback
63 * Lookup a host by ID.
65 * @param id global host ID assigned to the host; 0 is
66 * reserved to always mean 'localhost'
67 * @return handle to the host, NULL on error
69 struct GNUNET_TESTBED_Host *
70 GNUNET_TESTBED_host_lookup_by_id_ (uint32_t id);
74 * Create a host by ID; given this host handle, we could not
75 * run peers at the host, but we can talk about the host
78 * @param id global host ID assigned to the host; 0 is
79 * reserved to always mean 'localhost'
80 * @param cfg the configuration to use as a template while starting a controller
81 * on this host. Operation queue sizes specific to a host are also
82 * read from this configuration handle
83 * @return handle to the host, NULL on error
85 struct GNUNET_TESTBED_Host *
86 GNUNET_TESTBED_host_create_by_id_ (uint32_t id,
87 const struct GNUNET_CONFIGURATION_Handle
92 * Obtain a host's unique global ID.
94 * @param host handle to the host, NULL means 'localhost'
95 * @return id global host ID assigned to the host (0 is
96 * 'localhost', but then obviously not globally unique)
99 GNUNET_TESTBED_host_get_id_ (const struct GNUNET_TESTBED_Host *host);
103 * Obtain the host's username
105 * @param host handle to the host, NULL means 'localhost'
106 * @return username to login to the host
109 GNUNET_TESTBED_host_get_username_ (const struct GNUNET_TESTBED_Host *host);
113 * Obtain the host's ssh port
115 * @param host handle to the host, NULL means 'localhost'
116 * @return username to login to the host
119 GNUNET_TESTBED_host_get_ssh_port_ (const struct GNUNET_TESTBED_Host *host);
123 * Obtain the host's configuration template
125 * @param host handle to the host
126 * @return the host's configuration template
128 const struct GNUNET_CONFIGURATION_Handle *
129 GNUNET_TESTBED_host_get_cfg_ (const struct GNUNET_TESTBED_Host *host);
133 * Function to replace host's configuration
135 * @param host the host handle
136 * @param new_cfg the new configuration to replace the old one
139 GNUNET_TESTBED_host_replace_cfg_ (struct GNUNET_TESTBED_Host *host,
140 const struct GNUNET_CONFIGURATION_Handle *new_cfg);
144 * Marks a host as registered with a controller
146 * @param host the host to mark
147 * @param controller the controller at which this host is registered
150 GNUNET_TESTBED_mark_host_registered_at_ (struct GNUNET_TESTBED_Host *host,
151 const struct GNUNET_TESTBED_Controller
156 * Unmarks a host registered at a controller
158 * @param host the host to unmark
159 * @param controller the controller at which this host has to be unmarked
162 GNUNET_TESTBED_deregister_host_at_ (struct GNUNET_TESTBED_Host *host,
163 const struct GNUNET_TESTBED_Controller
168 * Checks whether a host has been registered with the given controller
170 * @param host the host to check
171 * @param controller the controller at which host's registration is checked
172 * @return GNUNET_YES if registered; GNUNET_NO if not
175 GNUNET_TESTBED_is_host_registered_ (const struct GNUNET_TESTBED_Host *host,
176 const struct GNUNET_TESTBED_Controller
181 * Queues the given operation in the queue for parallel overlay connects of the
184 * @param h the host handle
185 * @param op the operation to queue in the given host's parally overlay connect
189 GNUNET_TESTBED_host_queue_oc_ (struct GNUNET_TESTBED_Host *h,
190 struct GNUNET_TESTBED_Operation *op);
194 * Sends termination signal to the controller's helper process
196 * @param cproc the handle to the controller's helper process
199 GNUNET_TESTBED_controller_kill_ (struct GNUNET_TESTBED_ControllerProc *cproc);
203 * Cleans-up the controller's helper process handle
205 * @param cproc the handle to the controller's helper process
208 GNUNET_TESTBED_controller_destroy_ (struct GNUNET_TESTBED_ControllerProc
213 * Resolves the hostname of the host to an ip address
215 * @param host the host whose hostname is to be resolved
218 GNUNET_TESTBED_host_resolve_ (struct GNUNET_TESTBED_Host *host);
222 /* end of testbed_api_hosts.h */