REST/NAMESTORE: rework API
[oweals/gnunet.git] / src / transport / plugin_transport_http.h
index 1469fd8a939c21bb9d36cafff0ad4896ff1281ae..6867d3b9d31b5c3bc231404b288a7d46967823df 100644 (file)
@@ -1,21 +1,21 @@
 /*
      This file is part of GNUnet
-     (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 GNUnet e.V.
 
-     GNUnet 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; either version 3, or (at your
-     option) any later version.
+     GNUnet is free software: you can redistribute it and/or modify it
+     under the terms of the GNU Affero General Public License as published
+     by the Free Software Foundation, either version 3 of the License,
+     or (at your option) any later version.
 
      GNUnet 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.
+     Affero General Public License for more details.
+    
+     You should have received a copy of the GNU Affero General Public License
+     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-     You should have received a copy of the GNU General Public License
-     along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
 /**
@@ -23,6 +23,8 @@
  * @brief http transport service plugin
  * @author Matthias Wachs
  */
+#ifndef PLUGIN_TRANSPORT_HTTP_H
+#define PLUGIN_TRANSPORT_HTTP_H
 
 #include "platform.h"
 #include "gnunet_common.h"
 #include "gnunet_os_lib.h"
 #include "gnunet_nat_lib.h"
 #include "microhttpd.h"
+#if HAVE_CURL_CURL_H
 #include <curl/curl.h>
+#elif HAVE_GNURL_CURL_H
+#include <gnurl/curl.h>
+#endif
 
 
 #define DEBUG_HTTP GNUNET_EXTRA_LOGGING
  */
 struct Plugin
 {
-  /**
-   * General handles
-   * ---------------
-   */
-
   /**
    * Our environment.
    */
   struct GNUNET_TRANSPORT_PluginEnvironment *env;
 
   /**
-   * Linked list of open sessions.
-   */
-
-  struct Session *head;
-
-  struct Session *tail;
-
-  /**
-   * NAT handle & address management
-   */
-  struct GNUNET_NAT_Handle *nat;
-
-  /**
-   * List of own addresses
+   * Head of linked list of open sessions.
    */
+  struct GNUNET_ATS_Session *head;
 
   /**
-   * IPv4 addresses DLL head
+   * Tail of linked list of open sessions.
    */
-  struct IPv4HttpAddressWrapper *ipv4_addr_head;
+  struct GNUNET_ATS_Session *tail;
 
   /**
-   * IPv4 addresses DLL tail
-   */
-  struct IPv4HttpAddressWrapper *ipv4_addr_tail;
-
-  /**
-   * IPv6 addresses DLL head
+   * NAT handle & address management
    */
-  struct IPv6HttpAddressWrapper *ipv6_addr_head;
+  struct GNUNET_NAT_Handle *nat;
 
   /**
-   * IPv6 addresses DLL tail
+   * Our own IPv4 addresses DLL head
    */
-  struct IPv6HttpAddressWrapper *ipv6_addr_tail;
+  struct HttpAddressWrapper *addr_head;
 
   /**
-   * Plugin configuration
-   * --------------------
+   * Our own IPv4 addresses DLL tail
    */
+  struct HttpAddressWrapper *addr_tail;
 
   /**
    * External hostname the plugin can be connected to, can be different to
@@ -138,11 +122,10 @@ struct Plugin
   /**
    * Task calling transport service about external address
    */
-  GNUNET_SCHEDULER_TaskIdentifier notify_ext_task;
-
+  struct GNUNET_SCHEDULER_Task * notify_ext_task;
 
   /**
-   * Plugin name
+   * Plugin name.
    * Equals configuration section: transport-http, transport-https
    */
   char *name;
@@ -154,21 +137,18 @@ struct Plugin
   char *protocol;
 
   /**
-   * Use IPv4?
-   * GNUNET_YES or GNUNET_NO
+   * Use IPv4? #GNUNET_YES or #GNUNET_NO
    */
   int ipv4;
 
   /**
-   * Use IPv6?
-   * GNUNET_YES or GNUNET_NO
+   * Use IPv6? #GNUNET_YES or #GNUNET_NO
    */
   int ipv6;
 
   /**
    * Does plugin just use outbound connections and not accept inbound?
    */
-
   int client_only;
 
   /**
@@ -192,11 +172,6 @@ struct Plugin
    */
   unsigned int inbound_sessions;
 
-  /**
-   * Plugin HTTPS SSL/TLS options
-   * ----------------------------
-   */
-
   /**
    * libCurl TLS crypto init string, can be set to enhance performance
    *
@@ -204,7 +179,6 @@ struct Plugin
    *
    * Use RC4-128 instead of AES:
    * NONE:+VERS-TLS1.0:+ARCFOUR-128:+SHA1:+RSA:+COMP-NULL
-   *
    */
   char *crypto_init;
 
@@ -218,11 +192,6 @@ struct Plugin
    */
   char *cert;
 
-  /**
-   * Plugin values
-   * -------------
-   */
-
   /**
    * Current number of establishes connections
    */
@@ -233,11 +202,6 @@ struct Plugin
    */
   uint32_t last_tag;
 
-  /**
-   * Server handles
-   * --------------
-   */
-
   /**
    * MHD IPv4 daemon
    */
@@ -246,7 +210,7 @@ struct Plugin
   /**
    * MHD IPv4 task
    */
-  GNUNET_SCHEDULER_TaskIdentifier server_v4_task;
+  struct GNUNET_SCHEDULER_Task * server_v4_task;
 
   /**
    * The IPv4 server is scheduled to run asap
@@ -261,12 +225,11 @@ struct Plugin
   /**
    * MHD IPv4 task
    */
-  GNUNET_SCHEDULER_TaskIdentifier server_v6_task;
+  struct GNUNET_SCHEDULER_Task * server_v6_task;
 
   /**
    * The IPv6 server is scheduled to run asap
    */
-
   int server_v6_immediately;
 
   /**
@@ -280,17 +243,18 @@ struct Plugin
   struct sockaddr_in6 *server_addr_v6;
 
   /**
-   * Server semi connections
+   * Head of server semi connections
    * A full session consists of 2 semi-connections: send and receive
    * If not both directions are established the server keeps this sessions here
    */
-  struct Session *server_semi_head;
+  struct GNUNET_ATS_Session *server_semi_head;
 
-  struct Session *server_semi_tail;
-
-  /*
-   * Client handles
+  /**
+   * Tail of server semi connections
+   * A full session consists of 2 semi-connections: send and receive
+   * If not both directions are established the server keeps this sessions here
    */
+  struct GNUNET_ATS_Session *server_semi_tail;
 
   /**
    * cURL Multihandle
@@ -300,7 +264,7 @@ struct Plugin
   /**
    * curl perform task
    */
-  GNUNET_SCHEDULER_TaskIdentifier client_perform_task;
+  struct GNUNET_SCHEDULER_Task * client_perform_task;
 
 };
 
