implemented disconnect notifications for outbound connections
[oweals/gnunet.git] / src / transport / plugin_transport_http.h
1 /*
2      This file is part of GNUnet
3      (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
4
5      GNUnet is free software; you can redistribute it and/or modify
6      it under the terms of the GNU General Public License as published
7      by the Free Software Foundation; either version 3, or (at your
8      option) any later version.
9
10      GNUnet is distributed in the hope that it will be useful, but
11      WITHOUT ANY WARRANTY; without even the implied warranty of
12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13      General Public License for more details.
14
15      You should have received a copy of the GNU General Public License
16      along with GNUnet; see the file COPYING.  If not, write to the
17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */
20
21 /**
22  * @file transport/plugin_transport_http.h
23  * @brief http transport service plugin
24  * @author Matthias Wachs
25  */
26
27 #include "platform.h"
28 #include "gnunet_common.h"
29 #include "gnunet_constants.h"
30 #include "gnunet_protocols.h"
31 #include "gnunet_connection_lib.h"
32 #include "gnunet_service_lib.h"
33 #include "gnunet_statistics_service.h"
34 #include "gnunet_transport_service.h"
35 #include "gnunet_resolver_service.h"
36 #include "gnunet_server_lib.h"
37 #include "gnunet_container_lib.h"
38 #include "gnunet_transport_plugin.h"
39 #include "gnunet_os_lib.h"
40 #include "gnunet_nat_lib.h"
41 #include "microhttpd.h"
42 #include <curl/curl.h>
43
44
45 #define DEBUG_HTTP GNUNET_YES
46 #define VERBOSE_SERVER GNUNET_YES
47 #define VERBOSE_CLIENT GNUNET_YES
48
49 #if BUILD_HTTPS
50 #define LIBGNUNET_PLUGIN_TRANSPORT_INIT libgnunet_plugin_transport_https_init
51 #define LIBGNUNET_PLUGIN_TRANSPORT_DONE libgnunet_plugin_transport_https_done
52 #else
53 #define LIBGNUNET_PLUGIN_TRANSPORT_INIT libgnunet_plugin_transport_http_init
54 #define LIBGNUNET_PLUGIN_TRANSPORT_DONE libgnunet_plugin_transport_http_done
55 #endif
56
57
58 #define HTTP_NOT_VALIDATED_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3)
59
60 /**
61  * Encapsulation of all of the state of the plugin.
62  */
63 struct Plugin
64 {
65   /**
66    * Our environment.
67    */
68   struct GNUNET_TRANSPORT_PluginEnvironment *env;
69
70   /**
71    * List of open sessions.
72    */
73   struct Session *head;
74
75   struct Session *tail;
76
77   /**
78    * NAT handle & address management
79    */
80   struct GNUNET_NAT_Handle *nat;
81
82   /**
83    * ipv4 DLL head
84    */
85   struct IPv4HttpAddressWrapper *ipv4_addr_head;
86
87   /**
88    * ipv4 DLL tail
89    */
90   struct IPv4HttpAddressWrapper *ipv4_addr_tail;
91
92   /**
93    * ipv6 DLL head
94    */
95   struct IPv6HttpAddressWrapper *ipv6_addr_head;
96
97   /**
98    * ipv6 DLL tail
99    */
100   struct IPv6HttpAddressWrapper *ipv6_addr_tail;
101
102
103   /* Plugin configuration */
104
105   char *name;
106
107   char *protocol;
108
109   int ipv4;
110
111   int ipv6;
112
113   uint16_t port;
114
115   int max_connections;
116
117
118   /* Plugin values */
119
120
121   int cur_connections;
122
123   /*
124    * Server handles
125    */
126
127   struct MHD_Daemon *server_v4;
128   GNUNET_SCHEDULER_TaskIdentifier server_v4_task;
129
130   struct MHD_Daemon *server_v6;
131   GNUNET_SCHEDULER_TaskIdentifier server_v6_task;
132
133   char *crypto_init;
134   char *key;
135   char *cert;
136
137   /*
138    * Client handles
139    */
140
141   /**
142    * cURL Multihandle
143    */
144   CURLM *client_mh;
145
146   GNUNET_SCHEDULER_TaskIdentifier client_perform_task;
147
148 };
149
150 /**
151  * Session handle for connections.
152  */
153 struct Session
154 {
155
156   /**
157    * Stored in a linked list.
158    */
159   struct Session *next;
160
161   /**
162    * Stored in a linked list.
163    */
164   struct Session *prev;
165
166   /**
167    * Pointer to the global plugin struct.
168    */
169   struct Plugin *plugin;
170
171   /**
172    * The client (used to identify this connection)
173    */
174   /* void *client; */
175
176   /**
177    * Continuation function to call once the transmission buffer
178    * has again space available.  NULL if there is no
179    * continuation to call.
180    */
181   GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
182
183
184   void *addr;
185
186   size_t addrlen;
187
188   /**
189    * Closure for transmit_cont.
190    */
191   void *transmit_cont_cls;
192
193   /**
194    * To whom are we talking to (set to our identity
195    * if we are still waiting for the welcome message)
196    */
197   struct GNUNET_PeerIdentity target;
198
199   /**
200    * At what time did we reset last_received last?
201    */
202   //struct GNUNET_TIME_Absolute last_quota_update;
203
204   /**
205    * How many bytes have we received since the "last_quota_update"
206    * timestamp?
207    */
208   //uint64_t last_received;
209
210   /**
211    * Number of bytes per ms that this peer is allowed
212    * to send to us.
213    */
214   //uint32_t quota;
215
216
217   int inbound;
218
219   void *client_put;
220   void *client_get;
221
222
223 };
224
225 const char *
226 http_plugin_address_to_string (void *cls, const void *addr, size_t addrlen);
227
228 int
229 client_disconnect (struct Session *s);
230
231 int
232 client_connect (struct Session *s);
233
234 int
235 client_send (struct Session *s, const char *msgbuf, size_t msgbuf_size);
236
237 int
238 client_start (struct Plugin *plugin);
239
240 void
241 client_stop (struct Plugin *plugin);
242
243 int
244 server_disconnect (struct Session *s);
245
246 int
247 server_send (struct Session *s, const char *msgbuf, size_t msgbuf_size);
248
249 int
250 server_start (struct Plugin *plugin);
251
252 void
253 server_stop (struct Plugin *plugin);
254
255 void
256 notify_session_end (void *cls,
257                     const struct GNUNET_PeerIdentity *
258                     peer, struct Session * s);
259
260 /* end of plugin_transport_http.h */