2 This file is part of GNUnet
3 (C) 2008--2012 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 testbed/testbed_api_hosts.h
23 * @brief internal API to access the 'hosts' subsystem
24 * @author Christian Grothoff
27 #ifndef NEW_TESTING_API_HOSTS_H
28 #define NEW_TESTING_API_HOSTS_H
30 #include "gnunet_testbed_service.h"
31 #include "testbed_helper.h"
35 * Lookup a host by ID.
37 * @param id global host ID assigned to the host; 0 is
38 * reserved to always mean 'localhost'
39 * @return handle to the host, NULL on error
41 struct GNUNET_TESTBED_Host *
42 GNUNET_TESTBED_host_lookup_by_id_ (uint32_t id);
46 * Create a host by ID; given this host handle, we could not
47 * run peers at the host, but we can talk about the host
50 * @param id global host ID assigned to the host; 0 is
51 * reserved to always mean 'localhost'
52 * @return handle to the host, NULL on error
54 struct GNUNET_TESTBED_Host *
55 GNUNET_TESTBED_host_create_by_id_ (uint32_t id);
59 * Obtain a host's unique global ID.
61 * @param host handle to the host, NULL means 'localhost'
62 * @return id global host ID assigned to the host (0 is
63 * 'localhost', but then obviously not globally unique)
66 GNUNET_TESTBED_host_get_id_ (const struct GNUNET_TESTBED_Host *host);
70 * Obtain the host's hostname.
72 * @param host handle to the host, NULL means 'localhost'
73 * @return hostname of the host
76 GNUNET_TESTBED_host_get_hostname_ (const struct GNUNET_TESTBED_Host *host);
80 * Obtain the host's username
82 * @param host handle to the host, NULL means 'localhost'
83 * @return username to login to the host
86 GNUNET_TESTBED_host_get_username_ (const struct GNUNET_TESTBED_Host *host);
90 * Obtain the host's ssh port
92 * @param host handle to the host, NULL means 'localhost'
93 * @return username to login to the host
96 GNUNET_TESTBED_host_get_ssh_port_ (const struct GNUNET_TESTBED_Host *host);
100 * Opaque wrapper around GNUNET_HELPER_Handle
102 struct GNUNET_TESTBED_HelperHandle;
106 /* * Run a given helper process at the given host. Communication */
107 /* * with the helper will be via GNUnet messages on stdin/stdout. */
108 /* * Runs the process via 'ssh' at the specified host, or locally. */
109 /* * Essentially an SSH-wrapper around the 'gnunet_helper_lib.h' API. */
111 /* * @param controller_ip the ip address of the controller. Will be set as TRUSTED */
112 /* * host when starting testbed controller at host */
113 /* * @param host host to use, use "NULL" for localhost */
114 /* * @param binary_argv binary name and command-line arguments to give to the */
116 /* * @param cfg template configuration to use for the remote controller; the */
117 /* * remote controller will be started with a slightly modified */
118 /* * configuration (port numbers, unix domain sockets and service home */
119 /* * values are changed as per TESTING library on the remote host) */
120 /* * @param cb the callback to run when helper process dies; cannot be NULL */
121 /* * @param cb_cls the closure for the above callback */
122 /* * @return handle to terminate the command, NULL on error */
124 /* struct GNUNET_TESTBED_HelperHandle * */
125 /* GNUNET_TESTBED_host_run_ (const char *controller_ip, */
126 /* const struct GNUNET_TESTBED_Host *host, */
127 /* const struct GNUNET_CONFIGURATION_Handle *cfg, */
128 /* GNUNET_HELPER_ExceptionCallback cb, */
134 /* * Stops a helper in the HelperHandle using GNUNET_HELPER_stop */
136 /* * @param handle the handle returned from GNUNET_TESTBED_host_start_ */
139 /* GNUNET_TESTBED_host_stop_ (struct GNUNET_TESTBED_HelperHandle *handle); */
143 * Marks a host as registered with a controller
145 * @param host the host to mark
146 * @param controller the controller at which this host is registered
149 GNUNET_TESTBED_mark_host_registered_at_ (struct GNUNET_TESTBED_Host *host,
150 const struct GNUNET_TESTBED_Controller
155 * Checks whether a host has been registered with the given controller
157 * @param host the host to check
158 * @param controller the controller at which host's registration is checked
159 * @return GNUNET_YES if registered; GNUNET_NO if not
162 GNUNET_TESTBED_is_host_registered_ (const struct GNUNET_TESTBED_Host *host,
163 const struct GNUNET_TESTBED_Controller
169 /* end of testbed_api_hosts.h */