aboutsummaryrefslogtreecommitdiff
path: root/src/testing
diff options
context:
space:
mode:
authorWillow Liquorice <willow@howhill.com>2022-09-02 20:10:29 +0100
committerWillow Liquorice <willow@howhill.com>2022-10-03 00:44:25 +0100
commitd21ed4b27f0709277823b5e3c8bfa4b66672f39a (patch)
treeae0a7d24b4c67e58aef8e4774164ccbe85663e96 /src/testing
parentb7d0705deee725a39d75663d965b4051156198d3 (diff)
downloadgnunet-d21ed4b27f0709277823b5e3c8bfa4b66672f39a.tar.gz
gnunet-d21ed4b27f0709277823b5e3c8bfa4b66672f39a.zip
-DOC: Comment stripping pass in TESTING libraries
Diffstat (limited to 'src/testing')
-rw-r--r--src/testing/testing.c62
1 files changed, 1 insertions, 61 deletions
diff --git a/src/testing/testing.c b/src/testing/testing.c
index a00d7217f..de5234979 100644
--- a/src/testing/testing.c
+++ b/src/testing/testing.c
@@ -1503,17 +1503,6 @@ disconn_status (void *cls, int connected)
1503} 1503}
1504 1504
1505 1505
1506/**
1507 * Stop a peer asynchronously using ARM API. Peer's shutdown is signaled
1508 * through the GNUNET_TESTING_PeerStopCallback().
1509 *
1510 * @param peer the peer to stop
1511 * @param cb the callback to signal peer shutdown
1512 * @param cb_cls closure for the above callback
1513 * @return #GNUNET_OK upon successfully giving the request to the ARM API (this
1514 * does not mean that the peer is successfully stopped); #GNUNET_SYSERR
1515 * upon any error.
1516 */
1517int 1506int
1518GNUNET_TESTING_peer_stop_async (struct GNUNET_TESTING_Peer *peer, 1507GNUNET_TESTING_peer_stop_async (struct GNUNET_TESTING_Peer *peer,
1519 GNUNET_TESTING_PeerStopCallback cb, 1508 GNUNET_TESTING_PeerStopCallback cb,
@@ -1581,22 +1570,6 @@ GNUNET_TESTING_peer_destroy (struct GNUNET_TESTING_Peer *peer)
1581} 1570}
1582 1571
1583 1572
1584/**
1585 * Start a single peer and run a test using the testing library.
1586 * Starts a peer using the given configuration and then invokes the
1587 * given callback. This function ALSO initializes the scheduler loop
1588 * and should thus be called directly from "main". The testcase
1589 * should self-terminate by invoking #GNUNET_SCHEDULER_shutdown().
1590 *
1591 * @param testdir only the directory name without any path. This is used for
1592 * all service homes; the directory will be created in a temporary
1593 * location depending on the underlying OS
1594 * @param cfgfilename name of the configuration file to use;
1595 * use NULL to only run with defaults
1596 * @param tm main function of the testcase
1597 * @param tm_cls closure for @a tm
1598 * @return 0 on success, 1 on error
1599 */
1600int 1573int
1601GNUNET_TESTING_peer_run (const char *testdir, 1574GNUNET_TESTING_peer_run (const char *testdir,
1602 const char *cfgfilename, 1575 const char *cfgfilename,
@@ -1648,27 +1621,6 @@ service_run_main (void *cls)
1648} 1621}
1649 1622
1650 1623
1651/**
1652 * Start a single service (no ARM, except of course if the given
1653 * service name is 'arm') and run a test using the testing library.
1654 * Starts a service using the given configuration and then invokes the
1655 * given callback. This function ALSO initializes the scheduler loop
1656 * and should thus be called directly from "main". The testcase
1657 * should self-terminate by invoking #GNUNET_SCHEDULER_shutdown().
1658 *
1659 * This function is useful if the testcase is for a single service
1660 * and if that service doesn't itself depend on other services.
1661 *
1662 * @param testdir only the directory name without any path. This is used for
1663 * all service homes; the directory will be created in a temporary
1664 * location depending on the underlying OS
1665 * @param service_name name of the service to run
1666 * @param cfgfilename name of the configuration file to use;
1667 * use NULL to only run with defaults
1668 * @param tm main function of the testcase
1669 * @param tm_cls closure for @a tm
1670 * @return 0 on success, 1 on error
1671 */
1672int 1624int
1673GNUNET_TESTING_service_run (const char *testdir, 1625GNUNET_TESTING_service_run (const char *testdir,
1674 const char *service_name, 1626 const char *service_name,
@@ -2161,13 +2113,6 @@ GNUNET_TESTING_get_connections (unsigned int num, struct
2161} 2113}
2162 2114
2163 2115
2164/**
2165 * Retrieve the public key from the test system with the unique node id.
2166 *
2167 * @param num The unique node id.
2168 * @param tl_system The test system.
2169 * @return The peer identity wrapping the public key.
2170 */
2171struct GNUNET_PeerIdentity * 2116struct GNUNET_PeerIdentity *
2172GNUNET_TESTING_get_pub_key (unsigned int num, 2117GNUNET_TESTING_get_pub_key (unsigned int num,
2173 const struct GNUNET_TESTING_System *tl_system) 2118 const struct GNUNET_TESTING_System *tl_system)
@@ -2343,12 +2288,7 @@ GNUNET_TESTING_get_address (struct GNUNET_TESTING_NodeConnection *connection,
2343} 2288}
2344 2289
2345 2290
2346/** 2291
2347 * Create a GNUNET_CMDS_LOCAL_FINISHED message.
2348 *
2349 * @param rv The result of the local test as GNUNET_GenericReturnValue.
2350 * @return The GNUNET_CMDS_LOCAL_FINISHED message.
2351*/
2352struct GNUNET_MessageHeader * 2292struct GNUNET_MessageHeader *
2353GNUNET_TESTING_send_local_test_finished_msg (enum GNUNET_GenericReturnValue rv) 2293GNUNET_TESTING_send_local_test_finished_msg (enum GNUNET_GenericReturnValue rv)
2354{ 2294{