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 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.
17 * @file testbed/testbed_api_hosts.h
18 * @brief internal API to access the 'hosts' subsystem
19 * @author Christian Grothoff
22 #ifndef TESTBED_API_HOSTS_H
23 #define TESTBED_API_HOSTS_H
25 //#include "gnunet_testbed_service.h"
26 //#include "testbed_helper.h"
31 * handle for host registration
33 struct GNUNET_TESTBED_HostRegistrationHandle
36 * The host being registered
38 struct GNUNET_TESTBED_Host *host;
41 * The controller at which this host is being registered
43 struct GNUNET_TESTBED_Controller *c;
46 * The Registartion completion callback
48 GNUNET_TESTBED_HostRegistrationCompletion cc;
51 * The closure for above callback
58 * Lookup a host by ID.
60 * @param id global host ID assigned to the host; 0 is
61 * reserved to always mean 'localhost'
62 * @return handle to the host, NULL on error
64 struct GNUNET_TESTBED_Host *
65 GNUNET_TESTBED_host_lookup_by_id_ (uint32_t id);
69 * Create a host by ID; given this host handle, we could not
70 * run peers at the host, but we can talk about the host
73 * @param id global host ID assigned to the host; 0 is
74 * reserved to always mean 'localhost'
75 * @param cfg the configuration to use as a template while starting a controller
76 * on this host. Operation queue sizes specific to a host are also
77 * read from this configuration handle
78 * @return handle to the host, NULL on error
80 struct GNUNET_TESTBED_Host *
81 GNUNET_TESTBED_host_create_by_id_ (uint32_t id,
82 const struct GNUNET_CONFIGURATION_Handle
87 * Obtain a host's unique global ID.
89 * @param host handle to the host, NULL means 'localhost'
90 * @return id global host ID assigned to the host (0 is
91 * 'localhost', but then obviously not globally unique)
94 GNUNET_TESTBED_host_get_id_ (const struct GNUNET_TESTBED_Host *host);
98 * Obtain the host's username
100 * @param host handle to the host, NULL means 'localhost'
101 * @return username to login to the host
104 GNUNET_TESTBED_host_get_username_ (const struct GNUNET_TESTBED_Host *host);
108 * Obtain the host's ssh port
110 * @param host handle to the host, NULL means 'localhost'
111 * @return username to login to the host
114 GNUNET_TESTBED_host_get_ssh_port_ (const struct GNUNET_TESTBED_Host *host);
118 * Obtain the host's configuration template
120 * @param host handle to the host
121 * @return the host's configuration template
123 const struct GNUNET_CONFIGURATION_Handle *
124 GNUNET_TESTBED_host_get_cfg_ (const struct GNUNET_TESTBED_Host *host);
128 * Function to replace host's configuration
130 * @param host the host handle
131 * @param new_cfg the new configuration to replace the old one
134 GNUNET_TESTBED_host_replace_cfg_ (struct GNUNET_TESTBED_Host *host,
135 const struct GNUNET_CONFIGURATION_Handle *new_cfg);
139 * Marks a host as registered with a controller
141 * @param host the host to mark
142 * @param controller the controller at which this host is registered
145 GNUNET_TESTBED_mark_host_registered_at_ (struct GNUNET_TESTBED_Host *host,
146 const struct GNUNET_TESTBED_Controller
151 * Unmarks a host registered at a controller
153 * @param host the host to unmark
154 * @param controller the controller at which this host has to be unmarked
157 GNUNET_TESTBED_deregister_host_at_ (struct GNUNET_TESTBED_Host *host,
158 const struct GNUNET_TESTBED_Controller
163 * Checks whether a host has been registered with the given controller
165 * @param host the host to check
166 * @param controller the controller at which host's registration is checked
167 * @return GNUNET_YES if registered; GNUNET_NO if not
170 GNUNET_TESTBED_is_host_registered_ (const struct GNUNET_TESTBED_Host *host,
171 const struct GNUNET_TESTBED_Controller
176 * Queues the given operation in the queue for parallel overlay connects of the
179 * @param h the host handle
180 * @param op the operation to queue in the given host's parally overlay connect
184 GNUNET_TESTBED_host_queue_oc_ (struct GNUNET_TESTBED_Host *h,
185 struct GNUNET_TESTBED_Operation *op);
189 * Sends termination signal to the controller's helper process
191 * @param cproc the handle to the controller's helper process
194 GNUNET_TESTBED_controller_kill_ (struct GNUNET_TESTBED_ControllerProc *cproc);
198 * Cleans-up the controller's helper process handle
200 * @param cproc the handle to the controller's helper process
203 GNUNET_TESTBED_controller_destroy_ (struct GNUNET_TESTBED_ControllerProc
208 * Resolves the hostname of the host to an ip address
210 * @param host the host whose hostname is to be resolved
213 GNUNET_TESTBED_host_resolve_ (struct GNUNET_TESTBED_Host *host);
217 /* end of testbed_api_hosts.h */