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 * A peer controlled by the testing framework. A peer runs
52 * at a particular host.
54 struct GNUNET_TESTBED_Peer
57 * Our controller context (not necessarily the controller
58 * that is responsible for starting/running the peer!).
60 struct GNUNET_TESTBED_Controller *controller;
63 * Which host does this peer run on?
65 struct GNUNET_TESTBED_Host *host;
68 * Globally unique ID of the peer.
73 * Internals of the peer for the controlling process; NULL if
74 * this process is not controlling this peer.
76 struct PeerDetails *details;
82 * Data for the OperationType OP_PEER_CREATE
87 * THe call back to call when we receive peer create success message
89 GNUNET_TESTBED_PeerCreateCallback cb;
92 * The closure for the above callback
97 * The peer structure to return when we get success message
99 struct GNUNET_TESTBED_Peer *peer;
105 * Data for the OperationType OP_PEER_DESTROY;
107 struct PeerDestroyData
112 struct GNUNET_TESTBED_Peer *peer;
119 * Create the given peer at the specified host using the given
120 * controller. If the given controller is not running on the target
121 * host, it should find or create a controller at the target host and
122 * delegate creating the peer. Explicit delegation paths can be setup
123 * using 'GNUNET_TESTBED_controller_link'. If no explicit delegation
124 * path exists, a direct link with a subordinate controller is setup
125 * for the first delegated peer to a particular host; the subordinate
126 * controller is then destroyed once the last peer that was delegated
127 * to the remote host is stopped. This function is used in particular
128 * if some other controller has already assigned a unique ID to the
131 * Creating the peer only creates the handle to manipulate and further
132 * configure the peer; use "GNUNET_TESTBED_peer_start" and
133 * "GNUNET_TESTBED_peer_stop" to actually start/stop the peer's
136 * Note that the given configuration will be adjusted by the
137 * controller to avoid port/path conflicts with other peers.
138 * The "final" configuration can be obtained using
139 * 'GNUNET_TESTBED_peer_get_information'.
141 * @param unique_id unique ID for this peer
142 * @param controller controller process to use
143 * @param host host to run the peer on
144 * @param cfg configuration to use for the peer
145 * @param cb the callback to call when the peer has been created
146 * @param cls the closure to the above callback
147 * @return the operation handle
149 struct GNUNET_TESTBED_Operation *
150 GNUNET_TESTBED_peer_create_with_id_ (uint32_t unique_id,
151 struct GNUNET_TESTBED_Controller *controller,
152 struct GNUNET_TESTBED_Host *host,
153 const struct GNUNET_CONFIGURATION_Handle *cfg,
154 GNUNET_TESTBED_PeerCreateCallback cb,
160 /* end of testbed_api_peers.h */