4 * @brief Interface of gateway_t.
9 * Copyright (C) 2007 Martin Willi
10 * Hochschule fuer Technik Rapperswil
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>.
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
26 #include <utils/host.h>
27 #include <utils/enumerator.h>
29 typedef struct gateway_t gateway_t
;
32 * @brief A connection to a gateway.
37 * @brief Send an XML request to the gateway.
39 * @param xml xml request string
40 * @return allocated xml response string
42 char* (*request
)(gateway_t
*this, char *xml
);
45 * @brief Query the list of IKE_SAs and all its children.
47 * @return enumerator over ikesa XML elements
49 enumerator_t
* (*query_ikesalist
)(gateway_t
*this);
52 * @brief Query the list of peer configs and its subconfigs.
54 * @return enumerator over peerconfig XML elements
56 enumerator_t
* (*query_configlist
)(gateway_t
*this);
59 * @brief Terminate an IKE or a CHILD SA.
61 * @param ike TRUE for IKE-, FALSE for a CHILD-SA
62 * @return TRUE if successful
64 bool (*terminate
)(gateway_t
*this, bool ike
, u_int32_t id
);
67 * @brief Destroy a gateway instance.
69 void (*destroy
)(gateway_t
*this);
73 * @brief Create a gateway instance using a TCP connection.
75 * @param name name of the gateway
76 * @param host gateway connection endpoint
79 gateway_t
*gateway_create_tcp(char *name
, host_t
*host
);
82 * @brief Create a gateway instance using a UNIX socket.
84 * @param name name of the gateway
87 gateway_t
*gateway_create_unix(char *name
);
89 #endif /* GATEWAY_H_ */