Debian Codegraph @

plugin/firewall/eurephiafw_intf.h

raw
1 /* eurephiafw_intf.h -- Driver interface for the firewall module
2 *
3 * GPLv2 only - Copyright (C) 2008 - 2012
4 * David Sommerseth <[email protected]>
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; version 2
9 * of the License.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 *
20 */
21
22 /**
23 * @file eurephiafw_intf.h
24 * @author David Sommerseth <[email protected]>
25 * @date 2008-08-10
26 *
27 * @brief Declaration of the firewall driver API
28 *
29 */
30
31
32 #ifndef EUREPHIAFW_INTF_H_
33 #define EUREPHIAFW_INTF_H_
34
35 #include <eurephia_driverapi.h>
36
37 /**
38 * Mandatory function, contains driver information.
39 *
40 * @return Should retun a static string, containing the version information.
41 */
42 const char * EUREPHIA_DRIVERAPI_FUNC(eFWinterfaceVersion)(void);
43
44 /**
45 * Mandatory function, contains driver information.
46 *
47 * @return Should retun an integer which correponds to the API level the interface driver uses.
48 */
49 int EUREPHIA_DRIVERAPI_FUNC(eFWinterfaceAPIversion)(void);
50
51 /**
52 * The main routine of the firewall interface. This function should not return before
53 * the firewall interface is supposed to shut down.
54 *
55 * @param fwargs efw_threaddata pointer, with needed information to communicate with the openvpn process.
56 */
57 void EUREPHIA_DRIVERAPI_FUNC(eFW_RunFirewall)(void *fwargs);
58
59 #endif /* !EUREPHIAFW_INTF_H_ */