error msg
[oweals/gnunet.git] / src / transport / transport-testing.h
index 94cfaf59a81e5347b230b865e8f43e5816c9adc2..d064ac5743d80744ca928ce73a04db99ccb48b23 100644 (file)
 
 #include "platform.h"
 #include "gnunet_common.h"
-#include "gnunet_getopt_lib.h"
 #include "gnunet_hello_lib.h"
-#include "gnunet_os_lib.h"
 #include "gnunet_program_lib.h"
 #include "gnunet_container_lib.h"
 #include "gnunet_transport_service.h"
+#include "gnunet_testing_lib.h"
+
 
 #define GNUNET_TRANSPORT_TESTING_ConnectRequest void *
 
@@ -58,50 +58,102 @@ typedef void (*GNUNET_TRANSPORT_TESTING_connect_cb) (struct PeerContext * p1,
                                                      void *cls);
 
 
-struct TransportTestingHandle;
+/**
+ * Definition for a transport testing handle
+ */
+struct GNUNET_TRANSPORT_TESTING_handle;
 
 /**
  * Context for a single peer
  */
 struct PeerContext
 {
-  struct PeerContext * next;
-  struct PeerContext * prev;
-
-  struct TransportTestingHandle * tth;
-
+  /**
+   * Next element in the DLL
+   */
+  struct PeerContext *next;
+
+  /**
+   * Previous element in the DLL
+   */
+  struct PeerContext *prev;
+
+  /**
+   * Transport testing handle this peer belongs to
+   */
+  struct GNUNET_TRANSPORT_TESTING_handle *tth;
+
+  /**
+   * Peer's configuration
+   */
   struct GNUNET_CONFIGURATION_Handle *cfg;
 
+  /**
+   * Peer's transport service handle
+   */
   struct GNUNET_TRANSPORT_Handle *th;
 
+  /**
+   * Peer's transport get hello handle to retrieve peer's HELLO message
+   */
   struct GNUNET_TRANSPORT_GetHelloHandle *ghh;
 
+  /**
+   * Peer's testing handle
+   */
+  struct GNUNET_TESTING_Peer *peer;
+
+  /**
+   * Peer identity
+   */
   struct GNUNET_PeerIdentity id;
 
+  /**
+   * Handle for the peer's ARM process
+   */
   struct GNUNET_OS_Process *arm_proc;
 
+  /**
+   * Receive callback
+   */
   GNUNET_TRANSPORT_ReceiveCallback rec;
 
+  /**
+   * Notify connect callback
+   */
   GNUNET_TRANSPORT_NotifyConnect nc;
 
+  /**
+   * Notify disconnect callback
+   */
   GNUNET_TRANSPORT_NotifyDisconnect nd;
 
+  /**
+   * Startup completed callback
+   */
   GNUNET_TRANSPORT_TESTING_start_cb start_cb;
 
+  /**
+   * Peers HELLO Message
+   */
   struct GNUNET_HELLO_Message *hello;
 
+  /**
+   * Closure for the callbacks
+   */
   void *cb_cls;
 
-  char *servicehome;
-
+  /**
+   * An unique number to identify the peer
+   */
   unsigned int no;
 };
 
 
 struct ConnectingContext
 {
-  struct ConnectingContext * next;
-  struct ConnectingContext * prev;
+  struct ConnectingContext *next;
+  struct ConnectingContext *prev;
   struct PeerContext *p1;
   struct PeerContext *p2;
   GNUNET_SCHEDULER_TaskIdentifier tct;
@@ -113,30 +165,50 @@ struct ConnectingContext
   int p2_c;
 };
 
-struct TransportTestingHandle
+struct GNUNET_TRANSPORT_TESTING_handle
 {
-  struct ConnectingContext * cc_head;
-  struct ConnectingContext * cc_tail;
-
-  struct PeerContext * p_head;
-  struct PeerContext * p_tail;
+  /**
+   * Testing library system handle
+   */
+  struct GNUNET_TESTING_System *tl_system;
+
+  /**
+   * head DLL of connect contexts
+   */
+  struct ConnectingContext *cc_head;
+
+  /**
+   * head DLL of connect contexts
+   */
+  struct ConnectingContext *cc_tail;
+
+  /**
+   * head DLL of peers
+   */
+  struct PeerContext *p_head;
+
+  /**
+   * tail DLL of peers
+   */
+  struct PeerContext *p_tail;
 };
 
 
-
 /**
- * Start a peer with the given configuration
- * @param rec receive callback
- * @param nc connect callback
- * @param nd disconnect callback
- * @param cb_cls closure for callback
- *   if NULL passed the PeerContext * will be used!
- * @return the peer context
- */
+* Start a peer with the given configuration
+* @param tth the testing handle
+* @param cfgname configuration file
+* @param peer_id the peer_id
+* @param rec receive callback
+* @param nc connect callback
+* @param nd disconnect callback
+* @param start_cb start callback
+* @param cb_cls closure for callback
+* @return the peer context
+*/
 struct PeerContext *
