add function conv param string

[oweals/gnunet.git] / src / ats-tests / ats-testing.h

diff --git a/src/ats-tests/ats-testing.h b/src/ats-tests/ats-testing.h
index 42b6b9eb34b86e8e8ae9382e2064d43bfde58aa9..b2a4d13e6ec3d2d739687d212af227664bc992d0 100644 (file)
--- a/src/ats-tests/ats-testing.h
+++ b/src/ats-tests/ats-testing.h
@@ -1,6 +1,6 @@
 /*
  This file is part of GNUnet.
- Copyright (C) 2010-2013 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2010-2013 GNUnet e.V.
 
  GNUnet is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published
@@ -14,8 +14,8 @@
 
  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.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
  */
 /**
  * @file ats-tests/ats-testing.h
@@ -376,15 +376,10 @@ struct BenchmarkState
 
 struct GNUNET_ATS_TEST_Topology
 {
-  /**
-   * Shutdown task
-   */
-  struct GNUNET_SCHEDULER_Task * shutdown_task;
-
   /**
    * Progress task
    */
-  struct GNUNET_SCHEDULER_Task * progress_task;
+  struct GNUNET_SCHEDULER_Task *progress_task;
 
   /**
    * Test result
@@ -544,8 +539,9 @@ extern struct GNUNET_CONFIGURATION_Handle *cfg;
  */
 void
 GNUNET_ATS_TEST_experimentation_run (struct Experiment *e,
-    GNUNET_ATS_TESTING_EpisodeDoneCallback ep_done_cb,
-    GNUNET_ATS_TESTING_ExperimentDoneCallback e_done_cb);
+                                     GNUNET_ATS_TESTING_EpisodeDoneCallback ep_done_cb,
+                                     GNUNET_ATS_TESTING_ExperimentDoneCallback e_done_cb);
+
 
 /**
  * Load an experiment from a file
@@ -554,7 +550,7 @@ GNUNET_ATS_TEST_experimentation_run (struct Experiment *e,
  * @return the Experiment or NULL on failure
  */
 struct Experiment *
-GNUNET_ATS_TEST_experimentation_load (char *filename);
+GNUNET_ATS_TEST_experimentation_load (const char *filename);
 
 
 /**
@@ -591,12 +587,13 @@ GNUNET_ATS_TEST_traffic_handle_pong (struct BenchmarkPartner *p);
  */
 struct TrafficGenerator *
 GNUNET_ATS_TEST_generate_traffic_start (struct BenchmarkPeer *src,
-    struct BenchmarkPartner *dest,
-    enum GeneratorType type,
-    long int base_rate,
-    long int max_rate,
-    struct GNUNET_TIME_Relative period,
-    struct GNUNET_TIME_Relative duration);
+                                        struct BenchmarkPartner *dest,
+                                        enum GeneratorType type,
+                                        unsigned int base_rate,
+                                        unsigned int max_rate,
+                                        struct GNUNET_TIME_Relative period,
+                                        struct GNUNET_TIME_Relative duration);
+
 
 void
 GNUNET_ATS_TEST_generate_traffic_stop (struct TrafficGenerator *tg);
@@ -605,7 +602,8 @@ GNUNET_ATS_TEST_generate_traffic_stop (struct TrafficGenerator *tg);
  * Stop all traffic generators
  */
 void
-GNUNET_ATS_TEST_generate_traffic_stop_all ();
+GNUNET_ATS_TEST_generate_traffic_stop_all (void);
+
 
 /**
  * Generate between the source master and the partner and set preferences with a
@@ -623,19 +621,20 @@ GNUNET_ATS_TEST_generate_traffic_stop_all ();
  */
 struct PreferenceGenerator *
 GNUNET_ATS_TEST_generate_preferences_start (struct BenchmarkPeer *src,
-    struct BenchmarkPartner *dest,
-    enum GeneratorType type,
-    long int base_value,
-    long int value_rate,
-    struct GNUNET_TIME_Relative period,
-    struct GNUNET_TIME_Relative frequency,
-    enum GNUNET_ATS_PreferenceKind kind);
+                                            struct BenchmarkPartner *dest,
+                                            enum GeneratorType type,
+                                            unsigned int base_value,
+                                            unsigned int value_rate,
+                                            struct GNUNET_TIME_Relative period,
+                                            struct GNUNET_TIME_Relative frequency,
+                                            enum GNUNET_ATS_PreferenceKind kind);
 
 void
 GNUNET_ATS_TEST_generate_preferences_stop (struct PreferenceGenerator *pg);
 
