- relaxed to accommodate overlay linking timeouts

[oweals/gnunet.git] / src / testbed / testbed_api_peers.h

diff --git a/src/testbed/testbed_api_peers.h b/src/testbed/testbed_api_peers.h
index 17db0d3b44f8f67b8274b3bce2189861755a7aef..f16dd8a302d952edbcb67b54b292a29450f9b5a5 100644 (file)
--- a/src/testbed/testbed_api_peers.h
+++ b/src/testbed/testbed_api_peers.h
@@ -35,34 +35,34 @@
 /**
  * Enumeration of possible states a peer could be in
  */
-enum PeerState 
-  {
+enum PeerState
+{
     /**
      * State to signify that this peer is invalid
      */
-    PS_INVALID,
+  PS_INVALID,
 
     /**
      * The peer has been created
      */
-    PS_CREATED,
-    
+  PS_CREATED,
+
     /**
      * The peer is running
      */
-    PS_STARTED,
+  PS_STARTED,
 
     /**
      * The peer is stopped
      */
-    PS_STOPPED,    
-  };
+  PS_STOPPED,
+};
 
 
 /**
  * A peer controlled by the testing framework.  A peer runs
  * at a particular host.
- */ 
+ */
 struct GNUNET_TESTBED_Peer
 {
   /**
@@ -70,7 +70,7 @@ struct GNUNET_TESTBED_Peer
    * that is responsible for starting/running the peer!).
    */
   struct GNUNET_TESTBED_Controller *controller;
-                          
+
   /**
    * Which host does this peer run on?
    */
@@ -102,12 +102,12 @@ struct PeerCreateData
    * The template configuration of the peer
    */
   const struct GNUNET_CONFIGURATION_Handle *cfg;
-    
+
   /**
    * The call back to call when we receive peer create success message
    */
   GNUNET_TESTBED_PeerCreateCallback cb;
-  
+
   /**
    * The closure for the above callback
    */
@@ -121,6 +121,29 @@ struct PeerCreateData
 };
 
 
+/**
+ * Data for OperationType OP_PEER_START and OP_PEER_STOP
+ */
+struct PeerEventData
+{
+  /**
+   * The handle of the peer to start
+   */
+  struct GNUNET_TESTBED_Peer *peer;
+  
+  /**
+   * The Peer churn callback to call when this operation is completed
+   */
+  GNUNET_TESTBED_PeerChurnCallback pcc;
+   
+  /**
+   * Closure for the above callback
+   */
+  void *pcc_cls;
+    
+};
+
+
 /**
  * Data for the OperationType OP_PEER_DESTROY;
  */
@@ -144,39 +167,21 @@ struct PeerInfoData
    * The peer whose information has been requested
    */
   struct GNUNET_TESTBED_Peer *peer;
-  
+
   /**
-   * The type of peer information requested
+   * The Peer info callback to call when this operation has completed
    */
-  enum GNUNET_TESTBED_PeerInformationType pit;
-};
-
-
-/**
- * Data for the OperationType OP_PEER_INFO
- */
-struct PeerInfoData2
-{
+  GNUNET_TESTBED_PeerInfoCallback cb;
+    
   /**
-   * The type of peer information requested
+   * The closure for peer info callback
    */
-  enum GNUNET_TESTBED_PeerInformationType pit;
+  void *cb_cls;
 
   /**
-   * The data from reply
+   * The type of peer information requested
    */
-  union
-  {
-    /**
-     * Configuration handle
-     */
-    struct GNUNET_CONFIGURATION_Handle *cfg;
-
-    /**
-     * Peer Identity
-     */
-    struct GNUNET_PeerIdentity *peer_identity;
-  } details;
+  enum GNUNET_TESTBED_PeerInformationType pit;
 };
 
 
@@ -185,6 +190,7 @@ struct PeerInfoData2
  */
 struct OverlayConnectData
 {
+
   /**
    * Peer A to connect to peer B
    */
@@ -195,6 +201,50 @@ struct OverlayConnectData
    */
   struct GNUNET_TESTBED_Peer *p2;
 
+  /**
+   * The operation completion callback to call once this operation is done
+   */
+  GNUNET_TESTBED_OperationCompletionCallback cb;
+  
+  /**
+   * The closure for the above callback
+   */
+  void *cb_cls;
+
+  /**
+   * OperationContext for forwarded operations generated when peer1's controller doesn't have the
+   * configuration of peer2's controller for linking laterally to attemp an
+   * overlay connection between peer 1 and peer 2.
+   */
+  struct OperationContext *sub_opc;
+
+  /**
+   * State information for this context data
+   */
+  enum OCDState {
+    
+    /**
+     * The initial state
+     */
+    OCD_INIT,
+
+    /**
+     * State where we attempt to acquire peer2's controller's configuration
+     */
+    OCD_CFG_ACQUIRE,
+
+    /**
+     * State where we link peer1's controller to peer2's controller
+     */
+    OCD_LINK_CONTROLLERS,
+    
+    /**
+     * State where we re-ask controller of peer1 to attempt an overlay connect
+     * between peer1 and peer2
+     */
+    OCD_REATTEMPT_OVERLAY_CONNECT
+  } state;
+
 };
 
 
@@ -232,13 +282,25 @@ struct OverlayConnectData
  */
 struct GNUNET_TESTBED_Operation *
 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,
-                                    GNUNET_TESTBED_PeerCreateCallback cb,
-                                    void *cls);
+                                     struct GNUNET_TESTBED_Controller
+                                     *controller,
+                                     struct GNUNET_TESTBED_Host *host,
+                                     const struct GNUNET_CONFIGURATION_Handle
+                                     *cfg, GNUNET_TESTBED_PeerCreateCallback cb,
+                                     void *cls);
 
 
+/**
+ * Generate PeerGetConfigurationMessage
+ *
+ * @param peer_id the id of the peer whose information we have to get
+ * @param operation_id the ip of the operation that should be represented in
+ *          the message
+ * @return the PeerGetConfigurationMessage
+ */
+struct GNUNET_TESTBED_PeerGetConfigurationMessage *
+GNUNET_TESTBED_generate_peergetconfig_msg_ (uint32_t peer_id,
+                                            uint64_t operation_id);
 
 #endif
 /* end of testbed_api_peers.h */