added a Dumm template enumerator
[strongswan.git] / src / dumm / dumm.h
index cb68fdb..b368259 100644 (file)
@@ -1,4 +1,5 @@
 /*
+ * Copyright (C) 2008 Tobias Brunner
  * Copyright (C) 2007 Martin Willi
  * Hochschule fuer Technik Rapperswil
  *
@@ -19,7 +20,7 @@
 #include <signal.h>
 
 #include <library.h>
-#include <utils/linked_list.h>
+#include <utils/enumerator.h>
 
 #include "guest.h"
 #include "bridge.h"
@@ -39,18 +40,25 @@ struct dumm_t {
         * @param name          name of the guest
         * @param kernel        UML kernel to use for guest
         * @param master        mounted read only master filesystem
-        * @param mem           amount of memory for guest, in MB
+        * @param args          additional args to pass to kernel
         * @return                      guest if started, NULL if failed
         */
        guest_t* (*create_guest) (dumm_t *this, char *name, char *kernel, 
-                                                         char *master, int mem);
+                                                         char *master, char *args);
        
        /**
-        * @brief Create an iterator over all guests.
+        * @brief Create an enumerator over all guests.
         *
-        * @return                      iteraotor over guest_t's
+        * @return                      enumerator over guest_t's
         */
-       iterator_t* (*create_guest_iterator) (dumm_t *this);
+       enumerator_t* (*create_guest_enumerator) (dumm_t *this);
+       
+       /**
+        * @brief Delete a guest from disk.
+        *
+        * @param guest         guest to destroy
+        */
+       void (*delete_guest) (dumm_t *this, guest_t *guest);
        
        /**
         * @brief Create a new bridge.
@@ -61,23 +69,33 @@ struct dumm_t {
        bridge_t* (*create_bridge)(dumm_t *this, char *name);
        
        /**
-        * @brief Create an iterator over all bridges.
+        * @brief Create an enumerator over all bridges.
         *
-        * @return                      iterator over bridge_t's
+        * @return                      enumerator over bridge_t's
         */
-       iterator_t* (*create_bridge_iterator)(dumm_t *this);
+       enumerator_t* (*create_bridge_enumerator)(dumm_t *this);
        
        /**
-        * @brief Handler for received SIG_CHILD signals.
+        * @brief Delete a bridge.
         *
-        * Dumm spans children, UML kernels. To track and cleanup these kernel
-        * processes, it is required that this method is called whenever a SIG_CHILD
-        * is received. The user is responsible to call sigchild_handler on each
-        * dumm_t instance with the signals siginfo_t. 
+        * @param bridge        bridge to destroy
+        */
+       void (*delete_bridge) (dumm_t *this, bridge_t *bridge);
+       
+       /**
+        * @brief Loads a template, create a new one if it does not exist.
+        *
+        * @param name          dir to the template, NULL to close
+        * @return                      FALSE if load/create failed
+        */
+       bool (*load_template)(dumm_t *this, char *dir);
+       
+       /**
+        * @brief Create an enumerator over all available templates.
         *
-        * @param info          siginfo associated to the SIG_CHILD signal
+        * @return                      enumerator over char*
         */
-       void (*sigchild_handler)(dumm_t *this, siginfo_t *info);
+       enumerator_t* (*create_template_enumerator)(dumm_t *this);
        
        /**
         * @brief stop all guests and destroy the modeler
@@ -88,7 +106,7 @@ struct dumm_t {
 /**
  * @brief Create a group of UML hosts and networks.
  *
- * @param dir                  directory to create guests/load from
+ * @param dir                  directory to create guests/load from, NULL for cwd
  * @return                             created UML group, or NULL if failed.
  */
 dumm_t *dumm_create(char *dir);