[GNUnet-SVN] r28550 - in libmicrohttpd: . doc src/include

[gnunet]

Author: grothoff
Date: 2013-08-12 23:56:49 +0200 (Mon, 12 Aug 2013)
New Revision: 28550

Modified:
   libmicrohttpd/ChangeLog
   libmicrohttpd/doc/libmicrohttpd.texi
   libmicrohttpd/src/include/microhttpd.h
Log:
document #2983

Modified: libmicrohttpd/ChangeLog
===================================================================
--- libmicrohttpd/ChangeLog     2013-08-12 21:51:47 UTC (rev 28549)
+++ libmicrohttpd/ChangeLog     2013-08-12 21:56:49 UTC (rev 28550)
@@ -2,7 +2,7 @@
        Updated manual, documenting W32 select/shutdown issue. -CG
 
 Sat Aug 10 21:01:18 CEST 2013
-       Trying to fix #2983 (untested). -CG
+       Fixed #2983. -CG
 
 Sat Aug 10 20:39:27 CEST 2013
        Use 'errno' to indicate why 'MHD_add_connection' failed

Modified: libmicrohttpd/doc/libmicrohttpd.texi
===================================================================
--- libmicrohttpd/doc/libmicrohttpd.texi        2013-08-12 21:51:47 UTC (rev 
28549)
+++ libmicrohttpd/doc/libmicrohttpd.texi        2013-08-12 21:56:49 UTC (rev 
28550)
@@ -1322,8 +1322,13 @@
 MHD will accept inbound connections on the server socket).
 Use this API in special cases, for example if your HTTP
 server is behind NAT and needs to connect out to the 
-HTTP client.
+HTTP client, or if you are building a proxy.
 
+If you use this API in conjunction with a internal select or a thread
+pool, you must set the option @code{MHD_USE_PIPE_FOR_SHUTDOWN} to
+ensure that the freshly added connection is immediately processed by
+MHD.
+
 The given client socket will be managed (and closed!) by MHD after
 this call and must no longer be used directly by the application
 afterwards.
@@ -1342,7 +1347,8 @@
 This function will return @code{MHD_YES} on success, 
 @code{MHD_NO} if this daemon could
 not handle the connection (i.e. malloc failed, etc).
-The socket will be closed in any case.
+The socket will be closed in any case; 'errno' is set
+to indicate further details about the error.
 @end deftypefun
 
 

Modified: libmicrohttpd/src/include/microhttpd.h
===================================================================
--- libmicrohttpd/src/include/microhttpd.h      2013-08-12 21:51:47 UTC (rev 
28549)
+++ libmicrohttpd/src/include/microhttpd.h      2013-08-12 21:56:49 UTC (rev 
28550)
@@ -431,6 +431,9 @@
    * specify it), if 'MHD_USE_NO_LISTEN_SOCKET' is specified.  In
    * "external" select mode, this option is always simply ignored.
    * On W32 a pair of sockets is used instead of a pipe.
+   *
+   * You must also use this option if you use internal select mode
+   * or a thread pool in conjunction with 'MHD_add_connection'.
    */
   MHD_USE_PIPE_FOR_SHUTDOWN = 1024,
 
@@ -1208,13 +1211,17 @@
 
 
 /**
- * Add another client connection to the set of connections 
- * managed by MHD.  This API is usually not needed (since
- * MHD will accept inbound connections on the server socket).
- * Use this API in special cases, for example if your HTTP
- * server is behind NAT and needs to connect out to the 
- * HTTP client.
+ * Add another client connection to the set of connections managed by
+ * MHD.  This API is usually not needed (since MHD will accept inbound
+ * connections on the server socket).  Use this API in special cases,
+ * for example if your HTTP server is behind NAT and needs to connect
+ * out to the HTTP client, or if you are building a proxy.
  *
+ * If you use this API in conjunction with a internal select or a
+ * thread pool, you must set the option
+ * @code{MHD_USE_PIPE_FOR_SHUTDOWN} to ensure that the freshly added
+ * connection is immediately processed by MHD.
+ *
  * The given client socket will be managed (and closed!) by MHD after
  * this call and must no longer be used directly by the application
  * afterwards.