completed pkcs7 parsing methods
[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 <signal.h>
20
21 #include <library.h>
22 #include <utils/linked_list.h>
23
24 #include "guest.h"
25 #include "bridge.h"
26
27 typedef struct dumm_t dumm_t;
28
29 /**
30 * @brief dumm - Dynamic Uml Mesh Modeler
31 *
32 * Controls a group of UML guests and their networks.
33 * Dumm catches SIGCHD and SIGHUP to trace UML child processes and the FUSE
34 * filesystem. Do not overwrite these signal handlers!
35 */
36 struct dumm_t {
37
38 /**
39 * @brief Starts a new UML guest
40 *
41 * @param name name of the guest
42 * @param kernel UML kernel to use for guest
43 * @param master mounted read only master filesystem
44 * @param mem amount of memory for guest, in MB
45 * @return guest if started, NULL if failed
46 */
47 guest_t* (*create_guest) (dumm_t *this, char *name, char *kernel,
48 char *master, int mem);
49
50 /**
51 * @brief Create an iterator over all guests.
52 *
53 * @return iteraotor over guest_t's
54 */
55 iterator_t* (*create_guest_iterator) (dumm_t *this);
56
57 /**
58 * @brief Create a new bridge.
59 *
60 * @param name name of the bridge to create
61 * @return created bridge
62 */
63 bridge_t* (*create_bridge)(dumm_t *this, char *name);
64
65 /**
66 * @brief Create an iterator over all bridges.
67 *
68 * @return iterator over bridge_t's
69 */
70 iterator_t* (*create_bridge_iterator)(dumm_t *this);
71
72 /**
73 * @brief Loads a template, create a new one if it does not exist.
74 *
75 * @param name name of the template, NULL to close
76 * @return FALSE if load/create failed
77 */
78 bool (*load_template)(dumm_t *this, char *name);
79
80 /**
81 * @brief stop all guests and destroy the modeler
82 */
83 void (*destroy) (dumm_t *this);
84 };
85
86 /**
87 * @brief Create a group of UML hosts and networks.
88 *
89 * @param dir directory to create guests/load from
90 * @return created UML group, or NULL if failed.
91 */
92 dumm_t *dumm_create(char *dir);
93
94 #endif /* DUMM_H */
95