removed IKE_SA_ID (%J) printf hook, two more to go
[strongswan.git] / src / charon / control / controller.h
1 /**
2 * @file controller.h
3 *
4 * @brief Interface of controller_t.
5 *
6 */
7
8 /*
9 * Copyright (C) 2007 Martin Willi
10 * Hochschule fuer Technik Rapperswil
11 *
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2 of the License, or (at your
15 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
19 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
20 * for more details.
21 */
22
23 #ifndef CONTROLLER_H_
24 #define CONTROLLER_H_
25
26 typedef struct controller_t controller_t;
27
28 #include <config/backends/local_backend.h>
29
30 /**
31 * @brief controller is a configuration and control interface which
32 * allows other processes to modify charons behavior.
33 *
34 * controller_t allows config manipulation (as whack in pluto). Configurations
35 * are stored in a special backend, the in-memory local_backend_t.
36 * Messages of type controller_msg_t's are sent over a unix socket
37 * (/var/run/charon.ctl).
38 *
39 * @b Constructors:
40 * - controller_create()
41 *
42 * @ingroup control
43 */
44 struct controller_t {
45
46 /**
47 * @brief Destroy a controller_t instance.
48 *
49 * @param this controller_t objec to destroy
50 */
51 void (*destroy) (controller_t *this);
52 };
53
54
55 /**
56 * @brief Create a controller instance.
57 *
58 * @return controller_t object
59 *
60 * @ingroup control
61 */
62 controller_t *controller_create();
63
64 #endif /* CONTROLLER_H_ */