fixed casting
[strongswan.git] / src / charon / control / interfaces / stroke_interface.h
1 /**
2 * @file stroke_interface.h
3 *
4 * @brief Interface of stroke_t.
5 *
6 */
7
8 /*
9 * Copyright (C) 2006 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 STROKE_INTERFACE_H_
24 #define STROKE_INTERFACE_H_
25
26 typedef struct stroke_interface_t stroke_interface_t;
27
28 #include <control/interfaces/interface.h>
29
30 /**
31 * @brief Stroke is a configuration and control interface which
32 * allows other processes to modify charons behavior.
33 *
34 * stroke_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 stroke_msg_t's are sent over a unix socket
37 * (/var/run/charon.ctl).
38 *
39 * @b Constructors:
40 * - stroke_create()
41 *
42 * @ingroup interfaces
43 */
44 struct stroke_interface_t {
45
46 /**
47 * implements interface_t.
48 */
49 interface_t interface;
50 };
51
52
53 /**
54 * @brief Create the stroke interface and listen on the socket.
55 *
56 * @return stroke_t object
57 *
58 * @ingroup interfaces
59 */
60 interface_t *interface_create(void);
61
62 #endif /* STROKE_INTERFACE_H_ */
63