+
 void
-GNUNET_ATS_TEST_generate_preferences_stop_all ();
+GNUNET_ATS_TEST_generate_preferences_stop_all (void);
 
 /*
  * Logging related functions
@@ -654,8 +653,12 @@ GNUNET_ATS_TEST_generate_preferences_stop_all ();
  */
 struct LoggingHandle *
 GNUNET_ATS_TEST_logging_start(struct GNUNET_TIME_Relative log_frequency,
-    char *testname, struct BenchmarkPeer *masters, int num_masters, int num_slaves,
-    int verbose);
+                              const char *testname,
+                              struct BenchmarkPeer *masters,
+                              int num_masters,
+                              int num_slaves,
+                              int verbose);
+
 
 /**
  * Stop logging
@@ -665,6 +668,7 @@ GNUNET_ATS_TEST_logging_start(struct GNUNET_TIME_Relative log_frequency,
 void
 GNUNET_ATS_TEST_logging_clean_up (struct LoggingHandle *l);
 
+
 /**
  * Stop logging
  *
@@ -673,6 +677,7 @@ GNUNET_ATS_TEST_logging_clean_up (struct LoggingHandle *l);
 void
 GNUNET_ATS_TEST_logging_stop (struct LoggingHandle *l);
 
+
 /**
  * Log all data now
  *
@@ -687,22 +692,25 @@ GNUNET_ATS_TEST_logging_now (struct LoggingHandle *l);
  *
  * @param l logging handle to use
  * @param test_name name of the current test
- * @param plots create gnuplots: GNUNET_YES or GNUNET_NO
+ * @param plots create gnuplots: #GNUNET_YES or #GNUNET_NO
  */
 void
 GNUNET_ATS_TEST_logging_write_to_file (struct LoggingHandle *l,
-    char *test_name, int plots);
+                                       const char *test_name,
+                                       int plots);
 
-/*
+
+/**
  * Topology related functions
  */
-
 struct BenchmarkPeer *
 GNUNET_ATS_TEST_get_peer (int src);
 
+
 struct BenchmarkPartner *
 GNUNET_ATS_TEST_get_partner (int src, int dest);
 
+
 /**
  * Create a topology for ats testing
  *
@@ -710,21 +718,23 @@ GNUNET_ATS_TEST_get_partner (int src, int dest);
  * @param cfg_file configuration file to use for the peers
  * @param num_slaves number of slaves
  * @param num_masters number of masters
- * @param test_core connect to CORE service (GNUNET_YES) or transport (GNUNET_NO)
+ * @param test_core connect to CORE service (#GNUNET_YES) or transport (#GNUNET_NO)
  * @param done_cb function to call when topology is setup
  * @param done_cb_cls cls for callback
  * @param transport_recv_cb callback to call when data are received
  * @param log_request_cb callback to call when logging is required
  */
 void
-GNUNET_ATS_TEST_create_topology (char *name, char *cfg_file,
-    unsigned int num_slaves,
-    unsigned int num_masters,
-    int test_core,
-    GNUNET_ATS_TEST_TopologySetupDoneCallback done_cb,
-    void *done_cb_cls,
-    GNUNET_TRANSPORT_ReceiveCallback recv_cb,
-    GNUNET_ATS_TEST_LogRequest ats_perf_cb);
+GNUNET_ATS_TEST_create_topology (char *name,
+                                 char *cfg_file,
+                                 unsigned int num_slaves,
+                                 unsigned int num_masters,
+                                 int test_core,
+                                 GNUNET_ATS_TEST_TopologySetupDoneCallback done_cb,
+                                 void *done_cb_cls,
+                                 GNUNET_TRANSPORT_ReceiveCallback recv_cb,
+                                 GNUNET_ATS_TEST_LogRequest ats_perf_cb);
+
 
 /**
  * Shutdown topology
@@ -732,4 +742,5 @@ GNUNET_ATS_TEST_create_topology (char *name, char *cfg_file,
 void
 GNUNET_ATS_TEST_shutdown_topology (void);
 
+
 /* end of file ats-testing.h */