e33d14be5211dd3651df14d33ddf0261123fefbd
[strongswan.git] / src / dumm / dumm.h
1 /*
2 * Copyright (C) 2007 Martin Willi
3 * Hochschule fuer Technik Rapperswil
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * for more details.
14 */
15
16 #ifndef DUMM_H
17 #define DUMM_H
18
19 #include <library.h>
20 #include <utils/linked_list.h>
21
22 #include "guest.h"
23
24 #define HOST_DIR "host"
25 #define MOUNT_DIR "mount"
26 #define RUN_DIR "run"
27
28
29 typedef struct dumm_t dumm_t;
30
31 /**
32 * @brief dumm - Dynamic Uml Mesh Modeler
33 *
34 * Controls a group of UML guests and their networks.
35 */
36 struct dumm_t {
37
38 /**
39 * @brief Starts a new UML guest
40 *
41 * @param name name of the guest
42 * @param master mounted read only master filesystem
43 * @param mem amount of memory for guest, in MB
44 * @return guest if started, NULL if failed
45 */
46 guest_t* (*create_guest) (dumm_t *this, char *name, char *master, int mem);
47
48 /**
49 * @brief Create an iterator over all guests.
50 *
51 * @return iteraotor over guest_t's
52 */
53 iterator_t* (*create_guest_iterator) (dumm_t *this);
54
55 /**
56 * @brief stop all guests and destroy the modeler
57 */
58 void (*destroy) (dumm_t *this);
59 };
60
61 /**
62 * @brief Create a new group of UML hosts and networks.
63 *
64 * Dumm uses its working dir to create folders and files it works with.
65 *
66 * @return created UML group, or NULL if failed.
67 */
68 dumm_t *dumm_create();
69
70 #endif /* DUMM_H */
71