aboutsummaryrefslogtreecommitdiff
path: root/src/testbed/testbed_api_peers.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/testbed/testbed_api_peers.h')
-rw-r--r--src/testbed/testbed_api_peers.h71
1 files changed, 71 insertions, 0 deletions
diff --git a/src/testbed/testbed_api_peers.h b/src/testbed/testbed_api_peers.h
new file mode 100644
index 0000000..ea42c98
--- /dev/null
+++ b/src/testbed/testbed_api_peers.h
@@ -0,0 +1,71 @@
+/*
+ This file is part of GNUnet
+ (C) 2008--2012 Christian Grothoff (and other contributing authors)
+
+ GNUnet is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published
+ by the Free Software Foundation; either version 3, or (at your
+ option) any later version.
+
+ GNUnet is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with GNUnet; see the file COPYING. If not, write to the
+ Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ Boston, MA 02111-1307, USA.
+ */
+
+/**
+ * @file testbed/testbed_api_peers.h
+ * @brief internal API to access the 'peers' subsystem
+ * @author Christian Grothoff
+ */
+#ifndef NEW_TESTING_API_PEERS_H
+#define NEW_TESTING_API_PEERS_H
+
+#include "gnunet_testbed_service.h"
+#include "gnunet_helper_lib.h"
+
+
+/**
+ * Create the given peer at the specified host using the given
+ * controller. If the given controller is not running on the target
+ * host, it should find or create a controller at the target host and
+ * delegate creating the peer. Explicit delegation paths can be setup
+ * using 'GNUNET_TESTBED_controller_link'. If no explicit delegation
+ * path exists, a direct link with a subordinate controller is setup
+ * for the first delegated peer to a particular host; the subordinate
+ * controller is then destroyed once the last peer that was delegated
+ * to the remote host is stopped. This function is used in particular
+ * if some other controller has already assigned a unique ID to the
+ * peer.
+ *
+ * Creating the peer only creates the handle to manipulate and further
+ * configure the peer; use "GNUNET_TESTBED_peer_start" and
+ * "GNUNET_TESTBED_peer_stop" to actually start/stop the peer's
+ * processes.
+ *
+ * Note that the given configuration will be adjusted by the
+ * controller to avoid port/path conflicts with other peers.
+ * The "final" configuration can be obtained using
+ * 'GNUNET_TESTBED_peer_get_information'.
+ *
+ * @param unique_id unique ID for this peer
+ * @param controller controller process to use
+ * @param host host to run the peer on
+ * @param cfg configuration to use for the peer
+ * @return handle to the peer (actual startup will happen asynchronously)
+ */
+struct GNUNET_TESTBED_Peer *
+GNUNET_TESTBED_peer_create_with_id_ (uint32_t unique_id,
+ struct GNUNET_TESTBED_Controller *controller,
+ struct GNUNET_TESTBED_Host *host,
+ const struct GNUNET_CONFIGURATION_Handle *cfg);
+
+
+
+#endif
+/* end of testbed_api_peers.h */