added more API documentation to backends/interfaces
[strongswan.git] / src / charon / config / backends / local_backend.h
1 /**
2 * @file local_backend.h
3 *
4 * @brief Interface of local_backend_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 LOCAL_BACKEND_H_
24 #define LOCAL_BACKEND_H_
25
26 typedef struct local_backend_t local_backend_t;
27
28 #include <library.h>
29 #include <config/backends/writeable_backend.h>
30
31 /**
32 * @brief An in-memory backend to store configurations.
33 *
34 * The local_backend_t stores the configuration in a simple list. It
35 * implements both, backend_t and writeable_backend_t.
36 *
37 * @b Constructors:
38 * - local_backend_create()
39 *
40 * @ingroup backends
41 */
42 struct local_backend_t {
43
44 /**
45 * Implements writable_backend_t interface
46 */
47 writeable_backend_t backend;
48 };
49
50 /**
51 * @brief Create a backend_t instance implemented as local backend.
52 *
53 * @return backend instance
54 *
55 * @ingroup backends
56 */
57 backend_t *backend_create(void);
58
59 #endif /* LOCAL_BACKEND_H_ */
60