-removing dead options
[oweals/gnunet.git] / src / experimentation / gnunet-daemon-experimentation.h
index a8bfc3523c69b5c5c1ef6a03933f6b0cceb4199a..999c565ad35ed32a51b29a2541147d1be5d7044a 100644 (file)
 /**
  * Timeout between request and expected response
  */
-#define EXP_RESPONSE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10)
+#define EXP_RESPONSE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
 
+/**
+ * Default experiment frequency
+ */
+#define EXP_DEFAULT_EXP_FREQ GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 6)
+
+/**
+ * Default experiment duration
+ */
+#define EXP_DEFAULT_EXP_DUR GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
 
 /**
  * Statistics handle shared between components
@@ -55,6 +64,10 @@ extern struct GNUNET_CONFIGURATION_Handle *GSE_cfg;
 extern uint32_t GSE_node_capabilities;
 
 
+extern uint32_t GSE_my_issuer_count;
+
+extern struct Experimentation_Issuer *GSE_my_issuer;
+
 /**
  * Capabilities a node has or an experiment requires
  */
@@ -74,6 +87,50 @@ enum GNUNET_EXPERIMENTATION_capabilities
 };
 
 
+/**
+ * Struct to store information about a specific experiment
+ */
+struct Experiment
+{
+       /* Header */
+       /* ----------------- */
+       char *name;
+
+       /* Experiment issuer */
+       struct GNUNET_PeerIdentity issuer;
+
+       /* Experiment version as timestamp of creation */
+       struct GNUNET_TIME_Absolute version;
+
+       /* Description */
+       char *description;
+
+       /* Required capabilities  */
+       uint32_t required_capabilities;
+
+       /* Experiment timing */
+       /* ----------------- */
+
+       /* When to start experiment */
+       struct GNUNET_TIME_Absolute start;
+
+       /* When to end experiment */
+       struct GNUNET_TIME_Absolute stop;
+
+       /* How often to run experiment */
+       struct GNUNET_TIME_Relative frequency;
+
+       /* How long to run each execution  */
+       struct GNUNET_TIME_Relative duration;
+
+
+       /* Experiment itself */
+       /* ----------------- */
+
+       /* TBD */
+};
+
+
 /**
  * A experimentation node
  */
@@ -94,31 +151,63 @@ struct Node
         */
        struct GNUNET_CORE_TransmitHandle *cth;
 
+       /**
+        * Node capabilities
+        */
        uint32_t capabilities;
+
+       /* Experiment version as timestamp of creation */
+       struct GNUNET_TIME_Absolute version;
+
+       uint32_t issuer_count;
+
+       /**
+        * Array of fssuer ids
+        */
+       struct GNUNET_PeerIdentity *issuer_id;
+};
+
+struct Experimentation_Issuer
+{
+       struct GNUNET_PeerIdentity issuer_id;
 };
 
 /**
  * Experimentation request message
  * Used to detect experimentation capability
+ *
+ * This struct is followed by issuer identities:
+ * (issuer_count * struct Experimentation_Request_Issuer)
+ *
  */
 struct Experimentation_Request
 {
        struct GNUNET_MessageHeader msg;
 
        uint32_t capabilities;
+
+       uint32_t issuer_count;
 };
 
 /**
  * Experimentation response message
  * Sent if peer is running the daemon
+ *
+ * This struct is followed by issuer identities:
+ * (issuer_count * struct Experimentation_Request_Issuer)
  */
 struct Experimentation_Response
 {
        struct GNUNET_MessageHeader msg;
 
        uint32_t capabilities;
+
+       uint32_t issuer_count;
 };
 
+void
+GNUNET_EXPERIMENT_nodes_request_start (struct Node *n, struct Experiment *e);
+
 
 /**
  * Start the nodes management
@@ -178,6 +267,13 @@ int
 GNUNET_EXPERIMENTATION_experiments_issuer_accepted (struct GNUNET_PeerIdentity *issuer_ID);
 
 
+typedef void (*GNUNET_EXPERIMENTATION_experiments_get_cb) (struct Node *n, struct Experiment *e);
+
+void
+GNUNET_EXPERIMENTATION_experiments_get (struct Node *n,
+                                                                                                                                                               struct GNUNET_PeerIdentity *issuer,
+                                                                                                                                                               GNUNET_EXPERIMENTATION_experiments_get_cb get_cb);
+
 /**
  * Start experiments management
  *
@@ -194,6 +290,26 @@ void
 GNUNET_EXPERIMENTATION_experiments_stop ();
 
 
+/**
+ * Start the scheduler component
+ */
+void
+GNUNET_EXPERIMENTATION_scheduler_add (struct Node *n, struct Experiment *e);
+
+/**
+ * Start the scheduler component
+ */
+void
+GNUNET_EXPERIMENTATION_scheduler_start ();
+
+
+/**
+ * Stop the scheduler component
+ */
+void
+GNUNET_EXPERIMENTATION_scheduler_stop ();
+
+
 /**
  * Start the storage component
  */