@@ -356,27 +320,34 @@ struct IPv6HttpAddress
 GNUNET_NETWORK_STRUCT_END
 
 
-struct ServerConnection
+struct ServerRequest
 {
-  /* _RECV or _SEND */
+  /**
+   * _RECV or _SEND
+   */
   int direction;
 
-  /* Should this connection get disconnected? GNUNET_YES/NO  */
+  /**
+   * Should this connection get disconnected? #GNUNET_YES / #GNUNET_NO
+   */
   int disconnect;
 
-  /* The session this server connection belongs to */
-  struct Session *session;
+  /**
+   * The session this server connection belongs to
+   */
+  struct GNUNET_ATS_Session *session;
 
-  /* The MHD connection */
+  /**
+   * The MHD connection
+   */
   struct MHD_Connection *mhd_conn;
 };
 
 
-
 /**
  * Session handle for connections.
  */
-struct Session
+struct GNUNET_ATS_Session
 {
   /**
    * To whom are we talking to
@@ -386,12 +357,12 @@ struct Session
   /**
    * Stored in a linked list.
    */
-  struct Session *next;
+  struct GNUNET_ATS_Session *next;
 
   /**
    * Stored in a linked list.
    */
-  struct Session *prev;
+  struct GNUNET_ATS_Session *prev;
 
   /**
    * Pointer to the global plugin struct.
@@ -423,7 +394,6 @@ struct Session
    */
   struct HTTP_Message *msg_tail;
 
-
   /**
    * Message stream tokenizer for incoming data
    */
@@ -437,8 +407,8 @@ struct Session
 
   /**
    * Inbound or outbound connection
-   * Outbound: GNUNET_NO (client is used to send and receive)
-   * Inbound : GNUNET_YES (server is used to send and receive)
+   * Outbound: #GNUNET_NO (client is used to send and receive)
+   * Inbound : #GNUNET_YES (server is used to send and receive)
    */
   int inbound;
 
@@ -447,10 +417,6 @@ struct Session
    */
   uint32_t tag;
 
-  /**
-   * Client handles
-   */
-
   /**
    * Client send handle
    */
@@ -464,34 +430,31 @@ struct Session
   /**
    * Task to wake up client receive handle when receiving is allowed again
    */
-  GNUNET_SCHEDULER_TaskIdentifier recv_wakeup_task;
+  struct GNUNET_SCHEDULER_Task * recv_wakeup_task;
 
   /**
    * Session timeout task
    */
-  GNUNET_SCHEDULER_TaskIdentifier timeout_task;
+  struct GNUNET_SCHEDULER_Task * timeout_task;
 
   /**
    * Is client send handle paused since there are no data to send?
-   * GNUNET_YES/NO
+   * #GNUNET_YES or #GNUNET_NO
    */
   int client_put_paused;
 
-  /**
-   * Server handles
-   */
-
   /**
    * Client send handle
    */
-  struct ServerConnection *server_recv;
+  struct ServerRequest *server_recv;
 
   /**
    * Client send handle
    */
-  struct ServerConnection *server_send;
+  struct ServerRequest *server_send;
 };
 
