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_peers.h
23 * @brief internal API to access the 'peers' subsystem
24 * @author Christian Grothoff
26 #ifndef NEW_TESTING_API_PEERS_H
27 #define NEW_TESTING_API_PEERS_H
29 #include "gnunet_testbed_service.h"
30 #include "gnunet_helper_lib.h"
34 * Details about a peer; kept in a separate struct to avoid bloating
35 * memory consumption everywhere...
40 * Configuration of the peer; NULL if we are not sure what the peer's correct
41 * configuration actually is; non-NULL if this peer is controlled by this
44 struct GNUNET_CONFIGURATION_Handle *cfg;
51 * Enumeration of possible states a peer could be in
56 * State to signify that this peer is invalid
61 * The peer has been created
78 * A peer controlled by the testing framework. A peer runs
79 * at a particular host.
81 struct GNUNET_TESTBED_Peer
84 * Our controller context (not necessarily the controller
85 * that is responsible for starting/running the peer!).
87 struct GNUNET_TESTBED_Controller *controller;
90 * Which host does this peer run on?
92 struct GNUNET_TESTBED_Host *host;
95 * Internals of the peer for the controlling process; NULL if
96 * this process is not controlling this peer.
98 struct PeerDetails *details;
101 * Globally unique ID of the peer.
108 enum PeerState state;
113 * Data for the OperationType OP_PEER_CREATE
115 struct PeerCreateData
118 * The host where the peer has to be created
120 struct GNUNET_TESTBED_Host *host;
123 * The template configuration of the peer
125 const struct GNUNET_CONFIGURATION_Handle *cfg;
128 * The call back to call when we receive peer create success message
130 GNUNET_TESTBED_PeerCreateCallback cb;
133 * The closure for the above callback
138 * The peer structure to return when we get success message
140 struct GNUNET_TESTBED_Peer *peer;
146 * Data for the OperationType OP_PEER_DESTROY;
148 struct PeerDestroyData
153 struct GNUNET_TESTBED_Peer *peer;
160 * Data for the OperationType OP_PEER_INFO
165 * The peer whose information has been requested
167 struct GNUNET_TESTBED_Peer *peer;
170 * The type of peer information requested
172 enum GNUNET_TESTBED_PeerInformationType pit;
177 * Data for the OperationType OP_PEER_INFO
182 * The type of peer information requested
184 enum GNUNET_TESTBED_PeerInformationType pit;
187 * The data from reply
192 * Configuration handle
194 struct GNUNET_CONFIGURATION_Handle *cfg;
199 struct GNUNET_PeerIdentity *peer_identity;
205 * Data structure for OperationType OP_OVERLAY_CONNECT
207 struct OverlayConnectData
210 * Peer A to connect to peer B
212 struct GNUNET_TESTBED_Peer *p1;
217 struct GNUNET_TESTBED_Peer *p2;
224 * Create the given peer at the specified host using the given
225 * controller. If the given controller is not running on the target
226 * host, it should find or create a controller at the target host and
227 * delegate creating the peer. Explicit delegation paths can be setup
228 * using 'GNUNET_TESTBED_controller_link'. If no explicit delegation
229 * path exists, a direct link with a subordinate controller is setup
230 * for the first delegated peer to a particular host; the subordinate
231 * controller is then destroyed once the last peer that was delegated
232 * to the remote host is stopped. This function is used in particular
233 * if some other controller has already assigned a unique ID to the
236 * Creating the peer only creates the handle to manipulate and further
237 * configure the peer; use "GNUNET_TESTBED_peer_start" and
238 * "GNUNET_TESTBED_peer_stop" to actually start/stop the peer's
241 * Note that the given configuration will be adjusted by the
242 * controller to avoid port/path conflicts with other peers.
243 * The "final" configuration can be obtained using
244 * 'GNUNET_TESTBED_peer_get_information'.
246 * @param unique_id unique ID for this peer
247 * @param controller controller process to use
248 * @param host host to run the peer on
249 * @param cfg configuration to use for the peer
250 * @param cb the callback to call when the peer has been created
251 * @param cls the closure to the above callback
252 * @return the operation handle
254 struct GNUNET_TESTBED_Operation *
255 GNUNET_TESTBED_peer_create_with_id_ (uint32_t unique_id,
256 struct GNUNET_TESTBED_Controller *controller,
257 struct GNUNET_TESTBED_Host *host,
258 const struct GNUNET_CONFIGURATION_Handle *cfg,
259 GNUNET_TESTBED_PeerCreateCallback cb,
265 /* end of testbed_api_peers.h */