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
26 #ifndef NEW_TESTING_API_HOSTS_H
27 #define NEW_TESTING_API_HOSTS_H
29 #include "gnunet_testbed_service.h"
30 #include "gnunet_helper_lib.h"
34 * Lookup a host by ID.
36 * @param id global host ID assigned to the host; 0 is
37 * reserved to always mean 'localhost'
38 * @return handle to the host, NULL on error
40 struct GNUNET_TESTBED_Host *
41 GNUNET_TESTBED_host_lookup_by_id_ (uint32_t id);
45 * Create a host by ID; given this host handle, we could not
46 * run peers at the host, but we can talk about the host
49 * @param id global host ID assigned to the host; 0 is
50 * reserved to always mean 'localhost'
51 * @return handle to the host, NULL on error
53 struct GNUNET_TESTBED_Host *
54 GNUNET_TESTBED_host_create_by_id_ (uint32_t id);
58 * Create a host to run peers and controllers on. This function is used
59 * if a peer learns about a host via IPC between controllers (and thus
60 * some higher-level controller has already determined the unique IDs).
62 * @param id global host ID assigned to the host; 0 is
63 * reserved to always mean 'localhost'
64 * @param hostname name of the host, use "NULL" for localhost
65 * @param username username to use for the login; may be NULL
66 * @param port port number to use for ssh; use 0 to let ssh decide
67 * @return handle to the host, NULL on error
69 struct GNUNET_TESTBED_Host *
70 GNUNET_TESTBED_host_create_with_id_ (uint32_t id,
77 * Obtain a host's unique global ID.
79 * @param host handle to the host, NULL means 'localhost'
80 * @return id global host ID assigned to the host (0 is
81 * 'localhost', but then obviously not globally unique)
84 GNUNET_TESTBED_host_get_id_ (struct GNUNET_TESTBED_Host *host);
88 * Run a given helper process at the given host. Communication
89 * with the helper will be via GNUnet messages on stdin/stdout.
90 * Runs the process via 'ssh' at the specified host, or locally.
91 * Essentially an SSH-wrapper around the 'gnunet_helper_lib.h' API.
93 * @param host host to use, use "NULL" for localhost
94 * @param binary_argv binary name and command-line arguments to give to the binary
95 * @param cb function to call for messages received from the binary
96 * @param cb_cls closure for cb
97 * @return handle to terminate the command, NULL on error
99 struct GNUNET_HELPER_Handle *
100 GNUNET_TESTBED_host_run_ (struct GNUNET_TESTBED_Host *host,
101 char *const binary_argv[],
102 GNUNET_SERVER_MessageTokenizerCallback cb, void *cb_cls);
105 /* end of testbed_api_hosts.h */