+
 /**
  *  Message to send using http
  */
@@ -530,62 +493,90 @@ struct HTTP_Message
   GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
 
   /**
-   * Closure for transmit_cont.
+   * Closure for @e transmit_cont.
    */
   void *transmit_cont_cls;
 };
 
-struct Session *
-create_session (struct Plugin *plugin, const struct GNUNET_PeerIdentity *target,
-                const void *addr, size_t addrlen);
+
+struct GNUNET_ATS_Session *
+create_session (struct Plugin *plugin,
+                const struct GNUNET_PeerIdentity *target,
+                const void *addr,
+                size_t addrlen);
+
 
 int
-exist_session (struct Plugin *plugin, struct Session *s);
+exist_session (struct Plugin *plugin,
+               struct GNUNET_ATS_Session *s);
+
 
 void
-delete_session (struct Session *s);
+delete_session (struct GNUNET_ATS_Session *s);
+
 
 int
-exist_session (struct Plugin *plugin, struct Session *s);
+exist_session (struct Plugin *plugin,
+               struct GNUNET_ATS_Session *s);
+
 
 struct GNUNET_TIME_Relative
-http_plugin_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
+http_plugin_receive (void *cls,
+                     const struct GNUNET_PeerIdentity *peer,
                      const struct GNUNET_MessageHeader *message,
-                     struct Session *session, const char *sender_address,
+                     struct GNUNET_ATS_Session *session,
+                     const char *sender_address,
                      uint16_t sender_address_len);
 
+
 const char *
-http_plugin_address_to_string (void *cls, const void *addr, size_t addrlen);
+http_plugin_address_to_string (void *cls,
+                               const void *addr,
+                               size_t addrlen);
+
 
 int
-client_disconnect (struct Session *s);
+client_disconnect (struct GNUNET_ATS_Session *s);
+
 
 int
-client_connect (struct Session *s);
+client_connect (struct GNUNET_ATS_Session *s);
+
 
 int
-client_send (struct Session *s, struct HTTP_Message *msg);
+client_send (struct GNUNET_ATS_Session *s, struct HTTP_Message *msg);
+
 
 int
 client_start (struct Plugin *plugin);
 
+
 void
 client_stop (struct Plugin *plugin);
 
+
 int
-server_disconnect (struct Session *s);
+server_disconnect (struct GNUNET_ATS_Session *s);
+
 
 int
-server_send (struct Session *s, struct HTTP_Message *msg);
+server_send (struct GNUNET_ATS_Session *s, struct HTTP_Message *msg);
+
 
 int
 server_start (struct Plugin *plugin);
 
+
 void
 server_stop (struct Plugin *plugin);
 
+
 void
-notify_session_end (void *cls, const struct GNUNET_PeerIdentity *peer,
-                    struct Session *s);
+notify_session_end (void *cls,
+                    const struct GNUNET_PeerIdentity *peer,
+                    struct GNUNET_ATS_Session *s);
 
+
+/*#ifndef PLUGIN_TRANSPORT_HTTP_H*/
+#endif
 /* end of plugin_transport_http.h */