summaryrefslogtreecommitdiff
path: root/src/charon/control/interfaces/stroke_interface.h
blob: f1b68023a49b428cf3a6f574c4d07acad9b78f86 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
/**
 * @file stroke_interface.h
 *
 * @brief Interface of stroke_t.
 *
 */

/*
 * Copyright (C) 2006 Martin Willi
 * Hochschule fuer Technik Rapperswil
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 */

#ifndef STROKE_INTERFACE_H_
#define STROKE_INTERFACE_H_

typedef struct stroke_interface_t stroke_interface_t;

#include <control/interfaces/interface.h>

/**
 * @brief Simple configuration interface using unix-sockets.
 * 
 * Stroke is a home-brewed communication interface inspired by whack. It
 * uses a unix socket (/var/run/charon.ctl).
 * 
 * @b Constructors:
 * - stroke_create()
 * 
 * @ingroup interfaces
 */
struct stroke_interface_t {
	
	/**
	 * implements interface_t.
	 */
	interface_t interface;
};


/**
 * @brief Create the stroke interface and listen on the socket.
 * 
 * @return 			interface_t for the stroke interface
 * 
 * @ingroup interfaces
 */
interface_t *interface_create(void);

#endif /* STROKE_INTERFACE_H_ */