-GNUNET_TRANSPORT_TESTING_start_peer (struct TransportTestingHandle * tth,
-                                     const char *cfgname,
-                                     int peer_id,
+GNUNET_TRANSPORT_TESTING_start_peer (struct GNUNET_TRANSPORT_TESTING_handle
+                                     *tth, const char *cfgname, int peer_id,
                                      GNUNET_TRANSPORT_ReceiveCallback rec,
                                      GNUNET_TRANSPORT_NotifyConnect nc,
                                      GNUNET_TRANSPORT_NotifyDisconnect nd,
@@ -146,26 +218,45 @@ GNUNET_TRANSPORT_TESTING_start_peer (struct TransportTestingHandle * tth,
 
 /**
  * shutdown the given peer
+ * @param tth the testing handle
  * @param p the peer
  */
 
 void
-GNUNET_TRANSPORT_TESTING_stop_peer (struct TransportTestingHandle * tth,
+GNUNET_TRANSPORT_TESTING_stop_peer (struct GNUNET_TRANSPORT_TESTING_handle *tth,
                                     struct PeerContext *pc);
 
 
+/**
+* Restart the given peer
+* @param tth testing handle
+* @param p the peer
+* @param cfgname the cfg file used to restart
+* @param restart_cb restart callback
+* @param cb_cls callback closure
+* @return GNUNET_OK in success otherwise GNUNET_SYSERR
+*/
+int
+GNUNET_TRANSPORT_TESTING_restart_peer (struct GNUNET_TRANSPORT_TESTING_handle
+                                       *tth, struct PeerContext *p,
+                                       const char *cfgname,
+                                       GNUNET_TRANSPORT_TESTING_start_cb
+                                       restart_cb, void *cb_cls);
+
 /**
  * Connect the given peers and call the callback when both peers report the
  * inbound connection. Remarks: start_peer's notify_connect callback can be called
  * before.
+ *
+ * @param tth transport testing handle
  * @param p1 peer 1
  * @param p2 peer 2
  * @param cb the callback to call when both peers notified that they are connected
- * @param cb_cls callback cls
+ * @param cls callback cls
  * @return a connect request handle
  */
 GNUNET_TRANSPORT_TESTING_ConnectRequest
-GNUNET_TRANSPORT_TESTING_connect_peers (struct TransportTestingHandle * tth,
+GNUNET_TRANSPORT_TESTING_connect_peers (struct GNUNET_TRANSPORT_TESTING_handle *tth,
                                         struct PeerContext *p1,
                                         struct PeerContext *p2,
                                         GNUNET_TRANSPORT_TESTING_connect_cb cb,
@@ -174,24 +265,28 @@ GNUNET_TRANSPORT_TESTING_connect_peers (struct TransportTestingHandle * tth,
 /**
  * Cancel the request to connect two peers
  * Tou MUST cancel the request if you stop the peers before the peers connected succesfully
- * @param cc a connect request handle
+ * @param tth testing
+ * @param ccr a connect request handle
  */
 void
-GNUNET_TRANSPORT_TESTING_connect_peers_cancel (struct TransportTestingHandle *,
-                                               void *cc);
+GNUNET_TRANSPORT_TESTING_connect_peers_cancel (struct
+                                               GNUNET_TRANSPORT_TESTING_handle
+                                               *tth,
+                                               GNUNET_TRANSPORT_TESTING_ConnectRequest
+                                               ccr);
 
 /**
  * Clean up the transport testing
  * @param tth transport testing handle
  */
 void
-GNUNET_TRANSPORT_TESTING_done (struct TransportTestingHandle * tth);
+GNUNET_TRANSPORT_TESTING_done (struct GNUNET_TRANSPORT_TESTING_handle *tth);
 
 /**
  * Initialize the transport testing
  * @return transport testing handle
  */
-struct TransportTestingHandle *
+struct GNUNET_TRANSPORT_TESTING_handle *
 GNUNET_TRANSPORT_TESTING_init ();
 
 /*
@@ -209,12 +304,13 @@ GNUNET_TRANSPORT_TESTING_get_test_name (const char *file, char **dest);
 /**
  * This function takes the filename (e.g. argv[0), removes a "lt-"-prefix and
  * if existing ".exe"-prefix and adds the peer-number
+ *
  * @param file filename of the test, e.g. argv[0]
- * @param cfgname where to write the result
+ * @param dest where to write the filename
  * @param count peer number
  */
 void
-GNUNET_TRANSPORT_TESTING_get_config_name (const char *file, char **cfgname,
+GNUNET_TRANSPORT_TESTING_get_config_name (const char *file, char **dest,
                                           int count);