- update default values, eliminate obsolete ones
[oweals/gnunet.git] / src / testbed / testbed_api_peers.h
index f16dd8a302d952edbcb67b54b292a29450f9b5a5..3e471a5546ce6faacc1cf0497b4495b95e849658 100644 (file)
@@ -1,6 +1,6 @@
 /*
       This file is part of GNUnet
-      (C) 2008--2012 Christian Grothoff (and other contributing authors)
+      (C) 2008--2013 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
@@ -40,22 +40,22 @@ enum PeerState
     /**
      * State to signify that this peer is invalid
      */
-  PS_INVALID,
+  TESTBED_PS_INVALID,
 
     /**
      * The peer has been created
      */
-  PS_CREATED,
+  TESTBED_PS_CREATED,
 
     /**
      * The peer is running
      */
-  PS_STARTED,
+  TESTBED_PS_STARTED,
 
     /**
      * The peer is stopped
      */
-  PS_STOPPED,
+  TESTBED_PS_STOPPED,
 };
 
 
@@ -65,6 +65,16 @@ enum PeerState
  */
 struct GNUNET_TESTBED_Peer
 {
+  /**
+   * peer list DLL
+   */
+  struct GNUNET_TESTBED_Peer *next;
+
+  /**
+   * peer list DLL
+   */
+  struct GNUNET_TESTBED_Peer *prev;
+
   /**
    * Our controller context (not necessarily the controller
    * that is responsible for starting/running the peer!).
@@ -85,6 +95,11 @@ struct GNUNET_TESTBED_Peer
    * Peer's state
    */
   enum PeerState state;
+
+  /**
+   * Has an underlay model already set for this peer?
+   */
+  uint8_t underlay_model_exists;
 };
 
 
@@ -130,17 +145,17 @@ 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;
-    
+
 };
 
 
@@ -172,7 +187,7 @@ struct PeerInfoData
    * The Peer info callback to call when this operation has completed
    */
   GNUNET_TESTBED_PeerInfoCallback cb;
-    
+
   /**
    * The closure for peer info callback
    */
@@ -185,6 +200,28 @@ struct PeerInfoData
 };
 
 
+/**
+ * Data for the operations of type OP_PEER_RECONFIGURE
+ */
+struct PeerReconfigureData
+{
+  /**
+   * The peer whose information has been requested
+   */
+  struct GNUNET_TESTBED_Peer *peer;
+
+  /**
+   * The serialized new configuration template
+   */
+  char *config;
+
+  /**
+   * the size of the serialized configuration
+   */
+  uint16_t cfg_size;
+};
+
+
 /**
  * Data structure for OperationType OP_OVERLAY_CONNECT
  */
@@ -205,7 +242,7 @@ struct OverlayConnectData
    * The operation completion callback to call once this operation is done
    */
   GNUNET_TESTBED_OperationCompletionCallback cb;
-  
+
   /**
    * The closure for the above callback
    */
@@ -218,76 +255,23 @@ struct OverlayConnectData
    */
   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;
+struct ManageServiceData {
+  GNUNET_TESTBED_OperationCompletionCallback cb;
 
-};
+  void *cb_cls;
 
+  struct GNUNET_TESTBED_Peer *peer;
 
+  char *service_name;
 
-/**
- * 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
- * @param cb the callback to call when the peer has been created
- * @param cls the closure to the above callback
- * @return the operation handle
- */
-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);
+  unsigned int start;
+
+  uint16_t msize;
+
+};
 
 
 /**
@@ -302,5 +286,30 @@ struct GNUNET_TESTBED_PeerGetConfigurationMessage *
 GNUNET_TESTBED_generate_peergetconfig_msg_ (uint32_t peer_id,
                                             uint64_t operation_id);
 
+
+/**
+ * Adds a peer to the peer list
+ *
+ * @param peer the peer to add to the peer list
+ */
+void
+GNUNET_TESTBED_peer_register_ (struct GNUNET_TESTBED_Peer *peer);
+
+
+/**
+ * Removes a peer from the peer list
+ *
+ * @param peer the peer to remove
+ */
+void
+GNUNET_TESTBED_peer_deregister_ (struct GNUNET_TESTBED_Peer *peer);
+
+
+/**
+ * Frees all peers
+ */
+void
+GNUNET_TESTBED_cleanup_peers_ (void);
+
 #endif
 /* end of testbed_api_peers.h */