configuration query for manager (WIP)
[strongswan.git] / src / manager / gateway.h
1 /**
2 * @file gateway.h
3 *
4 * @brief Interface of gateway_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 GATEWAY_H_
24 #define GATEWAY_H_
25
26 #include <utils/host.h>
27 #include <utils/enumerator.h>
28
29 typedef struct gateway_t gateway_t;
30
31 /**
32 * @brief A connection to a gateway.
33 */
34 struct gateway_t {
35
36 /**
37 * @brief Send an XML request to the gateway.
38 *
39 * @param xml xml request string
40 * @return allocated xml response string
41 */
42 char* (*request)(gateway_t *this, char *xml);
43
44 /**
45 * @brief Query the list of IKE_SAs and all its children.
46 *
47 * @return enumerator over ikesa XML elements
48 */
49 enumerator_t* (*query_ikesalist)(gateway_t *this);
50
51 /**
52 * @brief Query the list of peer configs and its subconfigs.
53 *
54 * @return enumerator over peerconfig XML elements
55 */
56 enumerator_t* (*query_configlist)(gateway_t *this);
57
58 /**
59 * @brief Terminate an IKE or a CHILD SA.
60 *
61 * @param ike TRUE for IKE-, FALSE for a CHILD-SA
62 * @return TRUE if successful
63 */
64 bool (*terminate)(gateway_t *this, bool ike, u_int32_t id);
65
66 /**
67 * @brief Destroy a gateway instance.
68 */
69 void (*destroy)(gateway_t *this);
70 };
71
72 /**
73 * @brief Create a gateway instance using a TCP connection.
74 *
75 * @param name name of the gateway
76 * @param host gateway connection endpoint
77 * @param
78 */
79 gateway_t *gateway_create_tcp(char *name, host_t *host);
80
81 /**
82 * @brief Create a gateway instance using a UNIX socket.
83 *
84 * @param name name of the gateway
85 * @param
86 */
87 gateway_t *gateway_create_unix(char *name);
88
89 #endif /* GATEWAY_H_ */