activated Id property
[strongswan.git] / src / dumm / dumm.h
index fe4f9ca..5414f99 100644 (file)
 #include <utils/linked_list.h>
 
 #include "guest.h"
-
-#define HOST_DIR "host"
-#define MOUNT_DIR "mount"
-#define RUN_DIR "run"
-
+#include "bridge.h"
 
 typedef struct dumm_t dumm_t;
 
@@ -34,6 +30,8 @@ typedef struct dumm_t dumm_t;
  * @brief dumm - Dynamic Uml Mesh Modeler
  *
  * Controls a group of UML guests and their networks.
+ * Dumm catches SIGCHD and SIGHUP to trace UML child processes and the FUSE
+ * filesystem. Do not overwrite these signal handlers!
  */
 struct dumm_t {
 
@@ -41,11 +39,13 @@ struct dumm_t {
         * @brief Starts a new UML guest
         *
         * @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
         * @return                      guest if started, NULL if failed
         */
-       guest_t* (*create_guest) (dumm_t *this, char *name, char *master, int mem);
+       guest_t* (*create_guest) (dumm_t *this, char *name, char *kernel, 
+                                                         char *master, int mem);
        
        /**
         * @brief Create an iterator over all guests.
@@ -55,16 +55,27 @@ struct dumm_t {
        iterator_t* (*create_guest_iterator) (dumm_t *this);
        
        /**
-        * @brief Handler for received SIG_CHILD signals.
+        * @brief Create a new bridge.
+        *
+        * @param name          name of the bridge to create
+        * @return                      created bridge
+        */
+       bridge_t* (*create_bridge)(dumm_t *this, char *name);
+       
+       /**
+        * @brief Create an iterator over all bridges.
         *
-        * 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. 
+        * @return                      iterator over bridge_t's
+        */
+       iterator_t* (*create_bridge_iterator)(dumm_t *this);
+       
+       /**
+        * @brief Loads a template, create a new one if it does not exist.
         *
-        * @param info          siginfo associated to the SIG_CHILD signal
+        * @param name          name of the template, NULL to close
+        * @return                      FALSE if load/create failed
         */
-       void (*sigchild_handler)(dumm_t *this, siginfo_t *info);
+       bool (*load_template)(dumm_t *this, char *name);
        
        /**
         * @brief stop all guests and destroy the modeler
@@ -73,13 +84,12 @@ struct dumm_t {
 };
 
 /**
- * @brief Create a new group of UML hosts and networks.
- *
- * Dumm uses its working dir to create folders and files it works with.
+ * @brief Create a group of UML hosts and networks.
  *
+ * @param dir                  directory to create guests/load from
  * @return                             created UML group, or NULL if failed.
  */
-dumm_t *dumm_create();
+dumm_t *dumm_create(char *dir);
 
 #endif /* DUMM_H */