summaryrefslogtreecommitdiffstats
path: root/plugin/firewall/eurephiafw_intf.h
blob: b65a1cd7e7f52c691c495f276c5a30ff65977d44 (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
/* eurephiafw_intf.h  --  Driver interface for the firewall module
 *
 *  GPLv2 only - Copyright (C) 2008 - 2010
 *               David Sommerseth <dazo@users.sourceforge.net>
 *
 *  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; version 2
 *  of the License.
 *
 *  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.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 */

/**
 * @file   eurephiafw_intf.h
 * @author David Sommerseth <dazo@users.sourceforge.net>
 * @date   2008-08-10
 *
 * @brief  Declaration of the firewall driver API
 *
 */


#ifndef   	EUREPHIAFW_INTF_H_
#define   	EUREPHIAFW_INTF_H_

#include <eurephia_driverapi.h>

/**
 * Mandatory function, contains driver information.
 *
 * @return Should retun a static string, containing the version information.
 */
const char * EUREPHIA_DRIVERAPI_FUNC(eFWinterfaceVersion)(void);

/**
 * Mandatory function, contains driver information.
 *
 * @return Should retun an integer which correponds to the API level the interface driver uses.
 */
int EUREPHIA_DRIVERAPI_FUNC(eFWinterfaceAPIversion)(void);

/**
 * The main routine of the firewall interface.  This function should not return before
 * the firewall interface is supposed to shut down.
 *
 * @param fwargs efw_threaddata pointer, with needed information to communicate with the openvpn process.
 */
void EUREPHIA_DRIVERAPI_FUNC(eFW_RunFirewall)(void *fwargs);

#endif 	    /* !EUREPHIAFW_INTF_H_ */