[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[GNUnet-SVN] r34325 - libmicrohttpd-docs/WWW
|
From: |
gnunet |
|
Subject: |
[GNUnet-SVN] r34325 - libmicrohttpd-docs/WWW |
|
Date: |
Fri, 3 Oct 2014 14:41:57 +0200 |
Author: grothoff
Date: 2014-10-03 14:41:56 +0200 (Fri, 03 Oct 2014)
New Revision: 34325
Modified:
libmicrohttpd-docs/WWW/microhttpd.html
libmicrohttpd-docs/WWW/microhttpd.pdf
Log:
-update
Modified: libmicrohttpd-docs/WWW/microhttpd.html
===================================================================
--- libmicrohttpd-docs/WWW/microhttpd.html 2014-10-03 12:40:43 UTC (rev
34324)
+++ libmicrohttpd-docs/WWW/microhttpd.html 2014-10-03 12:41:56 UTC (rev
34325)
@@ -1,12 +1,11 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html401/loose.dtd";>
<html>
-<!-- This manual documents GNU libmicrohttpd version 0.9.13, last
-updated 6 August 2011. It is built upon the documentation in the
-header file microhttpd.h.
+<!-- This manual is for GNU libmicrohttpd
+(version 0.9.38, 7 August 2014), a library for embedding
+an HTTP(S) server into C applications.
+Copyright C 2007-2013 Christian Grothoff
-Copyright C 2007, 2008, 2009, 2010, 2011 Christian Grothoff
-
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
@@ -14,9 +13,8 @@
Texts. A copy of the license is included in the section entitled "GNU
Free Documentation License".
-GNU libmicrohttpd is a GNU package.
-->
-<!-- Created on September 12, 2011 by texi2html 1.82
+<!-- Created on October 3, 2014 by texi2html 1.82
texi2html was written by:
Lionel Cons <address@hidden> (original author)
Karl Berry <address@hidden>
@@ -66,12 +64,11 @@
</tr></table>
<a name="The-GNU-libmicrohttpd-Library"></a>
<h1 class="settitle">The GNU libmicrohttpd Library</h1>
-<p>This manual documents GNU libmicrohttpd version 0.9.13, last
-updated 6 August 2011. It is built upon the documentation in the
-header file ‘<tt>microhttpd.h</tt>’.
+<p>This manual is for GNU libmicrohttpd
+(version 0.9.38, 7 August 2014), a library for embedding
+an HTTP(S) server into C applications.
</p>
-
-<p>Copyright © 2007, 2008, 2009, 2010, 2011 Christian Grothoff
+<p>Copyright © 2007–2013 Christian Grothoff
</p>
<blockquote><p>Permission is granted to copy, distribute and/or modify this
document
under the terms of the GNU Free Documentation License, Version 1.3
@@ -80,8 +77,7 @@
Texts. A copy of the license is included in the section entitled "GNU
Free Documentation License".
</p></blockquote>
-<p>GNU libmicrohttpd is a GNU package.
-</p>
+
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top"><a href="#microhttpd_002dintro">1.
Introduction</a></td><td> </td><td align="left"
valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#microhttpd_002dconst">2.
Constants</a></td><td> </td><td align="left" valign="top"></td></tr>
@@ -91,9 +87,10 @@
<tr><td align="left" valign="top"><a href="#microhttpd_002dinspect">6.
Implementing external <code>select</code></a></td><td> </td><td
align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#microhttpd_002drequests">7.
Handling requests</a></td><td> </td><td align="left"
valign="top"></td></tr>
<tr><td align="left" valign="top"><a href="#microhttpd_002dresponses">8.
Building responses to requests</a></td><td> </td><td align="left"
valign="top"></td></tr>
-<tr><td align="left" valign="top"><a href="#microhttpd_002ddauth">9. Utilizing
Authentication</a></td><td> </td><td align="left"
valign="top"></td></tr>
-<tr><td align="left" valign="top"><a href="#microhttpd_002dpost">10. Adding a
<code>POST</code> processor</a></td><td> </td><td align="left"
valign="top"></td></tr>
-<tr><td align="left" valign="top"><a href="#microhttpd_002dinfo">11. Obtaining
and modifying status information.</a></td><td> </td><td align="left"
valign="top"></td></tr>
+<tr><td align="left" valign="top"><a href="#microhttpd_002dflow">9. Flow
control.</a></td><td> </td><td align="left" valign="top"></td></tr>
+<tr><td align="left" valign="top"><a href="#microhttpd_002ddauth">10.
Utilizing Authentication</a></td><td> </td><td align="left"
valign="top"></td></tr>
+<tr><td align="left" valign="top"><a href="#microhttpd_002dpost">11. Adding a
<code>POST</code> processor</a></td><td> </td><td align="left"
valign="top"></td></tr>
+<tr><td align="left" valign="top"><a href="#microhttpd_002dinfo">12. Obtaining
and modifying status information.</a></td><td> </td><td align="left"
valign="top"></td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
Appendices
@@ -140,40 +137,40 @@
<h1 class="chapter">1. Introduction</h1>
-<p>All symbols defined in the public <acronym>API</acronym> start with
<code>MHD_</code>. <acronym>MHD</acronym>
-is a small <acronym>HTTP</acronym> daemon library. As such, it does not have
any <acronym>API</acronym>
+<p>All symbols defined in the public API start with <code>MHD_</code>. MHD
+is a small HTTP daemon library. As such, it does not have any API
for logging errors (you can only enable or disable logging to stderr).
-Also, it may not support all of the <acronym>HTTP</acronym> features directly,
where
-applicable, portions of <acronym>HTTP</acronym> may have to be handled by
clients of the
+Also, it may not support all of the HTTP features directly, where
+applicable, portions of HTTP may have to be handled by clients of the
library.
</p>
<p>The library is supposed to handle everything that it must handle
-(because the <acronym>API</acronym> would not allow clients to do this), such
as basic
+(because the API would not allow clients to do this), such as basic
connection management; however, detailed interpretations of headers —
-such as range requests — and <acronym>HTTP</acronym> methods are left to
clients. The
+such as range requests — and HTTP methods are left to clients. The
library does understand <code>HEAD</code> and will only send the headers of
the response and not the body, even if the client supplied a body. The
library also understands headers that control connection management
(specifically, <code>Connection: close</code> and <code>Expect: 100
continue</code>
are understood and handled automatically).
</p>
-<p><acronym>MHD</acronym> understands <code>POST</code> data and is able to
decode certain
+<p>MHD understands <code>POST</code> data and is able to decode certain
formats (at the moment only <code>application/x-www-form-urlencoded</code>
and <code>multipart/form-data</code>) using the post processor API. The
data stream of a POST is also provided directly to the main
application, so unsupported encodings could still be processed, just
-not conveniently by <acronym>MHD</acronym>.
+not conveniently by MHD.
</p>
-<p>The header file defines various constants used by the
<acronym>HTTP</acronym> protocol.
-This does not mean that <acronym>MHD</acronym> actually interprets all of
these values.
+<p>The header file defines various constants used by the HTTP protocol.
+This does not mean that MHD actually interprets all of these values.
The provided constants are exported as a convenience for users of the
-library. <acronym>MHD</acronym> does not verify that transmitted
<acronym>HTTP</acronym> headers are
+library. MHD does not verify that transmitted HTTP headers are
part of the standard specification; users of the library are free to
-define their own extensions of the <acronym>HTTP</acronym> standard and use
those with
-<acronym>MHD</acronym>.
+define their own extensions of the HTTP standard and use those with
+MHD.
</p>
<p>All functions are guaranteed to be completely reentrant and
-thread-safe. <acronym>MHD</acronym> checks for allocation failures and tries
to
+thread-safe. MHD checks for allocation failures and tries to
recover gracefully (for example, by closing the connection).
Additionally, clients can specify resource limits on the overall
number of connections, number of connections per IP address and memory
@@ -183,7 +180,7 @@
<a name="Scope"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#microhttpd_002dintro"
title="Previous section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a
href="#Including-the-microhttpd_002eh-header" title="Next section in reading
order"> > </a>]</td>
+<td valign="middle" align="left">[<a href="#Thread-modes-and-event-loops"
title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#microhttpd_002dintro"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#microhttpd_002dintro" title="Up
section"> Up </a>]</td>
@@ -199,7 +196,7 @@
</tr></table>
<h2 class="section">1.1 Scope</h2>
-<p><acronym>MHD</acronym> is currently used in a wide range of
implementations.
+<p>MHD is currently used in a wide range of implementations.
Examples based on reports we’ve received from developers include:
</p><ul>
<li> Embedded HTTP server on a cortex M3 (128 KB code space)
@@ -209,9 +206,183 @@
</li></ul>
<hr size="6">
+<a name="Thread-modes-and-event-loops"></a>
+<table cellpadding="1" cellspacing="1" border="0">
+<tr><td valign="middle" align="left">[<a href="#Scope" title="Previous section
in reading order"> < </a>]</td>
+<td valign="middle" align="left">[<a href="#Compiling-GNU-libmicrohttpd"
title="Next section in reading order"> > </a>]</td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dintro"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dintro" title="Up
section"> Up </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dconst" title="Next
chapter"> >> </a>]</td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
+<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
+<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
+<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
+</tr></table>
+<h2 class="section">1.2 Thread modes and event loops</h2>
+<a name="index-poll"></a>
+<a name="index-epoll"></a>
+<a name="index-select"></a>
+
+<p>MHD supports four basic thread modes and up to three event loop
+styes.
+</p>
+<p>The four basic thread modes are external (MHD creates no threads,
+event loop is fully managed by the application), internal (MHD creates
+one thread for all connections), thread pool (MHD creates a thread
+pool which is used to process all connections) and
+thread-per-connection (MHD creates one listen thread and then one
+thread per accepted connection).
+</p>
+<p>These thread modes are then combined with the event loop styles.
+MHD support select, poll and epoll. epoll is only available on
+Linux, poll may not be available on some platforms. Note that
+it is possible to combine MHD using epoll with an external
+select-based event loop.
+</p>
+<p>The default (if no other option is passed) is “external select”.
+The highest performance can typically be obtained with a thread pool
+using <code>epoll</code>. Apache Benchmark (ab) was used to compare the
+performance of <code>select</code> and <code>epoll</code> when using a thread
pool
+and a large number of connections. <a
href="#fig_003aperformance">fig:performance</a> shows the
+resulting plot from the <code>benchmark.c</code> example, which measures the
+latency between an incoming request and the completion of the
+transmission of the response. In this setting, the <code>epoll</code>
+thread pool with four threads was able to handle more than 45,000
+connections per second on loopback (with Apache Benchmark running
+three processes on the same machine).
+<a name="index-performance"></a>
+</p>
+
+<div class="float"><a name="fig_003aperformance"></a>
+<img src="performance_data.png" alt="Data">
+
+</div><p><strong>Figure 1.1: Performance measurements for select vs. epoll
(with thread-pool).
+</strong>
+</p>
+
+<p>Not all combinations of thread modes and event loop styles are
+supported. This is partially to keep the API simple, and partially
+because some combinations simply make no sense as others are strictly
+superior. Note that the choice of style depends fist of all on the
+application logic, and then on the performance requirements.
+Applications that perform a blocking operation while handling a
+request within the callbacks from MHD must use a thread per
+connection. This is typically rather costly. Applications that do
+not support threads or that must run on embedded devices without
+thread-support must use the external mode. Using <code>epoll</code> is only
+supported on Linux, thus portable applications must at least have a
+fallback option available. <a href="#tbl_003asupported">tbl:supported</a>
lists the sane
+combinations.
+</p>
+<div class="float"><a name="tbl_003asupported"></a>
+<table>
+<tr><td></td><td><b>select</b></td><td><b>poll</b></td><td><b>epoll</b></td></tr>
+<tr><td><b>external</b></td><td>yes</td><td>no</td><td>yes</td></tr>
+<tr><td><b>internal</b></td><td>yes</td><td>yes</td><td>yes</td></tr>
+<tr><td><b>thread pool</b></td><td>yes</td><td>yes</td><td>yes</td></tr>
+<tr><td><b>thread-per-connection</b></td><td>yes</td><td>yes</td><td>no</td></tr>
+</table>
+
+</div><p><strong>Table 1.1: Supported combinations of event styles and thread
modes.
+</strong>
+</p>
+
+<hr size="6">
+<a name="Compiling-GNU-libmicrohttpd"></a>
+<table cellpadding="1" cellspacing="1" border="0">
+<tr><td valign="middle" align="left">[<a href="#Thread-modes-and-event-loops"
title="Previous section in reading order"> < </a>]</td>
+<td valign="middle" align="left">[<a
href="#Including-the-microhttpd_002eh-header" title="Next section in reading
order"> > </a>]</td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dintro"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dintro" title="Up
section"> Up </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dconst" title="Next
chapter"> >> </a>]</td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
+<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
+<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
+<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
+</tr></table>
+<h2 class="section">1.3 Compiling GNU libmicrohttpd</h2>
+<a name="index-compilation"></a>
+<a name="index-embedded-systems"></a>
+<a name="index-portability"></a>
+
+<p>MHD uses the standard GNU system where the usual build process
+involves running
+</p><pre class="verbatim">$ ./configure
+$ make
+$ make install
+</pre>
+<p>MHD supports various options to be given to configure to tailor the
+binary to a specific situation. Note that some of these options will
+remove portions of the MHD code that are required for
+binary-compatibility. They should only be used on embedded systems
+with tight resource constraints and no concerns about library
+versioning. Standard distributions including MHD are expected to
+always ship with all features enabled, otherwise unexpected
+incompatibilities can arise!
+</p>
+<p>Here is a list of MHD-specific options that can be given to configure
+(canonical configure options such as “–prefix” are also
supported, for a
+full list of options run “./configure –help”):
+</p>
+<dl compact="compact">
+<dt> <code>``--disable-curl''</code></dt>
+<dd><p>disable running testcases using libcurl
+</p>
+</dd>
+<dt> <code>``--disable-largefile''</code></dt>
+<dd><p>disable support for 64-bit files
+</p>
+</dd>
+<dt> <code>``--disable-messages''</code></dt>
+<dd><p>disable logging of error messages (smaller binary size, not so much fun
for debugging)
+</p>
+</dd>
+<dt> <code>``--disable-https''</code></dt>
+<dd><p>disable HTTPS support, even if GNUtls is found; this option must be
used if eCOS license is desired as an option (in all cases the resulting binary
falls under a GNU LGPL-only license)
+</p>
+</dd>
+<dt> <code>``--disable-postprocessor''</code></dt>
+<dd><p>do not include the post processor API (results in binary
incompatibility)
+</p>
+</dd>
+<dt> <code>``--disable-dauth''</code></dt>
+<dd><p>do not include the authentication APIs (results in binary
incompatibility)
+</p>
+</dd>
+<dt> <code>``--disable-epoll</code></dt>
+<dd><p>do not include epoll support, even on Linux (minimally smaller binary
size, good for testing portability to non-Linux systems)
+</p>
+</dd>
+<dt> <code>``--enable-coverage''</code></dt>
+<dd><p>set flags for analysis of code-coverage with gcc/gcov (results in slow,
large binaries)
+</p>
+</dd>
+<dt> <code>``--with-gcrypt=PATH''</code></dt>
+<dd><p>specifies path to libgcrypt installation
+</p>
+</dd>
+<dt> <code>``--with-gnutls=PATH''</code></dt>
+<dd><p>specifies path to libgnutls installation
+</p>
+
+</dd>
+</dl>
+
+
+<hr size="6">
<a name="Including-the-microhttpd_002eh-header"></a>
<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#Scope" title="Previous section
in reading order"> < </a>]</td>
+<tr><td valign="middle" align="left">[<a href="#Compiling-GNU-libmicrohttpd"
title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#SIGPIPE" title="Next section in
reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#microhttpd_002dintro"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
@@ -226,8 +397,8 @@
<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
</tr></table>
-<h2 class="section">1.2 Including the microhttpd.h header</h2>
-<a name="index-portability"></a>
+<h2 class="section">1.4 Including the microhttpd.h header</h2>
+<a name="index-portability-1"></a>
<a name="index-microhttpd_002eh"></a>
<p>Ideally, before including "microhttpd.h" you should add the
necessary
@@ -241,7 +412,7 @@
<p>Once you have ensured that you manually (!) included the right headers
for your platform before "microhttpd.h", you should also add a line
with <code>#define MHD_PLATFORM_H</code> which will prevent the
-"microhttpd.h" header from trying (and, depending on your platform,
+"microhttpd.h" header from trying (and, depending on your platform,
failing) to include the right headers.
</p>
<p>If you do not define MHD_PLATFORM_H, the "microhttpd.h" header
will
@@ -252,7 +423,7 @@
<a name="SIGPIPE"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a
href="#Including-the-microhttpd_002eh-header" title="Previous section in
reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#MHD_005fLONG_005fLONG" title="Next
section in reading order"> > </a>]</td>
+<td valign="middle" align="left">[<a
href="#MHD_005fUNSIGNED_005fLONG_005fLONG" title="Next section in reading
order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#microhttpd_002dintro"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#microhttpd_002dintro" title="Up
section"> Up </a>]</td>
@@ -266,17 +437,17 @@
<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
</tr></table>
-<h2 class="section">1.3 SIGPIPE</h2>
+<h2 class="section">1.5 SIGPIPE</h2>
<a name="index-signals"></a>
-<p><acronym>MHD</acronym> does not install a signal handler for SIGPIPE. On
platforms
+<p>MHD does not install a signal handler for SIGPIPE. On platforms
where this is possible (such as GNU/Linux), it disables SIGPIPE for
its I/O operations (by passing MSG_NOSIGNAL). On other platforms,
-SIGPIPE signals may be generated from network operations by
-<acronym>MHD</acronym> and will cause the process to die unless the developer
+SIGPIPE signals may be generated from network operations by
+MHD and will cause the process to die unless the developer
explicitly installs a signal handler for SIGPIPE.
</p>
<p>Hence portable code using MHD must install a SIGPIPE handler or
-explicitly block the SIGPIPE signal. MHD does not do so in order
+explicitly block the SIGPIPE signal. MHD does not do so in order
to avoid messing with other parts of the application that may
need to handle SIGPIPE in a particular way. You can make your application
handle SIGPIPE by calling the following function in <code>main</code>:
</p>
@@ -304,10 +475,10 @@
}
</pre>
<hr size="6">
-<a name="MHD_005fLONG_005fLONG"></a>
+<a name="MHD_005fUNSIGNED_005fLONG_005fLONG"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SIGPIPE" title="Previous
section in reading order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#microhttpd_002dconst" title="Next
section in reading order"> > </a>]</td>
+<td valign="middle" align="left">[<a href="#Portability-to-W32" title="Next
section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#microhttpd_002dintro"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#microhttpd_002dintro" title="Up
section"> Up </a>]</td>
@@ -321,25 +492,99 @@
<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
</tr></table>
-<h2 class="section">1.4 MHD_LONG_LONG</h2>
+<h2 class="section">1.6 MHD_UNSIGNED_LONG_LONG</h2>
<a name="index-long-long"></a>
+<a name="index-MHD_005fLONG_005fLONG"></a>
<a name="index-IAR"></a>
<a name="index-ARM"></a>
<a name="index-cortex-m3"></a>
+<a name="index-embedded-systems-1"></a>
-<p>Some platforms do not support <code>long long</code>. Hence MHD defines
-a macro <code>MHD_LONG_LONG</code> which will default to <code>long
long</code>.
-If your platform does not support <code>long long</code>, you should
-change "platform.h" to define <code>MHD_LONG_LONG</code> to an
appropriate
-alternative type and also define <code>MHD_LONG_LONG_PRINTF</code> to the
-corresponding format string for printing such a data type (without
-the percent sign).
+<p>Some platforms do not support <code>long long</code>. Hence MHD defines a
+macro <code>MHD_UNSIGNED LONG_LONG</code> which will default to
+<code>unsigned long long</code>. For standard desktop operating systems,
+this is all you need to know.
</p>
+<p>However, if your platform does not support <code>unsigned long long</code>,
+you should change "platform.h" to define <code>MHD_LONG_LONG</code>
and
+<code>MHD_UNSIGNED_LONG_LONG</code> to an appropriate alternative type and
+also define <code>MHD_LONG_LONG_PRINTF</code> and
+<code>MHD_UNSIGNED_LONG_LONG_PRINTF</code> to the corresponding format
+string for printing such a data type. Note that the “signed”
+versions are deprecated. Also, for historical reasons,
+<code>MHD_LONG_LONG_PRINTF</code> is without the percent sign, whereas
+<code>MHD_UNSIGNED_LONG_LONG_PRINTF</code> is with the percent sign. Newly
+written code should only use the unsigned versions. However, you need
+to define both in "platform.h" if you need to change the definition
+for the specific platform.
+</p>
<hr size="6">
+<a name="Portability-to-W32"></a>
+<table cellpadding="1" cellspacing="1" border="0">
+<tr><td valign="middle" align="left">[<a
href="#MHD_005fUNSIGNED_005fLONG_005fLONG" title="Previous section in reading
order"> < </a>]</td>
+<td valign="middle" align="left">[<a href="#Portability-to-z_002fOS"
title="Next section in reading order"> > </a>]</td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dintro"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dintro" title="Up
section"> Up </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dconst" title="Next
chapter"> >> </a>]</td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
+<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
+<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
+<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
+</tr></table>
+<h2 class="section">1.7 Portability to W32</h2>
+
+<p>libmicrohttpd in general ported well to W32. Most libmicrohttpd features
+are supported. W32 do not support some functions, like epoll and
+corresponding MHD features are not available on W32.
+</p>
+
+<hr size="6">
+<a name="Portability-to-z_002fOS"></a>
+<table cellpadding="1" cellspacing="1" border="0">
+<tr><td valign="middle" align="left">[<a href="#Portability-to-W32"
title="Previous section in reading order"> < </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dconst" title="Next
section in reading order"> > </a>]</td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dintro"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dintro" title="Up
section"> Up </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dconst" title="Next
chapter"> >> </a>]</td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
+<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
+<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
+<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
+</tr></table>
+<h2 class="section">1.8 Portability to z/OS</h2>
+
+<p>To compile MHD on z/OS, extract the archive and run
+</p>
+<pre class="verbatim">iconv -f UTF-8 -t IBM-1047 contrib/ascebc >
/tmp/ascebc.sh
+chmod +x /tmp/ascebc.sh
+for n in `find * -type f`
+do
+ /tmp/ascebc.sh $n
+done
+</pre><p>to convert all source files to EBCDIC. Note that you must run
+<code>configure</code> from the directory where the configure script is
+located. Otherwise, configure will fail to find the
+<code>contrib/xcc</code> script (which is a wrapper around the z/OS c89
+compiler).
+</p>
+
+
+
+<hr size="6">
<a name="microhttpd_002dconst"></a>
<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a href="#MHD_005fLONG_005fLONG"
title="Previous section in reading order"> < </a>]</td>
+<tr><td valign="middle" align="left">[<a href="#Portability-to-z_002fOS"
title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="#microhttpd_002dstruct" title="Next
section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#microhttpd_002dintro"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
@@ -360,7 +605,7 @@
<dl>
<dt><a name="index-MHD_005fFLAG"></a><u>Enumeration:</u> <b>MHD_FLAG</b></dt>
-<dd><p>Options for the <acronym>MHD</acronym> daemon.
+<dd><p>Options for the MHD daemon.
</p>
<p>Note that if neither <code>MHD_USE_THREAD_PER_CONNECTION</code> nor
<code>MHD_USE_SELECT_INTERNALLY</code> is used, the client wants control over
@@ -369,7 +614,7 @@
<p>Starting the daemon may also fail if a particular option is not
implemented or not supported on the target platform (i.e. no support for
<acronym>SSL</acronym>, threads or IPv6). SSL support generally depends on
-options given during <acronym>MHD</acronym> compilation. Threaded operations
+options given during MHD compilation. Threaded operations
(including <code>MHD_USE_SELECT_INTERNALLY</code>) are not supported on
Symbian.
</p>
@@ -382,13 +627,17 @@
<dd><a name="index-debugging"></a>
<p>Run in debug mode. If this flag is used, the library should print error
messages and warnings to stderr. Note that for this
-run-time option to have any effect, <acronym>MHD</acronym> needs to be
-compiled with messages enabled. This is done by default except you ran
-configure with the <code>--disable-messages</code> flag set.
+run-time option to have any effect, MHD needs to be
+compiled with messages enabled. This is done by default except you ran
+configure with the <code>--disable-messages</code> flag set.
</p>
</dd>
<dt> <code>MHD_USE_SSL</code></dt>
-<dd><p>Run in https mode (this option may not work with all threading modes
yet).
+<dd><a name="index-TLS"></a>
+<a name="index-SSL"></a>
+<p>Run in HTTPS-mode. If you specify <code>MHD_USE_SSL</code> and MHD was
+compiled without SSL support, <code>MHD_start_daemon</code> will return
+NULL.
</p>
</dd>
<dt> <code>MHD_USE_THREAD_PER_CONNECTION</code></dt>
@@ -401,70 +650,163 @@
</dd>
<dt> <code>MHD_USE_IPv6</code></dt>
<dd><a name="index-IPv6"></a>
-<p>Run using the IPv6 protocol (otherwise, <acronym>MHD</acronym> will just
support IPv4).
+<p>Run using the IPv6 protocol (otherwise, MHD will just support IPv4).
+If you specify <code>MHD_USE_IPV6</code> and the local platform does not
+support it, <code>MHD_start_daemon</code> will return NULL.
</p>
-
+<p>If you want MHD to support IPv4 and IPv6 using a single socket, pass
+MHD_USE_DUAL_STACK, otherwise, if you only pass this option, MHD will
+try to bind to IPv6-only (resulting in no IPv4 support).
+</p>
</dd>
+<dt> <code>MHD_USE_DUAL_STACK</code></dt>
+<dd><a name="index-IPv6-1"></a>
+<p>Use a single socket for IPv4 and IPv6. Note that this will mean
+that IPv4 addresses are returned by MHD in the IPv6-mapped format
+(the ’struct sockaddr_in6’ format will be used for IPv4 and IPv6).
+</p>
+</dd>
<dt> <code>MHD_USE_PEDANTIC_CHECKS</code></dt>
<dd><p>Be pedantic about the protocol (as opposed to as tolerant as possible).
-Specifically, at the moment, this flag causes <acronym>MHD</acronym> to reject
<acronym>HTTP</acronym>
+Specifically, at the moment, this flag causes MHD to reject HTTP
1.1 connections without a <code>Host</code> header. This is required by the
standard, but of course in violation of the “be as liberal as possible
in what you accept” norm. It is recommended to turn this
<strong>ON</strong>
-if you are testing clients against <acronym>MHD</acronym>, and
<strong>OFF</strong> in
+if you are testing clients against MHD, and <strong>OFF</strong> in
production.
</p>
</dd>
<dt> <code>MHD_USE_POLL</code></dt>
<dd><a name="index-FD_005fSETSIZE"></a>
-<a name="index-poll"></a>
-<a name="index-select"></a>
+<a name="index-poll-1"></a>
+<a name="index-select-1"></a>
<p>Use poll instead of select. This allows sockets with descriptors
-<code>>= FD_SETSIZE</code>. This option only works in conjunction with
-<code>MHD_USE_THREAD_PER_CONNECTION</code> (at this point).
+<code>>= FD_SETSIZE</code>. This option currently only works in conjunction
+with <code>MHD_USE_THREAD_PER_CONNECTION</code> or
+<code>MHD_USE_INTERNAL_SELECT</code> (at this point). If you specify
+<code>MHD_USE_POLL</code> and the local platform does not support it,
+<code>MHD_start_daemon</code> will return NULL.
</p>
</dd>
+<dt> <code>MHD_USE_EPOLL_LINUX_ONLY</code></dt>
+<dd><a name="index-FD_005fSETSIZE-1"></a>
+<a name="index-epoll-1"></a>
+<a name="index-select-2"></a>
+<p>Use epoll instead of poll or select. This allows sockets with
+descriptors <code>>= FD_SETSIZE</code>. This option is only available on
+Linux systems and only works in conjunction with
+<code>MHD_USE_THREAD_PER_CONNECTION</code> (at this point). If you specify
+<code>MHD_USE_EPOLL_LINUX_ONLY</code> and the local platform does not
+support it, <code>MHD_start_daemon</code> will return NULL. Using epoll
+instead of select or poll can in some situations result in significantly
+higher performance as the system call has fundamentally lower complexity
+(O(1) for epoll vs. O(n) for select/poll where n is the number of
+open connections).
+</p>
+</dd>
+<dt> <code>MHD_SUPPRESS_DATE_NO_CLOCK</code></dt>
+<dd><a name="index-date"></a>
+<a name="index-clock"></a>
+<a name="index-embedded-systems-2"></a>
+<p>Suppress (automatically) adding the ’Date:’ header to HTTP
responses.
+This option should ONLY be used on systems that do not have a clock
+and that DO provide other mechanisms for cache control. See also
+RFC 2616, section 14.18 (exception 3).
+</p>
+
+</dd>
+<dt> <code>MHD_USE_NO_LISTEN_SOCKET</code></dt>
+<dd><a name="index-listen"></a>
+<a name="index-proxy"></a>
+<a name="index-embedded-systems-3"></a>
+<p>Run the HTTP server without any listen socket. This option only makes
+sense if <code>MHD_add_connection</code> is going to be used exclusively to
+connect HTTP clients to the HTTP server. This option is incompatible
+with using a thread pool; if it is used,
+<code>MHD_OPTION_THREAD_POOL_SIZE</code> is ignored.
+</p>
+</dd>
+<dt> <code>MHD_USE_PIPE_FOR_SHUTDOWN</code></dt>
+<dd><a name="index-quiesce"></a>
+<p>Force MHD to use a signal pipe to notify the event loop (of threads)
+of our shutdown. This is required if an appliction uses
+<code>MHD_USE_INTERNAL_SELECT</code> or
<code>MHD_USE_THREAD_PER_CONNECTION</code>
+and then performs <code>MHD_quiesce_daemon</code> (which eliminates our
+ability to signal termination via the listen socket). In these modes,
+<code>MHD_quiesce_daemon</code> will fail if this option was not set. Also,
+use of this option is automatic (as in, you do not even have to
+specify it), if <code>MHD_USE_NO_LISTEN_SOCKET</code> is specified. In
+"external" select mode, this option is always simply ignored.
+</p>
+</dd>
+<dt> <code>MHD_USE_SUSPEND_RESUME</code></dt>
+<dd><p>Enables using <code>MHD_suspend_connection</code> and
+<code>MHD_resume_connection</code>, as performing these calls requires some
+additional pipes to be created, and code not using these calls should
+not pay the cost.
+</p>
+</dd>
+<dt> <code>MHD_USE_TCP_FASTOPEN</code></dt>
+<dd><a name="index-listen-1"></a>
+<p>Enable TCP_FASTOPEN on the listen socket. TCP_FASTOPEN is currently
+supported on Linux >= 3.6. On other systems using this option with
+cause <code>MHD_start_daemon</code> to fail.
+</p>
+</dd>
</dl>
</dd></dl>
<dl>
<dt><a name="index-MHD_005fOPTION"></a><u>Enumeration:</u>
<b>MHD_OPTION</b></dt>
-<dd><p><acronym>MHD</acronym> options. Passed in the varargs portion of
+<dd><p>MHD options. Passed in the varargs portion of
<code>MHD_start_daemon()</code>.
</p>
<dl compact="compact">
<dt> <code>MHD_OPTION_END</code></dt>
<dd><p>No more options / last option. This is used to terminate the VARARGs
list.
-</p>
+</p>
</dd>
<dt> <code>MHD_OPTION_CONNECTION_MEMORY_LIMIT</code></dt>
<dd><a name="index-memory_002c-limiting-memory-utilization"></a>
<p>Maximum memory size per connection (followed by a <code>size_t</code>). The
default is 32 kB (32*1024 bytes) as defined by the internal constant
-<code>MHD_POOL_SIZE_DEFAULT</code>.
+<code>MHD_POOL_SIZE_DEFAULT</code>. Values above 128k are unlikely to
+result in much benefit, as half of the memory will be typically used
+for IO, and TCP buffers are unlikely to support window sizes above 64k
+on most systems.
</p>
</dd>
+<dt> <code>MHD_OPTION_CONNECTION_MEMORY_INCREMENT</code></dt>
+<dd><a name="index-memory"></a>
+<p>Increment to use for growing the read buffer (followed by a
+<code>size_t</code>). The default is 1024 (bytes). Increasing this value
+will make MHD use memory for reading more aggressively, which can
+reduce the number of <code>recvfrom</code> calls but may increase the number
+of <code>sendto</code> calls. The given value must fit within
+MHD_OPTION_CONNECTION_MEMORY_LIMIT.
+</p>
+</dd>
<dt> <code>MHD_OPTION_CONNECTION_LIMIT</code></dt>
<dd><a name="index-connection_002c-limiting-number-of-connections"></a>
<p>Maximum number of concurrent connections to accept (followed by an
<code>unsigned int</code>). The default is <code>FD_SETSIZE - 4</code> (the
maximum number of file descriptors supported by <code>select</code> minus
four for <code>stdin</code>, <code>stdout</code>, <code>stderr</code> and the
server
-socket). In other words, the default is as large as possible.
+socket). In other words, the default is as large as possible.
</p>
<p>Note that if you set a low connection limit, you can easily get into
trouble with browsers doing request pipelining. For example, if your
connection limit is “1”, a browser may open a first connection to
-access your “index.html” file, keep it open but use a second
+access your “index.html” file, keep it open but use a second
connection to retrieve CSS files, images and the like. In fact, modern
browsers are typically by default configured for up to 15 parallel
connections to a single server. If this happens, MHD will refuse to
even accept the second connection until the first connection is
closed — which does not happen until timeout. As a result, the
browser will fail to render the page and seem to hang. If you expect
-your server to operate close to the connection limit, you should
+your server to operate close to the connection limit, you should
first consider using a lower timeout value and also possibly add
a “Connection: close” header to your response to ensure that
request pipelining is not used and connections are closed immediately
@@ -510,10 +852,12 @@
<dt> <code>MHD_OPTION_SOCK_ADDR</code></dt>
<dd><a name="index-bind_002c-restricting-bind"></a>
<p>Bind daemon to the supplied socket address. This option should be followed
by a
-<code>struct sockaddr *</code>. If <code>MHD_USE_IPv6</code> is specified,
-the <code>struct sockaddr*</code> should point to a <code>struct
sockaddr_in6</code>,
+<code>struct sockaddr *</code>. If <code>MHD_USE_IPv6</code> is specified,
+the <code>struct sockaddr*</code> should point to a <code>struct
sockaddr_in6</code>,
otherwise to a <code>struct sockaddr_in</code>. If this option is not
specified,
-the daemon will listen to incoming connections from anywhere.
+the daemon will listen to incoming connections from anywhere. If you use this
+option, the ’port’ argument from <code>MHD_start_daemon</code> is
ignored and the port
+from the given <code>struct sockaddr *</code> will be used instead.
</p>
</dd>
<dt> <code>MHD_OPTION_URI_LOG_CALLBACK</code></dt>
@@ -526,41 +870,45 @@
parsing will no longer contain the options, which maybe inconvenient for
logging. This option should be followed by two arguments, the first
one must be of the form
-</p><table><tr><td> </td><td><pre class="example"> void * my_logger(void
* cls, const char * uri)
+</p><table><tr><td> </td><td><pre class="example"> void * my_logger(void
* cls, const char * uri, struct MHD_Connection *con)
</pre></td></tr></table>
<p>where the return value will be passed as
<code>*con_cls</code> in calls to the <code>MHD_AccessHandlerCallback</code>
when this request is processed later; returning a
-value of NULL has no special significance; (however,
-note that if you return non-NULL, you can no longer
+value of <code>NULL</code> has no special significance; (however,
+note that if you return non-<code>NULL</code>, you can no longer
rely on the first call to the access handler having
<code>NULL == *con_cls</code> on entry)
<code>cls</code> will be set to the second argument following
MHD_OPTION_URI_LOG_CALLBACK. Finally, <code>uri</code> will
be the 0-terminated URI of the request.
</p>
+<p>Note that during the time of this call, most of the connection’s state
+is not initialized (as we have not yet parsed he headers). However,
+information about the connecting client (IP, socket) is available.
+</p>
</dd>
<dt> <code>MHD_OPTION_HTTPS_MEM_KEY</code></dt>
-<dd><a name="index-SSL"></a>
-<a name="index-TLS"></a>
+<dd><a name="index-SSL-1"></a>
+<a name="index-TLS-1"></a>
<p>Memory pointer to the private key to be used by the
HTTPS daemon. This option should be followed by an
"const char*" argument.
This should be used in conjunction with
’MHD_OPTION_HTTPS_MEM_CERT’.
-</p>
+</p>
</dd>
<dt> <code>MHD_OPTION_HTTPS_MEM_CERT</code></dt>
-<dd><a name="index-SSL-1"></a>
-<a name="index-TLS-1"></a>
+<dd><a name="index-SSL-2"></a>
+<a name="index-TLS-2"></a>
<p>Memory pointer to the certificate to be used by the
HTTPS daemon. This option should be followed by an
"const char*" argument.
This should be used in conjunction with ’MHD_OPTION_HTTPS_MEM_KEY’.
-</p>
+</p>
</dd>
<dt> <code>MHD_OPTION_HTTPS_MEM_TRUST</code></dt>
-<dd><a name="index-SSL-2"></a>
-<a name="index-TLS-2"></a>
+<dd><a name="index-SSL-3"></a>
+<a name="index-TLS-3"></a>
<p>Memory pointer to the CA certificate to be used by the
HTTPS daemon to authenticate and trust clients certificates.
This option should be followed by an "const char*" argument.
@@ -571,19 +919,19 @@
Note that most browsers will only present a client certificate
only if they have one matching the specified CA, not sending
any certificate otherwise.
-</p>
+</p>
</dd>
<dt> <code>MHD_OPTION_HTTPS_CRED_TYPE</code></dt>
-<dd><a name="index-SSL-3"></a>
-<a name="index-TLS-3"></a>
+<dd><a name="index-SSL-4"></a>
+<a name="index-TLS-4"></a>
<p>Daemon credentials type. Either certificate or anonymous,
this option should be followed by one of the values listed in
"enum gnutls_credentials_type_t".
-</p>
+</p>
</dd>
<dt> <code>MHD_OPTION_HTTPS_PRIORITIES</code></dt>
-<dd><a name="index-SSL-4"></a>
-<a name="index-TLS-4"></a>
+<dd><a name="index-SSL-5"></a>
+<a name="index-TLS-5"></a>
<a name="index-cipher"></a>
<p>SSL/TLS protocol version and ciphers.
This option must be followed by an "const char *" argument
@@ -593,6 +941,23 @@
specified, “NORMAL” is used.
</p>
</dd>
+<dt> <code>MHD_OPTION_HTTPS_CERT_CALLBACK</code></dt>
+<dd><a name="index-SSL-6"></a>
+<a name="index-TLS-6"></a>
+<a name="index-SNI"></a>
+<p>Use a callback to determine which X.509 certificate should be used for
+a given HTTPS connection. This option should be followed by a
+argument of type "gnutls_certificate_retrieve_function2 *". This
+option provides an alternative to MHD_OPTION_HTTPS_MEM_KEY and
+MHD_OPTION_HTTPS_MEM_CERT. You must use this version if multiple
+domains are to be hosted at the same IP address using TLS’s Server
+Name Indication (SNI) extension. In this case, the callback is
+expected to select the correct certificate based on the SNI
+information provided. The callback is expected to access the SNI data
+using gnutls_server_name_get(). Using this option requires GnuTLS 3.0
+or higher.
+</p>
+</dd>
<dt> <code>MHD_OPTION_DIGEST_AUTH_RANDOM</code></dt>
<dd><a name="index-digest-auth"></a>
<a name="index-random"></a>
@@ -603,7 +968,7 @@
second argument in bytes. Note that the application must ensure that
the buffer of the second argument remains allocated and unmodified
while the daemon is running. For security, you SHOULD provide a fresh
-random nonce when using MHD with Digest Authentication.
+random nonce when using MHD with Digest Authentication.
</p>
</dd>
<dt> <code>MHD_OPTION_NONCE_NC_SIZE</code></dt>
@@ -636,7 +1001,7 @@
(systemd-style). If this option is used, MHD will not open its own
listen socket(s). The argument passed must be of type "int" and refer
to an existing socket that has been bound to a port and is listening.
-</p>
+</p>
</dd>
<dt> <code>MHD_OPTION_EXTERNAL_LOGGER</code></dt>
<dd><a name="index-logging-1"></a>
@@ -646,19 +1011,19 @@
of type ’void fun(void * arg, const char * fmt, va_list ap)’
and the second a pointer of type ’void*’ which will
be passed as the "arg" argument to "fun".
-</p>
-<p>Note that MHD will not generate any log messages without
-the MHD_USE_DEBUG flag set and if MHD was compiled
-with the "–disable-messages" flag.
</p>
+<p>Note that MHD will not generate any log messages without
+the MHD_USE_DEBUG flag set and if MHD was compiled
+with the "–disable-messages" flag.
+</p>
</dd>
<dt> <code>MHD_OPTION_THREAD_POOL_SIZE</code></dt>
-<dd><a name="index-performance"></a>
+<dd><a name="index-performance-1"></a>
<p>Number (unsigned int) of threads in thread pool. Enable
thread pooling by setting this value to to something
greater than 1. Currently, thread model must be
MHD_USE_SELECT_INTERNALLY if thread pooling is enabled
-(MHD_start_daemon returns NULL for an unsupported thread
+(<code>MHD_start_daemon</code> returns <code>NULL</code> for an unsupported
thread
model).
</p>
</dd>
@@ -707,16 +1072,40 @@
<code>cls</code> will be set to the second argument following
MHD_OPTION_UNESCAPE_CALLBACK.
</p>
-
+
</dd>
<dt> <code>MHD_OPTION_THREAD_STACK_SIZE</code></dt>
-<dd><a name="index-stack_002c-thread_002c-pthread"></a>
+<dd><a name="index-stack"></a>
+<a name="index-thread"></a>
+<a name="index-pthread"></a>
+<a name="index-embedded-systems-4"></a>
<p>Maximum stack size for threads created by MHD. This option must be
followed by a <code>size_t</code>). Not specifying this option or using
-a value of zero means using the system default (which is likely to
+a value of zero means using the system default (which is likely to
differ based on your platform).
</p>
</dd>
+<dt> <code>MHD_OPTION_TCP_FASTQUEUE_QUEUE_SIZE</code></dt>
+<dd><a name="index-listen-2"></a>
+<p>When the flag <code>MHD_USE_TCP_FASTOPEN</code> is used, this option sets
the
+connection handshake queue size for the TCP FASTOPEN connections. Note
+that a TCP FASTOPEN connection handshake occupies more resources than a
+TCP handshake as the SYN packets also contain DATA which is kept in the
+associate state until handshake is completed. If this option is not
+given the queue size is set to a default value of 10. This option must
+be followed by a <code>unsigned int</code>.
+</p>
+</dd>
+<dt> <code>MHD_OPTION_HTTPS_MEM_DHPARAMS</code></dt>
+<dd><a name="index-TLS-7"></a>
+<a name="index-SSL-7"></a>
+<a name="index-DH"></a>
+<p>Memory pointer for the Diffie-Hellman parameters (dh.pem) to be used
+by the HTTPS daemon for key exchange. This option must be followed by
+a <code>const char *</code> argument. The argument would be a zero-terminated
+string with a PEM encoded PKCS3 DH parameters structure suitable
+for passing to <code>gnutls_dh_parms_import_pkcs3</code>.
+</p></dd>
</dl>
</dd></dl>
@@ -724,7 +1113,7 @@
<dl>
<dt><a name="index-MHD_005fOptionItem"></a><u>C Struct:</u>
<b>MHD_OptionItem</b></dt>
<dd><p>Entry in an MHD_OPTION_ARRAY. See the <code>MHD_OPTION_ARRAY</code>
option
-argument for its use.
+argument for its use.
</p>
<p>The <code>option</code> member is used to specify which option is specified
in the array. The other members specify the respective argument.
@@ -740,7 +1129,7 @@
<dl>
<dt><a name="index-MHD_005fValueKind"></a><u>Enumeration:</u>
<b>MHD_ValueKind</b></dt>
<dd><p>The <code>MHD_ValueKind</code> specifies the source of the key-value
pairs in
-the <acronym>HTTP</acronym> protocol.
+the HTTP protocol.
</p>
<dl compact="compact">
<dt> <code>MHD_RESPONSE_HEADER_KIND</code></dt>
@@ -748,19 +1137,19 @@
</p>
</dd>
<dt> <code>MHD_HEADER_KIND</code></dt>
-<dd><p><acronym>HTTP</acronym> header.
+<dd><p>HTTP header.
</p>
</dd>
<dt> <code>MHD_COOKIE_KIND</code></dt>
<dd><a name="index-cookie"></a>
-<p>Cookies. Note that the original <acronym>HTTP</acronym> header containing
the cookie(s)
+<p>Cookies. Note that the original HTTP header containing the cookie(s)
will still be available and intact.
</p>
</dd>
<dt> <code>MHD_POSTDATA_KIND</code></dt>
<dd><a name="index-POST-method"></a>
<p><code>POST</code> data. This is available only if a content encoding
-supported by <acronym>MHD</acronym> is used (currently only
<acronym>URL</acronym> encoding), and
+supported by MHD is used (currently only <acronym>URL</acronym> encoding), and
only if the posted content fits within the available memory pool. Note
that in that case, the upload data given to the
<code>MHD_AccessHandlerCallback()</code> will be empty (since it has
@@ -768,11 +1157,11 @@
</p>
</dd>
<dt> <code>MHD_GET_ARGUMENT_KIND</code></dt>
-<dd><p><code>GET</code> (<acronym>URI</acronym>) arguments.
+<dd><p><code>GET</code> (URI) arguments.
</p>
</dd>
<dt> <code>MHD_FOOTER_KIND</code></dt>
-<dd><p><acronym>HTTP</acronym> footer (only for http 1.1 chunked encodings).
+<dd><p>HTTP footer (only for http 1.1 chunked encodings).
</p>
</dd>
</dl>
@@ -800,7 +1189,7 @@
</p>
</dd>
<dt> <code>MHD_REQUEST_TERMINATED_DAEMON_SHUTDOWN</code></dt>
-<dd><p>We had to close the session since <acronym>MHD</acronym> was being shut
down.
+<dd><p>We had to close the session since MHD was being shut down.
</p></dd>
</dl>
</dd></dl>
@@ -809,7 +1198,7 @@
<dl>
<dt><a name="index-MHD_005fResponseMemoryMode"></a><u>Enumeration:</u>
<b>MHD_ResponseMemoryMode</b></dt>
<dd><p>The <code>MHD_ResponeMemoryMode</code> specifies how MHD should treat
-the memory buffer given for the response in
+the memory buffer given for the response in
<code>MHD_create_response_from_buffer</code>.
</p>
<dl compact="compact">
@@ -817,13 +1206,13 @@
<dd><p>Buffer is a persistent (static/global) buffer that won’t change
for at least the lifetime of the response, MHD should just use
it, not free it, not copy it, just keep an alias to it.
-</p>
+</p>
</dd>
<dt> <code>MHD_RESPMEM_MUST_FREE</code></dt>
<dd><p>Buffer is heap-allocated with <code>malloc</code> (or equivalent) and
should be freed by MHD after processing the response has
concluded (response reference counter reaches zero).
-</p>
+</p>
</dd>
<dt> <code>MHD_RESPMEM_MUST_COPY</code></dt>
<dd><p>Buffer is in transient memory, but not on the heap (for example,
@@ -836,9 +1225,41 @@
</dd></dl>
+<dl>
+<dt><a name="index-MHD_005fResponseFlags"></a><u>Enumeration:</u>
<b>MHD_ResponseFlags</b></dt>
+<dd><p>Response-specific flags. Passed as an argument to
+<code>MHD_set_response_options()</code>.
+</p>
+<dl compact="compact">
+<dt> <code>MHD_RF_NONE</code></dt>
+<dd><p>No special handling.
+</p>
+</dd>
+<dt> <code>MHD_RF_HTTP_VERSION_1_0_ONLY</code></dt>
+<dd><p>Only respond in conservative HTTP 1.0-mode. In particular,
+do not (automatically) sent "Connection" headers and always
+close the connection after generating the response.
+</p>
+</dd>
+</dl>
+</dd></dl>
+<dl>
+<dt><a name="index-MHD_005fResponseOptions"></a><u>Enumeration:</u>
<b>MHD_ResponseOptions</b></dt>
+<dd><p>Response-specific options. Passed in the varargs portion of
+<code>MHD_set_response_options()</code>.
+</p>
+<dl compact="compact">
+<dt> <code>MHD_RO_END</code></dt>
+<dd><p>No more options / last option. This is used to terminate the VARARGs
+list.
+</p></dd>
+</dl>
+</dd></dl>
+
+
<hr size="6">
<a name="microhttpd_002dstruct"></a>
<table cellpadding="1" cellspacing="1" border="0">
@@ -863,15 +1284,15 @@
<dl>
<dt><a name="index-MHD_005fDaemon"></a><u>C Struct:</u> <b>MHD_Daemon</b></dt>
-<dd><p>Handle for the daemon (listening on a socket for
<acronym>HTTP</acronym> traffic).
+<dd><p>Handle for the daemon (listening on a socket for HTTP traffic).
</p></dd></dl>
<dl>
<dt><a name="index-MHD_005fConnection"></a><u>C Struct:</u>
<b>MHD_Connection</b></dt>
-<dd><p>Handle for a connection / <acronym>HTTP</acronym> request. With
<acronym>HTTP</acronym>/1.1, multiple
-requests can be run over the same connection. However, <acronym>MHD</acronym>
will only
-show one request per <acronym>TCP</acronym> connection to the client at any
given time.
+<dd><p>Handle for a connection / HTTP request. With HTTP/1.1, multiple
+requests can be run over the same connection. However, MHD will only
+show one request per TCP connection to the client at any given time.
</p></dd></dl>
@@ -946,9 +1367,9 @@
<dl>
<dt><a name="index-_002aMHD_005fAccessHandlerCallback"></a><u>Function
Pointer:</u> int <b>*MHD_AccessHandlerCallback</b><i> (void *cls, struct
MHD_Connection * connection, const char *url, const char *method, const char
*version, const char *upload_data, size_t *upload_data_size, void
**con_cls)</i></dt>
<dd><p>Invoked in the context of a connection to answer a request from the
-client. This callback must call <acronym>MHD</acronym> functions (example: the
+client. This callback must call MHD functions (example: the
<code>MHD_Response</code> ones) to provide content to give back to the client
-and return an <acronym>HTTP</acronym> status code (i.e. <code>200</code> for
OK, <code>404</code>,
+and return an HTTP status code (i.e. <code>200</code> for OK, <code>404</code>,
etc.).
</p>
<p><a href="#microhttpd_002dpost">Adding a <code>POST</code> processor</a>,
for details on how to code this callback.
@@ -963,16 +1384,16 @@
</p>
</dd>
<dt> <var>url</var></dt>
-<dd><p>the <acronym>URL</acronym> requested by the client;
+<dd><p>the URL requested by the client;
</p>
</dd>
<dt> <var>method</var></dt>
-<dd><p>the <acronym>HTTP</acronym> method used by the client
(<code>GET</code>, <code>PUT</code>,
+<dd><p>the HTTP method used by the client (<code>GET</code>, <code>PUT</code>,
<code>DELETE</code>, <code>POST</code>, etc.);
</p>
</dd>
<dt> <var>version</var></dt>
-<dd><p>the <acronym>HTTP</acronym> version string (i.e. <code>HTTP/1.1</code>);
+<dd><p>the HTTP version string (i.e. <code>HTTP/1.1</code>);
</p>
</dd>
<dt> <var>upload_data</var></dt>
@@ -1009,7 +1430,7 @@
</dd>
<dt> <var>con_cls</var></dt>
<dd><p>reference to a pointer, initially set to <code>NULL</code>, that this
callback can
-set to some address and that will be preserved by <acronym>MHD</acronym> for
future
+set to some address and that will be preserved by MHD for future
calls for this request;
</p>
<p>since the access handler may be called many times (i.e., for a
@@ -1026,7 +1447,7 @@
<dl>
<dt><a name="index-_002aMHD_005fRequestCompletedCallback"></a><u>Function
Pointer:</u> void <b>*MHD_RequestCompletedCallback</b><i> (void *cls, struct
MHD_Connectionconnection, void **con_cls, enum MHD_RequestTerminationCode
toe)</i></dt>
-<dd><p>Signature of the callback used by <acronym>MHD</acronym> to notify the
application about
+<dd><p>Signature of the callback used by MHD to notify the application about
completed requests.
</p>
<dl compact="compact">
@@ -1057,6 +1478,25 @@
request, and also to iterate over the headers that have been added to a
response.
</p>
+<dl compact="compact">
+<dt> <var>cls</var></dt>
+<dd><p>custom value specified when iteration was triggered;
+</p>
+</dd>
+<dt> <var>kind</var></dt>
+<dd><p>kind of the header we are looking at
+</p>
+</dd>
+<dt> <var>key</var></dt>
+<dd><p>key for the value, can be an empty string
+</p>
+</dd>
+<dt> <var>value</var></dt>
+<dd><p>value corresponding value, can be NULL
+</p>
+</dd>
+</dl>
+
<p>Return <code>MHD_YES</code> to continue iterating, <code>MHD_NO</code> to
abort the
iteration.
</p></dd></dl>
@@ -1064,17 +1504,13 @@
<dl>
<dt><a name="index-_002aMHD_005fContentReaderCallback"></a><u>Function
Pointer:</u> int <b>*MHD_ContentReaderCallback</b><i> (void *cls, uint64_t pos,
char *buf, size_t max)</i></dt>
-<dd><p>Callback used by <acronym>MHD</acronym> in order to obtain content.
The callback has to
+<dd><p>Callback used by MHD in order to obtain content. The callback has to
copy at most <var>max</var> bytes of content into <var>buf</var>. The total
number of bytes that has been placed into <var>buf</var> should be returned.
</p>
-<p>Note that returning zero will cause <acronym>MHD</acronym> to try again,
either
-“immediately” if in multi-threaded mode (in which case the callback
-may want to do blocking operations to avoid busy waiting) or in the
-next round if <code>MHD_run</code> is used. Returning zero for a daemon
-that runs in internal <code>select()</code> mode is an error (since it
-would result in busy waiting) and cause the program to be aborted
-(<code>abort()</code>).
+<p>Note that returning zero will cause MHD to try again.
+Thus, returning zero should only be used in conjunction
+with <code>MHD_suspend_connection()</code> to avoid busy waiting.
</p>
<p>While usually the callback simply returns the number of bytes written
into <var>buf</var>, there are two special return value:
@@ -1082,22 +1518,22 @@
<p><code>MHD_CONTENT_READER_END_OF_STREAM</code> (-1) should be returned
for the regular end of transmission (with chunked encoding, MHD will then
terminate the chunk and send any HTTP footers that might be
-present; without chunked encoding and given an unknown
-response size, <acronym>MHD</acronym> will simply close the connection; note
+present; without chunked encoding and given an unknown
+response size, MHD will simply close the connection; note
that while returning <code>MHD_CONTENT_READER_END_OF_STREAM</code> is not
technically
legal if a response size was specified, MHD accepts this
and treats it just as <code>MHD_CONTENT_READER_END_WITH_ERROR</code>.
</p>
<p><code>MHD_CONTENT_READER_END_WITH_ERROR</code> (-2) is used to indicate a
server
-error generating the response; this will cause <acronym>MHD</acronym> to simply
+error generating the response; this will cause MHD to simply
close the connection immediately. If a response size was
given or if chunked encoding is in use, this will indicate
an error to the client. Note, however, that if the client
does not know a response size and chunked encoding is not in
use, then clients will not be able to tell the difference between
-<code>MHD_CONTENT_READER_END_WITH_ERROR</code> and
+<code>MHD_CONTENT_READER_END_WITH_ERROR</code> and
<code>MHD_CONTENT_READER_END_OF_STREAM</code>.
-This is not a limitation of <acronym>MHD</acronym> but rather of the HTTP
protocol.
+This is not a limitation of MHD but rather of the HTTP protocol.
</p>
<dl compact="compact">
<dt> <var>cls</var></dt>
@@ -1108,20 +1544,20 @@
<dd><p>position in the datastream to access; note that if an
<code>MHD_Response</code> object is re-used, it is possible for the same
content reader to be queried multiple times for the same data; however,
-if an <code>MHD_Response</code> is not re-used, <acronym>MHD</acronym>
guarantees that
+if an <code>MHD_Response</code> is not re-used, MHD guarantees that
<var>pos</var> will be the sum of all non-negative return values obtained
from the content reader so far.
</p></dd>
</dl>
-<p>Return <code>-1</code> on error (<acronym>MHD</acronym> will no longer try
to read content and
+<p>Return <code>-1</code> on error (MHD will no longer try to read content and
instead close the connection with the client).
</p></dd></dl>
<dl>
<dt><a name="index-_002aMHD_005fContentReaderFreeCallback"></a><u>Function
Pointer:</u> void <b>*MHD_ContentReaderFreeCallback</b><i> (void *cls)</i></dt>
-<dd><p>This method is called by <acronym>MHD</acronym> if we are done with a
content reader.
+<dd><p>This method is called by MHD if we are done with a content reader.
It should be used to free resources associated with the content reader.
</p></dd></dl>
@@ -1202,12 +1638,12 @@
<dd><p>Set a handler for fatal errors.
</p>
<dl compact="compact">
-<dt> <var>cb</var> </dt>
+<dt> <var>cb</var></dt>
<dd><p>function to call if MHD encounters a fatal internal error. If no
handler was set explicitly, MHD will call <code>abort</code>.
</p>
</dd>
<dt> <var>cls</var></dt>
-<dd><p>closure argument for cb; the other arguments are the name of the source
file, line number and a string describing the nature of the fatal error (which
can be NULL)
+<dd><p>closure argument for cb; the other arguments are the name of the source
file, line number and a string describing the nature of the fatal error (which
can be <code>NULL</code>)
</p></dd>
</dl>
</dd></dl>
@@ -1236,7 +1672,7 @@
</p>
</dd>
<dt> <var>dh</var></dt>
-<dd><p>default handler for all <acronym>URI</acronym>s;
+<dd><p>default handler for all URIs;
</p>
</dd>
<dt> <var>dh_cls</var></dt>
@@ -1254,8 +1690,30 @@
<dl>
+<dt><a name="index-MHD_005fquiesce_005fdaemon"></a><u>Function:</u> int
<b>MHD_quiesce_daemon</b><i> (struct MHD_Daemon *daemon)</i></dt>
+<dd><a name="index-quiesce-1"></a>
+<p>Stop accepting connections from the listening socket. Allows clients
+to continue processing, but stops accepting new connections. Note
+that the caller is responsible for closing the returned socket;
+however, if MHD is run using threads (anything but external select
+mode), it must not be closed until AFTER <code>MHD_stop_daemon</code> has
+been called (as it is theoretically possible that an existing thread
+is still using it).
+</p>
+<p>This function is useful in the special case that a listen socket
+is to be migrated to another process (i.e. a newer version of the
+HTTP server) while existing connections should continue to be
+processed until they are finished.
+</p>
+<p>Return <code>-1</code> on error (daemon not listening), the handle to the
+listen socket otherwise.
+</p>
+</dd></dl>
+
+
+<dl>
<dt><a name="index-MHD_005fstop_005fdaemon"></a><u>Function:</u> void
<b>MHD_stop_daemon</b><i> (struct MHD_Daemon *daemon)</i></dt>
-<dd><p>Shutdown an <acronym>HTTP</acronym> daemon.
+<dd><p>Shutdown an HTTP daemon.
</p></dd></dl>
@@ -1263,46 +1721,101 @@
<dt><a name="index-MHD_005frun"></a><u>Function:</u> int <b>MHD_run</b><i>
(struct MHD_Daemon *daemon)</i></dt>
<dd><p>Run webserver operations (without blocking unless in client callbacks).
This method should be called by clients in combination with
-<code>MHD_get_fdset()</code> if the client-controlled <code>select()</code>
-method is used.
+<code>MHD_get_fdset()</code> if the client-controlled
<code>select</code>-method is used.
+<a name="index-select-3"></a>
+<a name="index-poll-2"></a>
</p>
+<p>This function will work for external <code>poll</code> and
<code>select</code> mode.
+However, if using external <code>select</code> mode, you may want to
+instead use <code>MHD_run_from_select</code>, as it is more efficient.
+</p>
+<dl compact="compact">
+<dt> <var>daemon</var></dt>
+<dd><p>daemon to process connections of
+</p></dd>
+</dl>
+
<p>Return <code>MHD_YES</code> on success, <code>MHD_NO</code> if this daemon
was not
started with the right options for this call.
</p></dd></dl>
<dl>
+<dt><a name="index-MHD_005frun_005ffrom_005fselect"></a><u>Function:</u> int
<b>MHD_run_from_select</b><i> (struct MHD_Daemon *daemon, const fd_set
*read_fd_set, const fd_set *write_fd_set, const fd_set *except_fd_set)</i></dt>
+<dd><p>Run webserver operations given sets of ready socket handles.
+<a name="index-select-4"></a>
+</p>
+<p>This method should be called by clients in combination with
+<code>MHD_get_fdset</code> if the client-controlled (external)
+select method is used.
+</p>
+<p>You can use this function instead of <code>MHD_run</code> if you called
+<code>select</code> on the result from <code>MHD_get_fdset</code>. File
descriptors in
+the sets that are not controlled by MHD will be ignored. Calling
+this function instead of <code>MHD_run</code> is more efficient as MHD will
+not have to call <code>select</code> again to determine which operations are
+ready.
+</p>
+<dl compact="compact">
+<dt> <var>daemon</var></dt>
+<dd><p>daemon to process connections of
+</p></dd>
+<dt> <var>read_fd_set</var></dt>
+<dd><p>set of descriptors that must be ready for reading without blocking
+</p></dd>
+<dt> <var>write_fd_set</var></dt>
+<dd><p>set of descriptors that must be ready for writing without blocking
+</p></dd>
+<dt> <var>except_fd_set</var></dt>
+<dd><p>ignored, can be NULL
+</p></dd>
+</dl>
+
+<p>Return <code>MHD_YES</code> on success, <code>MHD_NO</code> on serious
internal
+errors.
+</p>
+</dd></dl>
+
+
+
+<dl>
<dt><a name="index-MHD_005fadd_005fconnection"></a><u>Function:</u> void
<b>MHD_add_connection</b><i> (struct MHD_Daemon *daemon, int client_socket,
const struct sockaddr *addr, socklen_t addrlen)</i></dt>
-<dd><p>Add another client connection to the set of connections
+<dd><p>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.
+server is behind NAT and needs to connect out to the
+HTTP client, or if you are building a proxy.
</p>
+<p>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</code> to
+ensure that the freshly added connection is immediately processed by
+MHD.
+</p>
<p>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.
</p>
<dl compact="compact">
-<dt> <var>daemon</var> </dt>
+<dt> <var>daemon</var></dt>
<dd><p>daemon that manages the connection
</p></dd>
-<dt> <var>client_socket</var> </dt>
+<dt> <var>client_socket</var></dt>
<dd><p>socket to manage (MHD will expect to receive an HTTP request from this
socket next).
</p></dd>
-<dt> <var>addr</var> </dt>
+<dt> <var>addr</var></dt>
<dd><p>IP address of the client
</p></dd>
-<dt> <var>addrlen</var> </dt>
+<dt> <var>addrlen</var></dt>
<dd><p>number of bytes in addr
</p></dd>
</dl>
-<p>This function will return <code>MHD_YES</code> on success,
+<p>This function will return <code>MHD_YES</code> on success,
<code>MHD_NO</code> 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.
</p></dd></dl>
@@ -1351,19 +1864,22 @@
<dt><a name="index-MHD_005fget_005ftimeout"></a><u>Function:</u> int
<b>MHD_get_timeout</b><i> (struct MHD_Daemon *daemon, unsigned long long
*timeout)</i></dt>
<dd><a name="index-timeout-1"></a>
<p>Obtain timeout value for select for this daemon (only needed if
-connection timeout is used). The returned value is how long
-<code>select()</code> should at most block, not the timeout value set for
-connections. This function must not be called if the
-<code>MHD_USE_THREAD_PER_CONNECTION</code> mode is in use (since then it
-is not meaningful to ask for a timeout, after all, there is
-concurrenct activity). The function must also not be called by
-user-code if <code>MHD_USE_INTERNAL_SELECT</code> is in use. In the latter
-case, the behavior is undefined.
+connection timeout is used). The returned value is how many
+milliseconds <code>select</code> should at most block, not the timeout value
+set for connections. This function must not be called if the
+<code>MHD_USE_THREAD_PER_CONNECTION</code> mode is in use (since then it is
+not meaningful to ask for a timeout, after all, there is concurrenct
+activity). The function must also not be called by user-code if
+<code>MHD_USE_INTERNAL_SELECT</code> is in use. In the latter case, the
+behavior is undefined.
</p>
<dl compact="compact">
-<dd><a name="index-timeout-2"></a>
-<p>set to the timeout (in milliseconds).
+<dt> <var>daemon</var></dt>
+<dd><p>which daemon to obtain the timeout from.
</p></dd>
+<dt> <var>timeout</var></dt>
+<dd><p>will be set to the timeout (in milliseconds).
+</p></dd>
</dl>
<p>Return <code>MHD_YES</code> on success, <code>MHD_NO</code> if timeouts are
not used
@@ -1400,21 +1916,35 @@
<dd><p>Get all the headers matching <var>kind</var> from the request.
</p>
<p>The <var>iterator</var> callback is invoked once for each header, with
-<var>iterator_cls</var> as first argument. Return the number of entries
+<var>iterator_cls</var> as first argument. After version 0.9.19, the
+headers are iterated in the same order as they were received from
+the network; previous versions iterated over the headers in reverse
+order.
+</p>
+<p><code>MHD_get_connection_values</code> returns the number of entries
iterated over; this can be less than the number of headers if, while
iterating, <var>iterator</var> returns <code>MHD_NO</code>.
</p>
<p><var>iterator</var> can be <code>NULL</code>: in this case this function
just counts
and returns the number of headers.
+</p>
+<p>In the case of <code>MHD_GET_ARGUMENT_KIND</code>, the <var>value</var>
argument
+will be <code>NULL</code> if the URL contained a key without an equals
operator.
+For example, for a HTTP request to the URL “http://foo/bar?key”,
the
+<var>value</var> argument is <code>NULL</code>; in contrast, a HTTP request to
the URL
+“http://foo/bar?key=”, the <var>value</var> argument is the empty
string.
+The normal case is that the URL contains “http://foo/bar?key=value”
+in which case <var>value</var> would be the string “value” and
<var>key</var>
+would contain the string “key”.
</p></dd></dl>
<dl>
<dt><a name="index-MHD_005fset_005fconnection_005fvalue"></a><u>Function:</u>
int <b>MHD_set_connection_value</b><i> (struct MHD_Connection *connection, enum
MHD_ValueKind kind, const char * key, const char * value)</i></dt>
-<dd><p>This function can be used to add an entry to
-the HTTP headers of a connection (so that the
-MHD_get_connection_values function will return
-them – and the MHD PostProcessor will also
+<dd><p>This function can be used to append an entry to
+the list of HTTP headers of a connection (so that the
+<code>MHD_get_connection_values function</code> will return
+them – and the MHD PostProcessor will also
see them). This maybe required in certain
situations (see Mantis #1399) where (broken)
HTTP implementations fail to supply values needed
@@ -1430,11 +1960,11 @@
(The easiest way to do this is by passing only
arguments to permanently allocated strings.).
</p>
-<p><var>connection</var> is the connection for which
+<p><var>connection</var> is the connection for which
the entry for <var>key</var> of the given <var>kind</var>
should be set to the given <var>value</var>.
</p>
-<p>The function returns <code>MHD_NO</code> if the operation
+<p>The function returns <code>MHD_NO</code> if the operation
could not be performed due to insufficient memory
and <code>MHD_YES</code> on success.
</p></dd></dl>
@@ -1442,12 +1972,16 @@
<dl>
<dt><a
name="index-MHD_005flookup_005fconnection_005fvalue"></a><u>Function:</u> const
char * <b>MHD_lookup_connection_value</b><i> (struct MHD_Connection
*connection, enum MHD_ValueKind kind, const char *key)</i></dt>
-<dd><p>Get a particular header value. If multiple values match the
<var>kind</var>,
-return one of them (the “first”, whatever that means).
<var>key</var> must
-reference a zero-terminated <acronym>ASCII</acronym>-coded string representing
the
-header to look for: it is compared against the headers using
-<code>strcasecmp()</code>, so case is ignored. Return <code>NULL</code> if no
such
-item was found.
+<dd><p>Get a particular header value. If multiple values match the
+<var>kind</var>, return one of them (the “first”, whatever that
means).
+<var>key</var> must reference a zero-terminated ASCII-coded string
+representing the header to look for: it is compared against the
+headers using <code>strcasecmp()</code>, so case is ignored. A value of
+<code>NULL</code> for <var>key</var> can be used to lookup
’trailing’ values without a
+key, for example if a URI is of the form
+“http://example.com/?trailer”, a <var>key</var> of
<code>NULL</code> can be used to
+access “tailer" The function returns <code>NULL</code> if no
matching item
+was found.
</p></dd></dl>
@@ -1460,7 +1994,7 @@
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#microhttpd_002drequests"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
-<td valign="middle" align="left">[<a href="#microhttpd_002ddauth" title="Next
chapter"> >> </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dflow" title="Next
chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
@@ -1474,7 +2008,7 @@
<h1 class="chapter">8. Building responses to requests</h1>
-<p>Response objects handling by <acronym>MHD</acronym> is asynchronous with
respect to the
+<p>Response objects handling by MHD is asynchronous with respect to the
application execution flow. Instances of the <code>MHD_Response</code>
structure are not associated to a daemon and neither to a client
connection: they are managed with reference counting.
@@ -1482,7 +2016,7 @@
<p>In the simplest case: we allocate a new <code>MHD_Response</code> structure
for each response, we use it once and finally we destroy it.
</p>
-<p><acronym>MHD</acronym> allows more efficient resources usages.
+<p>MHD allows more efficient resources usages.
</p>
<p>Example: we allocate a new <code>MHD_Response</code> structure for each
response <strong>kind</strong>, we use it every time we have to give that
@@ -1492,7 +2026,8 @@
<tr><td align="left" valign="top"><a
href="#microhttpd_002dresponse-enqueue">8.1 Enqueuing a
response</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a
href="#microhttpd_002dresponse-create">8.2 Creating a response
object</a></td><td> </td><td align="left" valign="top"></td></tr>
<tr><td align="left" valign="top"><a
href="#microhttpd_002dresponse-headers">8.3 Adding headers to a
response</a></td><td> </td><td align="left" valign="top"></td></tr>
-<tr><td align="left" valign="top"><a
href="#microhttpd_002dresponse-inspect">8.4 Inspecting a response
object</a></td><td> </td><td align="left" valign="top"></td></tr>
+<tr><td align="left" valign="top"><a
href="#microhttpd_002dresponse-options">8.4 Setting response
options</a></td><td> </td><td align="left" valign="top"></td></tr>
+<tr><td align="left" valign="top"><a
href="#microhttpd_002dresponse-inspect">8.5 Inspecting a response
object</a></td><td> </td><td align="left" valign="top"></td></tr>
</table>
@@ -1504,7 +2039,7 @@
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#microhttpd_002dresponses"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#microhttpd_002dresponses"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#microhttpd_002ddauth" title="Next
chapter"> >> </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dflow" title="Next
chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
@@ -1533,7 +2068,7 @@
</p>
</dd>
<dt> <var>status_code</var></dt>
-<dd><p><acronym>HTTP</acronym> status code (i.e. <code>200</code> for OK);
+<dd><p>HTTP status code (i.e. <code>200</code> for OK);
</p>
</dd>
<dt> <var>response</var></dt>
@@ -1550,7 +2085,7 @@
<dl>
<dt><a name="index-MHD_005fdestroy_005fresponse"></a><u>Function:</u> void
<b>MHD_destroy_response</b><i> (struct MHD_Response *response)</i></dt>
<dd><p>Destroy a response object and associated resources (decrement the
-reference counter). Note that <acronym>MHD</acronym> may keep some of the
resources
+reference counter). Note that MHD may keep some of the resources
around if the response is still in the queue for some clients, so the
memory may not necessarily be freed immediately.
</p></dd></dl>
@@ -1597,7 +2132,7 @@
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#microhttpd_002dresponses"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#microhttpd_002dresponses"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#microhttpd_002ddauth" title="Next
chapter"> >> </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dflow" title="Next
chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
@@ -1622,7 +2157,7 @@
</p>
</dd>
<dt> <var>block_size</var></dt>
-<dd><p>preferred block size for querying <var>crc</var> (advisory only,
<acronym>MHD</acronym> may
+<dd><p>preferred block size for querying <var>crc</var> (advisory only, MHD may
still call <var>crc</var> using smaller chunks); this is essentially the
buffer size used for <acronym>IO</acronym>, clients should pick a value that is
appropriate for <acronym>IO</acronym> and memory performance requirements;
@@ -1659,8 +2194,8 @@
</dd>
<dt> <var>fd</var></dt>
<dd><p>file descriptor referring to a file on disk with the data; will be
-closed when response is destroyed; note that ’fd’ must be an
actual
-file descriptor (not a pipe or socket) since MHD might use
’sendfile’
+closed when response is destroyed; note that ’fd’ must be an actual
+file descriptor (not a pipe or socket) since MHD might use
’sendfile’
or ’seek’ on it. The descriptor should be in blocking-IO mode.
</p></dd>
</dl>
@@ -1674,7 +2209,7 @@
<dd><p>Create a response object. The response object can be extended with
header information and then it can be used any number of times.
Note that you need to be a bit careful about <code>off_t</code> when
-writing this code. Depending on your platform, <acronym>MHD</acronym> is
likely
+writing this code. Depending on your platform, MHD is likely
to have been compiled with support for 64-bit files. When you
compile your own application, you must make sure that <code>off_t</code>
is also a 64-bit value. If not, your compiler may pass a 32-bit
@@ -1691,8 +2226,8 @@
#include <fcntl.h>
#include <microhttpd.h>
</pre><p>to ensure 64-bit <code>off_t</code>. Note that if your operating
system
-does not support 64-bit files, <acronym>MHD</acronym> will be compiled with a
32-bit
-<code>off_t</code> (in which case the above would be wrong...).
+does not support 64-bit files, MHD will be compiled with a 32-bit
+<code>off_t</code> (in which case the above would be wrong).
</p>
<dl compact="compact">
<dt> <var>size</var></dt>
@@ -1702,8 +2237,8 @@
</dd>
<dt> <var>fd</var></dt>
<dd><p>file descriptor referring to a file on disk with the data; will be
-closed when response is destroyed; note that ’fd’ must be an
actual
-file descriptor (not a pipe or socket) since MHD might use
’sendfile’
+closed when response is destroyed; note that ’fd’ must be an actual
+file descriptor (not a pipe or socket) since MHD might use
’sendfile’
or ’seek’ on it. The descriptor should be in blocking-IO mode.
</p>
</dd>
@@ -1730,13 +2265,13 @@
<dd><p>the data itself;
</p>
</dd>
-<dt> <var>mode</var> </dt>
-<dd><p>memory management options for buffer; use
+<dt> <var>mode</var></dt>
+<dd><p>memory management options for buffer; use
MHD_RESPMEM_PERSISTENT if the buffer is static/global memory,
use MHD_RESPMEM_MUST_FREE if the buffer is heap-allocated and
-should be freed by <acronym>MHD</acronym> and MHD_RESPMEM_MUST_COPY if the
+should be freed by MHD and MHD_RESPMEM_MUST_COPY if the
buffer is in transient memory (i.e. on the stack) and must
-be copied by <acronym>MHD</acronym>;
+be copied by MHD;
</p></dd>
</dl>
@@ -1760,13 +2295,13 @@
</p>
</dd>
<dt> <var>must_free</var></dt>
-<dd><p>if true: <acronym>MHD</acronym> should free data when done;
+<dd><p>if true: MHD should free data when done;
</p>
</dd>
<dt> <var>must_copy</var></dt>
-<dd><p>if true: <acronym>MHD</acronym> allocates a block of memory and use it
to make a copy of
+<dd><p>if true: MHD allocates a block of memory and use it to make a copy of
<var>data</var> embedded in the returned <code>MHD_Response</code> structure;
-handling of the embedded memory is responsibility of <acronym>MHD</acronym>;
<var>data</var>
+handling of the embedded memory is responsibility of MHD; <var>data</var>
can be released anytime after this call returns.
</p></dd>
</dl>
@@ -1795,11 +2330,11 @@
<a name="microhttpd_002dresponse-headers"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a
href="#microhttpd_002dresponse-create" title="Previous section in reading
order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#microhttpd_002dresponse-inspect"
title="Next section in reading order"> > </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dresponse-options"
title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#microhttpd_002dresponses"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#microhttpd_002dresponses"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#microhttpd_002ddauth" title="Next
chapter"> >> </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dflow" title="Next
chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
@@ -1831,7 +2366,7 @@
<dt><a name="index-MHD_005fadd_005fresponse_005ffooter"></a><u>Function:</u>
int <b>MHD_add_response_footer</b><i> (struct MHD_Response *response, const
char *footer, const char *content)</i></dt>
<dd><p>Add a footer line to the response. The strings referenced by
<var>footer</var> and <var>content</var> must be zero-terminated and they are
-duplicated into memory blocks embedded in <var>response</var>.
+duplicated into memory blocks embedded in <var>response</var>.
</p>
<p>Notice that the strings must not hold newlines, carriage returns or tab
chars. You can add response footers at any time before signalling the
@@ -1853,16 +2388,64 @@
</p></dd></dl>
+<hr size="6">
+<a name="microhttpd_002dresponse-options"></a>
+<table cellpadding="1" cellspacing="1" border="0">
+<tr><td valign="middle" align="left">[<a
href="#microhttpd_002dresponse-headers" title="Previous section in reading
order"> < </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dresponse-inspect"
title="Next section in reading order"> > </a>]</td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dresponses"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dresponses"
title="Up section"> Up </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dflow" title="Next
chapter"> >> </a>]</td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
+<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
+<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
+<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
+</tr></table>
+<a name="Setting-response-options"></a>
+<h2 class="section">8.4 Setting response options</h2>
+
+<dl>
+<dt><a name="index-MHD_005fset_005fresponse_005foptions"></a><u>Function:</u>
int <b>MHD_set_response_options</b><i> (struct MHD_Response *response, enum
MHD_ResponseFlags flags, ...)</i></dt>
+<dd><p>Set special flags and options for a response.
+</p>
+<p>Calling this functions sets the given flags and options for the response.
+</p>
+<dl compact="compact">
+<dt> <var>response</var></dt>
+<dd><p>which response should be modified;
+</p>
+</dd>
+<dt> <var>flags</var></dt>
+<dd><p>flags to set for the response;
+</p>
+</dd>
+</dl>
+
+<p>Additional arguments are a list of options (type-value pairs,
+terminated with <code>MHD_RO_END</code>). It is mandatory to use
+<code>MHD_RO_END</code> as last argument, even when there are no
+additional arguments.
+</p>
+<p>Return <code>MHD_NO</code> on error, <code>MHD_YES</code> on success.
+</p></dd></dl>
+
+
+
<hr size="6">
<a name="microhttpd_002dresponse-inspect"></a>
<table cellpadding="1" cellspacing="1" border="0">
-<tr><td valign="middle" align="left">[<a
href="#microhttpd_002dresponse-headers" title="Previous section in reading
order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#microhttpd_002ddauth" title="Next
section in reading order"> > </a>]</td>
+<tr><td valign="middle" align="left">[<a
href="#microhttpd_002dresponse-options" title="Previous section in reading
order"> < </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dflow" title="Next
section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#microhttpd_002dresponses"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#microhttpd_002dresponses"
title="Up section"> Up </a>]</td>
-<td valign="middle" align="left">[<a href="#microhttpd_002ddauth" title="Next
chapter"> >> </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dflow" title="Next
chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
@@ -1873,7 +2456,7 @@
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
</tr></table>
<a name="Inspecting-a-response-object"></a>
-<h2 class="section">8.4 Inspecting a response object</h2>
+<h2 class="section">8.5 Inspecting a response object</h2>
<dl>
@@ -1903,13 +2486,98 @@
<hr size="6">
-<a name="microhttpd_002ddauth"></a>
+<a name="microhttpd_002dflow"></a>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a
href="#microhttpd_002dresponse-inspect" title="Previous section in reading
order"> < </a>]</td>
-<td valign="middle" align="left">[<a href="#microhttpd_002ddauth-basic"
title="Next section in reading order"> > </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002ddauth" title="Next
section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="#microhttpd_002dresponses"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002ddauth" title="Next
chapter"> >> </a>]</td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left">[<a href="#Top" title="Cover (top) of
document">Top</a>]</td>
+<td valign="middle" align="left">[<a href="#SEC_Contents" title="Table of
contents">Contents</a>]</td>
+<td valign="middle" align="left">[<a href="#Concept-Index"
title="Index">Index</a>]</td>
+<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
+</tr></table>
+<a name="Flow-control_002e"></a>
+<h1 class="chapter">9. Flow control.</h1>
+
+<p>Sometimes it may be possible that clients upload data faster
+than an application can process it, or that an application
+needs an extended period of time to generate a response.
+If <code>MHD_USE_THREAD_PER_CONNECTION</code> is used, applications
+can simply deal with this by performing their logic within the
+thread and thus effectively blocking connection processing
+by MHD. In all other modes, blocking logic must not be
+placed within the callbacks invoked by MHD as this would also
+block processing of other requests, as a single thread may be
+responsible for tens of thousands of connections.
+</p>
+<p>Instead, applications using thread modes other than
+<code>MHD_USE_THREAD_PER_CONNECTION</code> should use the
+following functions to perform flow control.
+</p>
+<dl>
+<dt><a name="index-MHD_005fsuspend_005fconnection"></a><u>Function:</u> int
<b>MHD_suspend_connection</b><i> (struct MHD_Connection *connection)</i></dt>
+<dd><p>Suspend handling of network data for a given connection. This can
+be used to dequeue a connection from MHD’s event loop (external
+select, internal select or thread pool; not applicable to
+thread-per-connection!) for a while.
+</p>
+<p>If you use this API in conjunction with a internal select or a
+thread pool, you must set the option <code>MHD_USE_SUSPEND_RESUME</code> to
+ensure that a resumed connection is immediately processed by MHD.
+</p>
+<p>Suspended connections continue to count against the total number of
+connections allowed (per daemon, as well as per IP, if such limits
+are set). Suspended connections will NOT time out; timeouts will
+restart when the connection handling is resumed. While a
+connection is suspended, MHD will not detect disconnects by the
+client.
+</p>
+<p>The only safe time to suspend a connection is from the
+<code>MHD_AccessHandlerCallback</code>.
+</p>
+<p>Finally, it is an API violation to call <code>MHD_stop_daemon</code> while
+having suspended connections (this will at least create memory and
+socket leaks or lead to undefined behavior). You must explicitly
+resume all connections before stopping the daemon.
+</p>
+<dl compact="compact">
+<dt> <var>connection</var></dt>
+<dd><p>the connection to suspend
+</p></dd>
+</dl>
+</dd></dl>
+
+<dl>
+<dt><a name="index-MHD_005fresume_005fconnection"></a><u>Function:</u> int
<b>MHD_resume_connection</b><i> (struct MHD_Connection *connection)</i></dt>
+<dd><p>Resume handling of network data for suspended connection. It is safe
+to resume a suspended connection at any time. Calling this function
+on a connection that was not previously suspended will result in
+undefined behavior.
+</p>
+<dl compact="compact">
+<dt> <var>connection</var></dt>
+<dd><p>the connection to resume
+</p></dd>
+</dl>
+</dd></dl>
+
+
+
+<hr size="6">
+<a name="microhttpd_002ddauth"></a>
+<table cellpadding="1" cellspacing="1" border="0">
+<tr><td valign="middle" align="left">[<a href="#microhttpd_002dflow"
title="Previous section in reading order"> < </a>]</td>
+<td valign="middle" align="left">[<a href="#microhttpd_002ddauth-basic"
title="Next section in reading order"> > </a>]</td>
+<td valign="middle" align="left"> </td>
+<td valign="middle" align="left">[<a href="#microhttpd_002dflow"
title="Beginning of this chapter or previous chapter"> << </a>]</td>
+<td valign="middle" align="left">[<a href="#Top" title="Up section"> Up
</a>]</td>
<td valign="middle" align="left">[<a href="#microhttpd_002dpost" title="Next
chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
@@ -1921,15 +2589,15 @@
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
</tr></table>
<a name="Utilizing-Authentication"></a>
-<h1 class="chapter">9. Utilizing Authentication</h1>
+<h1 class="chapter">10. Utilizing Authentication</h1>
-<p><acronym>MHD</acronym> support three types of client authentication.
+<p>MHD support three types of client authentication.
</p>
<p>Basic authentication uses a simple authentication method based
on BASE64 algorithm. Username and password are exchanged in clear
between the client and the server, so this method must only be used
for non-sensitive content or when the session is protected with https.
-When using basic authentication <acronym>MHD</acronym> will have access to the
clear
+When using basic authentication MHD will have access to the clear
password, possibly allowing to create a chained authentication
toward an external authentication server.
</p>
@@ -1945,11 +2613,11 @@
be used simultaneously with Basic or Digest Authentication in order
to provide a two levels authentication (like for instance separate
machine and user authentication). A code example for using
-client certificates is presented in the <acronym>MHD</acronym> tutorial.
+client certificates is presented in the MHD tutorial.
</p>
<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#microhttpd_002ddauth-basic">9.1
Using Basic Authentication</a></td><td> </td><td align="left"
valign="top"></td></tr>
-<tr><td align="left" valign="top"><a href="#microhttpd_002ddauth-digest">9.2
Using Digest Authentication</a></td><td> </td><td align="left"
valign="top"></td></tr>
+<tr><td align="left" valign="top"><a href="#microhttpd_002ddauth-basic">10.1
Using Basic Authentication</a></td><td> </td><td align="left"
valign="top"></td></tr>
+<tr><td align="left" valign="top"><a href="#microhttpd_002ddauth-digest">10.2
Using Digest Authentication</a></td><td> </td><td align="left"
valign="top"></td></tr>
</table>
@@ -1972,7 +2640,7 @@
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
</tr></table>
<a name="Using-Basic-Authentication"></a>
-<h2 class="section">9.1 Using Basic Authentication</h2>
+<h2 class="section">10.1 Using Basic Authentication</h2>
<dl>
<dt><a
name="index-MHD_005fbasic_005fauth_005fget_005fusername_005fpassword"></a><u>Function:</u>
char * <b>MHD_basic_auth_get_username_password</b><i> (struct MHD_Connection
*connection, char** password)</i></dt>
@@ -2015,7 +2683,7 @@
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
</tr></table>
<a name="Using-Digest-Authentication"></a>
-<h2 class="section">9.2 Using Digest Authentication</h2>
+<h2 class="section">10.2 Using Digest Authentication</h2>
<dl>
<dt><a
name="index-MHD_005fdigest_005fauth_005fget_005fusername"></a><u>Function:</u>
char * <b>MHD_digest_auth_get_username</b><i> (struct MHD_Connection
*connection)</i></dt>
@@ -2082,41 +2750,41 @@
int ret;
username = MHD_digest_auth_get_username(connection);
- if (username == NULL)
+ if (username == NULL)
{
- response = MHD_create_response_from_buffer(strlen (DENIED),
+ response = MHD_create_response_from_buffer(strlen (DENIED),
DENIED,
- MHD_RESPMEM_PERSISTENT);
+ MHD_RESPMEM_PERSISTENT);
ret = MHD_queue_auth_fail_response(connection, realm,
OPAQUE,
response,
- MHD_NO);
- MHD_destroy_response(response);
+ MHD_NO);
+ MHD_destroy_response(response);
return ret;
}
ret = MHD_digest_auth_check(connection, realm,
- username,
- password,
+ username,
+ password,
300);
free(username);
if ( (ret == MHD_INVALID_NONCE) ||
(ret == MHD_NO) )
{
- response = MHD_create_response_from_buffer(strlen (DENIED),
+ response = MHD_create_response_from_buffer(strlen (DENIED),
DENIED,
- MHD_RESPMEM_PERSISTENT);
- if (NULL == response)
+ MHD_RESPMEM_PERSISTENT);
+ if (NULL == response)
return MHD_NO;
ret = MHD_queue_auth_fail_response(connection, realm,
OPAQUE,
response,
- (ret == MHD_INVALID_NONCE) ? MHD_YES :
MHD_NO);
- MHD_destroy_response(response);
+ (ret == MHD_INVALID_NONCE) ? MHD_YES :
MHD_NO);
+ MHD_destroy_response(response);
return ret;
}
response = MHD_create_response_from_buffer (strlen(PAGE), PAGE,
MHD_RESPMEM_PERSISTENT);
- ret = MHD_queue_response(connection, MHD_HTTP_OK, response);
+ ret = MHD_queue_response(connection, MHD_HTTP_OK, response);
MHD_destroy_response(response);
return ret;
}
@@ -2142,15 +2810,15 @@
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
</tr></table>
<a name="Adding-a-POST-processor"></a>
-<h1 class="chapter">10. Adding a <code>POST</code> processor</h1>
+<h1 class="chapter">11. Adding a <code>POST</code> processor</h1>
<a name="index-POST-method-3"></a>
<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#microhttpd_002dpost-api">10.1
Programming interface for the <code>POST</code>
processor</a></td><td> </td><td align="left" valign="top"></td></tr>
+<tr><td align="left" valign="top"><a href="#microhttpd_002dpost-api">11.1
Programming interface for the <code>POST</code>
processor</a></td><td> </td><td align="left" valign="top"></td></tr>
</table>
-<p><acronym>MHD</acronym> provides the post processor API to make it easier
for applications to
+<p>MHD provides the post processor API to make it easier for applications to
parse the data of a client’s <code>POST</code> request: the
<code>MHD_AccessHandlerCallback</code> will be invoked multiple times to
process data as it arrives; at each invocation a new chunk of data must
@@ -2162,7 +2830,7 @@
data comes in the upload buffer it is <strong>mandatory</strong> to use the
<var>con_cls</var> to store a reference to per-connection data. The fact
that the pointer was initially <code>NULL</code> can be used to detect that
-this is a new request.
+this is a new request.
</p>
<p>One method to detect that a new connection was established is
to set <code>*con_cls</code> to an unused integer:
@@ -2176,9 +2844,9 @@
void **con_cls)
{
static int old_connection_marker;
- int new_connection = (MYNULL == *con_cls);
+ int new_connection = (NULL == *con_cls);
- if (new_connection)
+ if (new_connection)
{
/* new connection with POST */
*con_cls = &old_connection_marker;
@@ -2203,13 +2871,13 @@
{
struct MHD_PostProcessor * pp = *con_cls;
- if (pp == NULL)
+ if (pp == NULL)
{
pp = MHD_create_post_processor(connection, ...);
*con_cls = pp;
return MHD_YES;
}
- if (*upload_data_size)
+ if (*upload_data_size)
{
MHD_post_process(pp, upload_data, *upload_data_size);
*upload_data_size = 0;
@@ -2249,7 +2917,7 @@
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
</tr></table>
<a name="Programming-interface-for-the-POST-processor"></a>
-<h2 class="section">10.1 Programming interface for the <code>POST</code>
processor</h2>
+<h2 class="section">11.1 Programming interface for the <code>POST</code>
processor</h2>
<a name="index-POST-method-4"></a>
<dl>
@@ -2267,6 +2935,7 @@
<dd><p>maximum number of bytes to use for internal buffering (used only for the
parsing, specifically the parsing of the keys). A tiny value (256-1024)
should be sufficient; do <strong>NOT</strong> use a value smaller than 256;
+for good performance, use 32k or 64k (i.e. 65536).
</p>
</dd>
<dt> <var>iterator</var></dt>
@@ -2319,7 +2988,7 @@
stream. After destroying the PostProcessor, the programmer should
perform any necessary work to complete the processing of the iterator.
</p>
-<p>Return <code>MHD_YES</code> if processing completed nicely,
<code>MHD_NO</code>
+<p>Return <code>MHD_YES</code> if processing completed nicely,
<code>MHD_NO</code>
if there were spurious characters or formatting problems with
the post request. It is common to ignore the return value
of this function.
@@ -2349,15 +3018,15 @@
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
</tr></table>
<a name="Obtaining-and-modifying-status-information_002e"></a>
-<h1 class="chapter">11. Obtaining and modifying status information.</h1>
+<h1 class="chapter">12. Obtaining and modifying status information.</h1>
<table class="menu" border="0" cellspacing="0">
-<tr><td align="left" valign="top"><a href="#microhttpd_002dinfo-daemon">11.1
Obtaining state information about an MHD
daemon</a></td><td> </td><td align="left" valign="top"> State
information about an MHD daemon
+<tr><td align="left" valign="top"><a href="#microhttpd_002dinfo-daemon">12.1
Obtaining state information about an MHD
daemon</a></td><td> </td><td align="left" valign="top"> State
information about an MHD daemon
</td></tr>
-<tr><td align="left" valign="top"><a href="#microhttpd_002dinfo-conn">11.2
Obtaining state information about a connection</a></td><td> </td><td
align="left" valign="top"> State information about a connection
+<tr><td align="left" valign="top"><a href="#microhttpd_002dinfo-conn">12.2
Obtaining state information about a connection</a></td><td> </td><td
align="left" valign="top"> State information about a connection
</td></tr>
-<tr><td align="left" valign="top"><a href="#microhttpd_002doption-conn">11.3
Setting custom options for an individual
connection</a></td><td> </td><td align="left" valign="top">
Modify per-connection options
+<tr><td align="left" valign="top"><a href="#microhttpd_002doption-conn">12.3
Setting custom options for an individual
connection</a></td><td> </td><td align="left" valign="top">
Modify per-connection options
</td></tr>
</table>
@@ -2381,7 +3050,7 @@
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
</tr></table>
<a name="Obtaining-state-information-about-an-MHD-daemon"></a>
-<h2 class="section">11.1 Obtaining state information about an MHD daemon</h2>
+<h2 class="section">12.1 Obtaining state information about an MHD daemon</h2>
<dl>
<dt><a name="index-MHD_005fget_005fdaemon_005finfo"></a><u>Function:</u> const
union MHD_DaemonInfo * <b>MHD_get_daemon_info</b><i> (struct MHD_Daemon
*daemon, enum MHD_DaemonInfoType infoType, ...)</i></dt>
@@ -2404,7 +3073,7 @@
</dl>
<p>Returns a union with the respective member (depending on
-infoType) set to the desired information), or NULL
+infoType) set to the desired information), or <code>NULL</code>
in case the desired information is not available or
applicable.
</p></dd></dl>
@@ -2418,17 +3087,19 @@
<dt> <code>MHD_DAEMON_INFO_KEY_SIZE</code></dt>
<dd><p>Request information about the key size for a particular cipher
algorithm. The cipher algorithm should be passed as an extra argument
-(of type ’enum MHD_GNUTLS_CipherAlgorithm’).
+(of type ’enum MHD_GNUTLS_CipherAlgorithm’). No longer supported,
+using this value will cause MHD_get_daemon_info to return NULL.
</p>
</dd>
<dt> <code>MHD_DAEMON_INFO_MAC_KEY_SIZE</code></dt>
<dd><p>Request information about the key size for a particular cipher
algorithm. The cipher algorithm should be passed as an extra argument
-(of type ’enum MHD_GNUTLS_HashAlgorithm’).
+(of type ’enum MHD_GNUTLS_HashAlgorithm’). No longer supported,
+using this value will cause MHD_get_daemon_info to return NULL.
</p>
</dd>
<dt> <code>MHD_DAEMON_INFO_LISTEN_FD</code></dt>
-<dd><a name="index-listen"></a>
+<dd><a name="index-listen-3"></a>
<p>Request the file-descriptor number that MHD is using to listen to the
server socket. This can be useful if no port
was specified and a client needs to learn what port
@@ -2436,6 +3107,18 @@
No extra arguments should be passed.
</p>
</dd>
+<dt> <code>MHD_DAEMON_INFO_EPOLL_FD_LINUX_ONLY</code></dt>
+<dd><a name="index-epoll-2"></a>
+<p>Request the file-descriptor number that MHD is using for epoll. If
+the build is not supporting epoll, NULL is returned; if we are using a
+thread pool or this daemon was not started with
+MHD_USE_EPOLL_LINUX_ONLY, (a pointer to) -1 is returned. If we are
+using MHD_USE_SELECT_INTERNALLY or are in ’external’ select mode,
the
+internal epoll FD is returned. This function must be used in external
+select mode with epoll to obtain the FD to call epoll on. No extra
+arguments should be passed.
+</p>
+</dd>
</dl>
</dd></dl>
@@ -2460,7 +3143,7 @@
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
</tr></table>
<a name="Obtaining-state-information-about-a-connection"></a>
-<h2 class="section">11.2 Obtaining state information about a connection</h2>
+<h2 class="section">12.2 Obtaining state information about a connection</h2>
<dl>
@@ -2483,7 +3166,7 @@
</dl>
<p>Returns a union with the respective member (depending on
-infoType) set to the desired information), or NULL
+infoType) set to the desired information), or <code>NULL</code>
in case the desired information is not available or
applicable.
</p></dd></dl>
@@ -2495,19 +3178,19 @@
</p>
<dl compact="compact">
<dt> <code>MHD_CONNECTION_INFO_CIPHER_ALGO</code></dt>
-<dd><p>What cipher algorithm is being used (HTTPS connections only).
+<dd><p>What cipher algorithm is being used (HTTPS connections only).
Takes no extra arguments.
-NULL is returned for non-HTTPS connections.
+<code>NULL</code> is returned for non-HTTPS connections.
</p>
</dd>
<dt> <code>MHD_CONNECTION_INFO_PROTOCOL,</code></dt>
<dd><p>Takes no extra arguments. Allows finding out the TLS/SSL protocol used
(HTTPS connections only).
-NULL is returned for non-HTTPS connections.
+<code>NULL</code> is returned for non-HTTPS connections.
</p>
</dd>
<dt> <code>MHD_CONNECTION_INFO_CLIENT_ADDRESS</code></dt>
-<dd><p>Returns information about the address of the client. Returns
+<dd><p>Returns information about the address of the client. Returns
essentially a <code>struct sockaddr **</code> (since the API returns
a <code>union MHD_ConnectionInfo *</code> and that union contains
a <code>struct sockaddr *</code>).
@@ -2516,8 +3199,8 @@
<dt> <code>MHD_CONNECTION_INFO_GNUTLS_SESSION,</code></dt>
<dd><p>Takes no extra arguments. Allows access to the underlying GNUtls
session,
including access to the underlying GNUtls client certificate
-(HTTPS connections only). Takes no extra arguments.
-NULL is returned for non-HTTPS connections.
+(HTTPS connections only). Takes no extra arguments.
+<code>NULL</code> is returned for non-HTTPS connections.
</p>
</dd>
<dt> <code>MHD_CONNECTION_INFO_GNUTLS_CLIENT_CERT,</code></dt>
@@ -2531,6 +3214,19 @@
this connection.
</p>
</dd>
+<dt> <code>MHD_CONNECTION_INFO_CONNECTION_FD</code></dt>
+<dd><p>Returns the file descriptor (usually a TCP socket) associated with
+this connection (in the “connect-fd” member of the returned
struct).
+Note that manipulating the descriptor directly can have problematic
+consequences (as in, break HTTP). Applications might use this access
+to manipulate TCP options, for example to set the “TCP-NODELAY”
+option for COMET-like applications. Note that MHD will set TCP-CORK
+after sending the HTTP header and clear it after finishing the footers
+automatically (if the platform supports it). As the connection
+callbacks are invoked in between, those might be used to set different
+values for TCP-CORK and TCP-NODELAY in the meantime.
+</p>
+</dd>
</dl>
</dd></dl>
@@ -2555,8 +3251,8 @@
<td valign="middle" align="left">[<a href="#SEC_About" title="About (help)"> ?
</a>]</td>
</tr></table>
<a name="Setting-custom-options-for-an-individual-connection"></a>
-<h2 class="section">11.3 Setting custom options for an individual
connection</h2>
-<a name="index-timeout-3"></a>
+<h2 class="section">12.3 Setting custom options for an individual
connection</h2>
+<a name="index-timeout-2"></a>
@@ -2592,7 +3288,7 @@
<dt> <code>MHD_CONNECTION_OPTION_TIMEOUT</code></dt>
<dd><p>Set a custom timeout for the given connection. Specified
as the number of seconds, given as an <code>unsigned int</code>. Use
-zero for no timeout.
+zero for no timeout.
</p>
</dd>
</dl>
@@ -2637,7 +3333,7 @@
version number 2.1.]
</pre></td></tr></table>
-<a name="Preamble-1"></a>
+<a name="Preamble"></a>
<h3 class="subheading">Preamble</h3>
<p> The licenses for most software are designed to take away your
@@ -3093,7 +3789,8 @@
of all derivatives of our free software and of promoting the sharing
and reuse of software generally.
-
+<p align="center"> <b>NO WARRANTY</b>
+</p>
</li><li>
BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
@@ -3118,6 +3815,8 @@
DAMAGES.
</li></ol>
+<a name="END-OF-TERMS-AND-CONDITIONS-1"></a>
+<h3 class="subheading">END OF TERMS AND CONDITIONS</h3>
<a name="How-to-Apply-These-Terms-to-Your-New-Libraries"></a>
@@ -3203,7 +3902,7 @@
-<a name="Preamble"></a>
+<a name="Preamble-1"></a>
<h3 class="subheading">Preamble</h3>
<p> The licenses for most software are designed to take away your
@@ -3473,7 +4172,8 @@
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
-
+<p align="center"> <b>NO WARRANTY</b>
+</p>
</li><li>
BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
@@ -3496,8 +4196,9 @@
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
+<p align="center"> <b>ECOS EXTENSION</b>
+</p>
-
</li><li>
As a special exception, if other files instantiate templates or use
macros or inline functions from this file, or you compile this file
@@ -3513,6 +4214,8 @@
</li></ol>
+<a name="END-OF-TERMS-AND-CONDITIONS"></a>
+<h3 class="subheading">END OF TERMS AND CONDITIONS</h3>
<hr size="6">
@@ -4173,94 +4876,132 @@
<tr><td></td><th align="left">Index Entry</th><th align="left">
Section</th></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Concept-Index-1_cp_letter-A">A</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-ARM">ARM</a></td><td
valign="top"><a href="#MHD_005fLONG_005fLONG">1.4 MHD_LONG_LONG</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-ARM">ARM</a></td><td
valign="top"><a href="#MHD_005fUNSIGNED_005fLONG_005fLONG">1.6
MHD_UNSIGNED_LONG_LONG</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Concept-Index-1_cp_letter-B">B</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a
href="#index-bind_002c-restricting-bind">bind, restricting bind</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Concept-Index-1_cp_letter-C">C</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-cipher">cipher</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-clock">clock</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-compilation">compilation</a></td><td valign="top"><a
href="#Compiling-GNU-libmicrohttpd">1.3 Compiling GNU
libmicrohttpd</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-connection_002c-limiting-number-of-connections">connection,
limiting number of connections</a></td><td valign="top"><a
href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-cookie">cookie</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-cortex-m3">cortex m3</a></td><td
valign="top"><a href="#MHD_005fLONG_005fLONG">1.4 MHD_LONG_LONG</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-cortex-m3">cortex m3</a></td><td
valign="top"><a href="#MHD_005fUNSIGNED_005fLONG_005fLONG">1.6
MHD_UNSIGNED_LONG_LONG</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Concept-Index-1_cp_letter-D">D</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a href="#index-date">date</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-debugging">debugging</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-debugging-1">debugging</a></td><td valign="top"><a
href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-DH">DH</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-digest-auth">digest
auth</a></td><td valign="top"><a href="#microhttpd_002dconst">2.
Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-digest-auth-1">digest
auth</a></td><td valign="top"><a href="#microhttpd_002dconst">2.
Constants</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Concept-Index-1_cp_letter-E">E</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a
href="#index-eCos_002c-GNU-General-Public-License-with-eCos-Extension">eCos,
GNU General Public License with eCos Extension</a></td><td valign="top"><a
href="#GNU-GPL-with-eCos-Extension">GNU GPL with eCos Extension</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-embedded-systems">embedded
systems</a></td><td valign="top"><a href="#Compiling-GNU-libmicrohttpd">1.3
Compiling GNU libmicrohttpd</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-embedded-systems-1">embedded
systems</a></td><td valign="top"><a
href="#MHD_005fUNSIGNED_005fLONG_005fLONG">1.6
MHD_UNSIGNED_LONG_LONG</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-embedded-systems-2">embedded
systems</a></td><td valign="top"><a href="#microhttpd_002dconst">2.
Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-embedded-systems-3">embedded
systems</a></td><td valign="top"><a href="#microhttpd_002dconst">2.
Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-embedded-systems-4">embedded
systems</a></td><td valign="top"><a href="#microhttpd_002dconst">2.
Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-epoll">epoll</a></td><td
valign="top"><a href="#Thread-modes-and-event-loops">1.2 Thread modes and event
loops</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-epoll-1">epoll</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-epoll-2">epoll</a></td><td
valign="top"><a href="#microhttpd_002dinfo-daemon">12.1 Obtaining state
information about an MHD daemon</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-escaping">escaping</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Concept-Index-1_cp_letter-F">F</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a
href="#index-FD_005fSETSIZE">FD_SETSIZE</a></td><td valign="top"><a
href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-FD_005fSETSIZE-1">FD_SETSIZE</a></td><td valign="top"><a
href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-foreign_002dfunction-interface">foreign-function
interface</a></td><td valign="top"><a href="#microhttpd_002dconst">2.
Constants</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Concept-Index-1_cp_letter-G">G</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a
href="#index-GPL_002c-GNU-General-Public-License">GPL, GNU General Public
License</a></td><td valign="top"><a href="#GNU-GPL-with-eCos-Extension">GNU GPL
with eCos Extension</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Concept-Index-1_cp_letter-I">I</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-IAR">IAR</a></td><td
valign="top"><a href="#MHD_005fLONG_005fLONG">1.4 MHD_LONG_LONG</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-IAR">IAR</a></td><td
valign="top"><a href="#MHD_005fUNSIGNED_005fLONG_005fLONG">1.6
MHD_UNSIGNED_LONG_LONG</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-internationalization">internationalization</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-IPv6">IPv6</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-IPv6-1">IPv6</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Concept-Index-1_cp_letter-L">L</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-license">license</a></td><td
valign="top"><a href="#GNU_002dLGPL">GNU-LGPL</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-license-1">license</a></td><td
valign="top"><a href="#GNU-GPL-with-eCos-Extension">GNU GPL with eCos
Extension</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-license-2">license</a></td><td
valign="top"><a href="#GNU_002dFDL">GNU-FDL</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-listen">listen</a></td><td
valign="top"><a href="#microhttpd_002dinfo-daemon">11.1 Obtaining state
information about an MHD daemon</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-listen">listen</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-listen-1">listen</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-listen-2">listen</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-listen-3">listen</a></td><td
valign="top"><a href="#microhttpd_002dinfo-daemon">12.1 Obtaining state
information about an MHD daemon</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-logging">logging</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-logging-1">logging</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-long-long">long long</a></td><td
valign="top"><a href="#MHD_005fLONG_005fLONG">1.4 MHD_LONG_LONG</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-long-long">long long</a></td><td
valign="top"><a href="#MHD_005fUNSIGNED_005fLONG_005fLONG">1.6
MHD_UNSIGNED_LONG_LONG</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Concept-Index-1_cp_letter-M">M</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a href="#index-memory">memory</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-memory_002c-limiting-memory-utilization">memory, limiting memory
utilization</a></td><td valign="top"><a href="#microhttpd_002dconst">2.
Constants</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-microhttpd_002eh">microhttpd.h</a></td><td valign="top"><a
href="#Including-the-microhttpd_002eh-header">1.2 Including the microhttpd.h
header</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fLONG_005fLONG">MHD_LONG_LONG</a></td><td valign="top"><a
href="#MHD_005fUNSIGNED_005fLONG_005fLONG">1.6
MHD_UNSIGNED_LONG_LONG</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-microhttpd_002eh">microhttpd.h</a></td><td valign="top"><a
href="#Including-the-microhttpd_002eh-header">1.4 Including the microhttpd.h
header</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Concept-Index-1_cp_letter-O">O</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-options">options</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Concept-Index-1_cp_letter-P">P</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-performance">performance</a></td><td valign="top"><a
href="#microhttpd_002dconst">2. Constants</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-poll">poll</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-portability">portability</a></td><td valign="top"><a
href="#Including-the-microhttpd_002eh-header">1.2 Including the microhttpd.h
header</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-performance">performance</a></td><td valign="top"><a
href="#Thread-modes-and-event-loops">1.2 Thread modes and event
loops</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-performance-1">performance</a></td><td valign="top"><a
href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-poll">poll</a></td><td
valign="top"><a href="#Thread-modes-and-event-loops">1.2 Thread modes and event
loops</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-poll-1">poll</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-poll-2">poll</a></td><td
valign="top"><a href="#microhttpd_002dinit">5. Starting and stopping the
server</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-portability">portability</a></td><td valign="top"><a
href="#Compiling-GNU-libmicrohttpd">1.3 Compiling GNU
libmicrohttpd</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-portability-1">portability</a></td><td valign="top"><a
href="#Including-the-microhttpd_002eh-header">1.4 Including the microhttpd.h
header</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-POST-method">POST
method</a></td><td valign="top"><a href="#microhttpd_002dconst">2.
Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-POST-method-1">POST
method</a></td><td valign="top"><a href="#microhttpd_002dstruct">3. Structures
type definition</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-POST-method-2">POST
method</a></td><td valign="top"><a href="#microhttpd_002dcb">4. Callback
functions definition</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-POST-method-3">POST
method</a></td><td valign="top"><a href="#microhttpd_002dpost">10. Adding a
<code>POST</code> processor</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-POST-method-4">POST
method</a></td><td valign="top"><a href="#microhttpd_002dpost-api">10.1
Programming interface for the <code>POST</code> processor</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-POST-method-3">POST
method</a></td><td valign="top"><a href="#microhttpd_002dpost">11. Adding a
<code>POST</code> processor</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-POST-method-4">POST
method</a></td><td valign="top"><a href="#microhttpd_002dpost-api">11.1
Programming interface for the <code>POST</code> processor</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-proxy">proxy</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-pthread">pthread</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-PUT-method">PUT
method</a></td><td valign="top"><a href="#microhttpd_002dcb">4. Callback
functions definition</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Concept-Index-1_cp_letter-Q">Q</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-query-string">query
string</a></td><td valign="top"><a href="#microhttpd_002dconst">2.
Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-quiesce">quiesce</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-quiesce-1">quiesce</a></td><td
valign="top"><a href="#microhttpd_002dinit">5. Starting and stopping the
server</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Concept-Index-1_cp_letter-R">R</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-random">random</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-replay-attack">replay
attack</a></td><td valign="top"><a href="#microhttpd_002dconst">2.
Constants</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Concept-Index-1_cp_letter-S">S</a></th><td></td><td></td></tr>
-<tr><td></td><td valign="top"><a href="#index-select">select</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-signals">signals</a></td><td
valign="top"><a href="#SIGPIPE">1.3 SIGPIPE</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-select">select</a></td><td
valign="top"><a href="#Thread-modes-and-event-loops">1.2 Thread modes and event
loops</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-select-1">select</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-select-2">select</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-select-3">select</a></td><td
valign="top"><a href="#microhttpd_002dinit">5. Starting and stopping the
server</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-select-4">select</a></td><td
valign="top"><a href="#microhttpd_002dinit">5. Starting and stopping the
server</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-signals">signals</a></td><td
valign="top"><a href="#SIGPIPE">1.5 SIGPIPE</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-SNI">SNI</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SSL">SSL</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SSL-1">SSL</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SSL-2">SSL</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SSL-3">SSL</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SSL-4">SSL</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-stack_002c-thread_002c-pthread">stack, thread, pthread</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-SSL-5">SSL</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-SSL-6">SSL</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-SSL-7">SSL</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-stack">stack</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-systemd">systemd</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
<tr><th><a name="Concept-Index-1_cp_letter-T">T</a></th><td></td><td></td></tr>
+<tr><td></td><td valign="top"><a href="#index-thread">thread</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-timeout">timeout</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-timeout-1">timeout</a></td><td
valign="top"><a href="#microhttpd_002dinspect">6. Implementing external
<code>select</code></a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-timeout-2">timeout</a></td><td
valign="top"><a href="#microhttpd_002dinspect">6. Implementing external
<code>select</code></a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-timeout-3">timeout</a></td><td
valign="top"><a href="#microhttpd_002doption-conn">11.3 Setting custom options
for an individual connection</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-timeout-2">timeout</a></td><td
valign="top"><a href="#microhttpd_002doption-conn">12.3 Setting custom options
for an individual connection</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-TLS">TLS</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-TLS-1">TLS</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-TLS-2">TLS</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-TLS-3">TLS</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-TLS-4">TLS</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-TLS-5">TLS</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-TLS-6">TLS</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-TLS-7">TLS</a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
</table>
<table><tr><th valign="top">Jump to: </th><td><a
href="#Concept-Index-1_cp_letter-A" class="summary-letter"><b>A</b></a>
@@ -4340,36 +5081,41 @@
<tr><td></td><td valign="top"><a
href="#index-MHD_005fadd_005fconnection"><code>MHD_add_connection</code></a></td><td
valign="top"><a href="#microhttpd_002dinit">5. Starting and stopping the
server</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fadd_005fresponse_005ffooter"><code>MHD_add_response_footer</code></a></td><td
valign="top"><a href="#microhttpd_002dresponse-headers">8.3 Adding headers to
a response</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fadd_005fresponse_005fheader"><code>MHD_add_response_header</code></a></td><td
valign="top"><a href="#microhttpd_002dresponse-headers">8.3 Adding headers to
a response</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-MHD_005fbasic_005fauth_005fget_005fusername_005fpassword"><code>MHD_basic_auth_get_username_password</code></a></td><td
valign="top"><a href="#microhttpd_002ddauth-basic">9.1 Using Basic
Authentication</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-MHD_005fcreate_005fpost_005fprocessor"><code>MHD_create_post_processor</code></a></td><td
valign="top"><a href="#microhttpd_002dpost-api">10.1 Programming interface for
the <code>POST</code> processor</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fbasic_005fauth_005fget_005fusername_005fpassword"><code>MHD_basic_auth_get_username_password</code></a></td><td
valign="top"><a href="#microhttpd_002ddauth-basic">10.1 Using Basic
Authentication</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fcreate_005fpost_005fprocessor"><code>MHD_create_post_processor</code></a></td><td
valign="top"><a href="#microhttpd_002dpost-api">11.1 Programming interface for
the <code>POST</code> processor</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fcreate_005fresponse_005ffrom_005fbuffer"><code>MHD_create_response_from_buffer</code></a></td><td
valign="top"><a href="#microhttpd_002dresponse-create">8.2 Creating a response
object</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fcreate_005fresponse_005ffrom_005fcallback"><code>MHD_create_response_from_callback</code></a></td><td
valign="top"><a href="#microhttpd_002dresponse-create">8.2 Creating a response
object</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fcreate_005fresponse_005ffrom_005fdata"><code>MHD_create_response_from_data</code></a></td><td
valign="top"><a href="#microhttpd_002dresponse-create">8.2 Creating a response
object</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fcreate_005fresponse_005ffrom_005ffd"><code>MHD_create_response_from_fd</code></a></td><td
valign="top"><a href="#microhttpd_002dresponse-create">8.2 Creating a response
object</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fcreate_005fresponse_005ffrom_005ffd_005fat_005foffset"><code>MHD_create_response_from_fd_at_offset</code></a></td><td
valign="top"><a href="#microhttpd_002dresponse-create">8.2 Creating a response
object</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fdel_005fresponse_005fheader"><code>MHD_del_response_header</code></a></td><td
valign="top"><a href="#microhttpd_002dresponse-headers">8.3 Adding headers to
a response</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-MHD_005fdestroy_005fpost_005fprocessor"><code>MHD_destroy_post_processor</code></a></td><td
valign="top"><a href="#microhttpd_002dpost-api">10.1 Programming interface for
the <code>POST</code> processor</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fdestroy_005fpost_005fprocessor"><code>MHD_destroy_post_processor</code></a></td><td
valign="top"><a href="#microhttpd_002dpost-api">11.1 Programming interface for
the <code>POST</code> processor</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fdestroy_005fresponse"><code>MHD_destroy_response</code></a></td><td
valign="top"><a href="#microhttpd_002dresponse-enqueue">8.1 Enqueuing a
response</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-MHD_005fdigest_005fauth_005fcheck"><code>MHD_digest_auth_check</code></a></td><td
valign="top"><a href="#microhttpd_002ddauth-digest">9.2 Using Digest
Authentication</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-MHD_005fdigest_005fauth_005fget_005fusername"><code>MHD_digest_auth_get_username</code></a></td><td
valign="top"><a href="#microhttpd_002ddauth-digest">9.2 Using Digest
Authentication</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-MHD_005fget_005fconnection_005finfo"><code>MHD_get_connection_info</code></a></td><td
valign="top"><a href="#microhttpd_002dinfo-conn">11.2 Obtaining state
information about a connection</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fdigest_005fauth_005fcheck"><code>MHD_digest_auth_check</code></a></td><td
valign="top"><a href="#microhttpd_002ddauth-digest">10.2 Using Digest
Authentication</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fdigest_005fauth_005fget_005fusername"><code>MHD_digest_auth_get_username</code></a></td><td
valign="top"><a href="#microhttpd_002ddauth-digest">10.2 Using Digest
Authentication</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fget_005fconnection_005finfo"><code>MHD_get_connection_info</code></a></td><td
valign="top"><a href="#microhttpd_002dinfo-conn">12.2 Obtaining state
information about a connection</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fget_005fconnection_005fvalues"><code>MHD_get_connection_values</code></a></td><td
valign="top"><a href="#microhttpd_002drequests">7. Handling
requests</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-MHD_005fget_005fdaemon_005finfo"><code>MHD_get_daemon_info</code></a></td><td
valign="top"><a href="#microhttpd_002dinfo-daemon">11.1 Obtaining state
information about an MHD daemon</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fget_005fdaemon_005finfo"><code>MHD_get_daemon_info</code></a></td><td
valign="top"><a href="#microhttpd_002dinfo-daemon">12.1 Obtaining state
information about an MHD daemon</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fget_005ffdset"><code>MHD_get_fdset</code></a></td><td
valign="top"><a href="#microhttpd_002dinspect">6. Implementing external
<code>select</code></a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-MHD_005fget_005fresponse_005fheader"><code>MHD_get_response_header</code></a></td><td
valign="top"><a href="#microhttpd_002dresponse-inspect">8.4 Inspecting a
response object</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-MHD_005fget_005fresponse_005fheaders"><code>MHD_get_response_headers</code></a></td><td
valign="top"><a href="#microhttpd_002dresponse-inspect">8.4 Inspecting a
response object</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fget_005fresponse_005fheader"><code>MHD_get_response_header</code></a></td><td
valign="top"><a href="#microhttpd_002dresponse-inspect">8.5 Inspecting a
response object</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fget_005fresponse_005fheaders"><code>MHD_get_response_headers</code></a></td><td
valign="top"><a href="#microhttpd_002dresponse-inspect">8.5 Inspecting a
response object</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fget_005ftimeout"><code>MHD_get_timeout</code></a></td><td
valign="top"><a href="#microhttpd_002dinspect">6. Implementing external
<code>select</code></a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005flookup_005fconnection_005fvalue"><code>MHD_lookup_connection_value</code></a></td><td
valign="top"><a href="#microhttpd_002drequests">7. Handling
requests</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-MHD_005fpost_005fprocess"><code>MHD_post_process</code></a></td><td
valign="top"><a href="#microhttpd_002dpost-api">10.1 Programming interface for
the <code>POST</code> processor</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-MHD_005fqueue_005fauth_005ffail_005fresponse"><code>MHD_queue_auth_fail_response</code></a></td><td
valign="top"><a href="#microhttpd_002ddauth-digest">9.2 Using Digest
Authentication</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-MHD_005fqueue_005fbasic_005fauth_005ffail_005fresponse"><code>MHD_queue_basic_auth_fail_response</code></a></td><td
valign="top"><a href="#microhttpd_002ddauth-basic">9.1 Using Basic
Authentication</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fpost_005fprocess"><code>MHD_post_process</code></a></td><td
valign="top"><a href="#microhttpd_002dpost-api">11.1 Programming interface for
the <code>POST</code> processor</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fqueue_005fauth_005ffail_005fresponse"><code>MHD_queue_auth_fail_response</code></a></td><td
valign="top"><a href="#microhttpd_002ddauth-digest">10.2 Using Digest
Authentication</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fqueue_005fbasic_005fauth_005ffail_005fresponse"><code>MHD_queue_basic_auth_fail_response</code></a></td><td
valign="top"><a href="#microhttpd_002ddauth-basic">10.1 Using Basic
Authentication</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fqueue_005fresponse"><code>MHD_queue_response</code></a></td><td
valign="top"><a href="#microhttpd_002dresponse-enqueue">8.1 Enqueuing a
response</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fquiesce_005fdaemon"><code>MHD_quiesce_daemon</code></a></td><td
valign="top"><a href="#microhttpd_002dinit">5. Starting and stopping the
server</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fresume_005fconnection"><code>MHD_resume_connection</code></a></td><td
valign="top"><a href="#microhttpd_002dflow">9. Flow control.</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005frun"><code>MHD_run</code></a></td><td valign="top"><a
href="#microhttpd_002dinit">5. Starting and stopping the server</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-MHD_005fset_005fconnection_005foption"><code>MHD_set_connection_option</code></a></td><td
valign="top"><a href="#microhttpd_002doption-conn">11.3 Setting custom options
for an individual connection</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005frun_005ffrom_005fselect"><code>MHD_run_from_select</code></a></td><td
valign="top"><a href="#microhttpd_002dinit">5. Starting and stopping the
server</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fset_005fconnection_005foption"><code>MHD_set_connection_option</code></a></td><td
valign="top"><a href="#microhttpd_002doption-conn">12.3 Setting custom options
for an individual connection</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fset_005fconnection_005fvalue"><code>MHD_set_connection_value</code></a></td><td
valign="top"><a href="#microhttpd_002drequests">7. Handling
requests</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fset_005fpanic_005ffunc"><code>MHD_set_panic_func</code></a></td><td
valign="top"><a href="#microhttpd_002dinit">5. Starting and stopping the
server</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fset_005fresponse_005foptions"><code>MHD_set_response_options</code></a></td><td
valign="top"><a href="#microhttpd_002dresponse-options">8.4 Setting response
options</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fstart_005fdaemon"><code>MHD_start_daemon</code></a></td><td
valign="top"><a href="#microhttpd_002dinit">5. Starting and stopping the
server</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fstop_005fdaemon"><code>MHD_stop_daemon</code></a></td><td
valign="top"><a href="#microhttpd_002dinit">5. Starting and stopping the
server</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fsuspend_005fconnection"><code>MHD_suspend_connection</code></a></td><td
valign="top"><a href="#microhttpd_002dflow">9. Flow control.</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
</table>
<table><tr><th valign="top">Jump to: </th><td><a
href="#Function-and-Data-Index-1_fn_symbol-1"
class="summary-letter"><b>*</b></a>
@@ -4409,18 +5155,20 @@
<tr><th><a name="Type-Index-1_tp_letter-M">M</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fConnection"><code>MHD_Connection</code></a></td><td
valign="top"><a href="#microhttpd_002dstruct">3. Structures type
definition</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fConnectionInfo"><code>MHD_ConnectionInfo</code></a></td><td
valign="top"><a href="#microhttpd_002dstruct">3. Structures type
definition</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-MHD_005fConnectionInfoType"><code>MHD_ConnectionInfoType</code></a></td><td
valign="top"><a href="#microhttpd_002dinfo-conn">11.2 Obtaining state
information about a connection</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-MHD_005fCONNECTION_005fOPTION"><code>MHD_CONNECTION_OPTION</code></a></td><td
valign="top"><a href="#microhttpd_002doption-conn">11.3 Setting custom options
for an individual connection</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fConnectionInfoType"><code>MHD_ConnectionInfoType</code></a></td><td
valign="top"><a href="#microhttpd_002dinfo-conn">12.2 Obtaining state
information about a connection</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fCONNECTION_005fOPTION"><code>MHD_CONNECTION_OPTION</code></a></td><td
valign="top"><a href="#microhttpd_002doption-conn">12.3 Setting custom options
for an individual connection</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fDaemon"><code>MHD_Daemon</code></a></td><td
valign="top"><a href="#microhttpd_002dstruct">3. Structures type
definition</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fDaemonInfo"><code>MHD_DaemonInfo</code></a></td><td
valign="top"><a href="#microhttpd_002dstruct">3. Structures type
definition</a></td></tr>
-<tr><td></td><td valign="top"><a
href="#index-MHD_005fDaemonInfoType"><code>MHD_DaemonInfoType</code></a></td><td
valign="top"><a href="#microhttpd_002dinfo-daemon">11.1 Obtaining state
information about an MHD daemon</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fDaemonInfoType"><code>MHD_DaemonInfoType</code></a></td><td
valign="top"><a href="#microhttpd_002dinfo-daemon">12.1 Obtaining state
information about an MHD daemon</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fFLAG"><code>MHD_FLAG</code></a></td><td valign="top"><a
href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fOPTION"><code>MHD_OPTION</code></a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fOptionItem"><code>MHD_OptionItem</code></a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fPostProcessor"><code>MHD_PostProcessor</code></a></td><td
valign="top"><a href="#microhttpd_002dstruct">3. Structures type
definition</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fRequestTerminationCode"><code>MHD_RequestTerminationCode</code></a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fResponse"><code>MHD_Response</code></a></td><td
valign="top"><a href="#microhttpd_002dstruct">3. Structures type
definition</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fResponseFlags"><code>MHD_ResponseFlags</code></a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fResponseMemoryMode"><code>MHD_ResponseMemoryMode</code></a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
+<tr><td></td><td valign="top"><a
href="#index-MHD_005fResponseOptions"><code>MHD_ResponseOptions</code></a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td></td><td valign="top"><a
href="#index-MHD_005fValueKind"><code>MHD_ValueKind</code></a></td><td
valign="top"><a href="#microhttpd_002dconst">2. Constants</a></td></tr>
<tr><td colspan="3"> <hr></td></tr>
</table>
@@ -4439,7 +5187,7 @@
<h1>Footnotes</h1>
<h3><a name="FOOT1" href="#DOCF1">(1)</a></h3>
<p>Note to readers acquainted
-to the Tcl <acronym>API</acronym>: reference counting on
<code>MHD_Connection</code>
+to the Tcl API: reference counting on <code>MHD_Connection</code>
structures is handled in the same way as Tcl handles <code>Tcl_Obj</code>
structures through <code>Tcl_IncrRefCount()</code> and
<code>Tcl_DecrRefCount()</code>.
@@ -4458,9 +5206,13 @@
<li><a name="toc-Introduction" href="#microhttpd_002dintro">1.
Introduction</a>
<ul class="toc">
<li><a name="toc-Scope" href="#Scope">1.1 Scope</a></li>
- <li><a name="toc-Including-the-microhttpd_002eh-header"
href="#Including-the-microhttpd_002eh-header">1.2 Including the microhttpd.h
header</a></li>
- <li><a name="toc-SIGPIPE" href="#SIGPIPE">1.3 SIGPIPE</a></li>
- <li><a name="toc-MHD_005fLONG_005fLONG" href="#MHD_005fLONG_005fLONG">1.4
MHD_LONG_LONG</a></li>
+ <li><a name="toc-Thread-modes-and-event-loops"
href="#Thread-modes-and-event-loops">1.2 Thread modes and event loops</a></li>
+ <li><a name="toc-Compiling-GNU-libmicrohttpd"
href="#Compiling-GNU-libmicrohttpd">1.3 Compiling GNU libmicrohttpd</a></li>
+ <li><a name="toc-Including-the-microhttpd_002eh-header"
href="#Including-the-microhttpd_002eh-header">1.4 Including the microhttpd.h
header</a></li>
+ <li><a name="toc-SIGPIPE" href="#SIGPIPE">1.5 SIGPIPE</a></li>
+ <li><a name="toc-MHD_005fUNSIGNED_005fLONG_005fLONG"
href="#MHD_005fUNSIGNED_005fLONG_005fLONG">1.6 MHD_UNSIGNED_LONG_LONG</a></li>
+ <li><a name="toc-Portability-to-W32" href="#Portability-to-W32">1.7
Portability to W32</a></li>
+ <li><a name="toc-Portability-to-z_002fOS"
href="#Portability-to-z_002fOS">1.8 Portability to z/OS</a></li>
</ul></li>
<li><a name="toc-Constants" href="#microhttpd_002dconst">2.
Constants</a></li>
<li><a name="toc-Structures-type-definition"
href="#microhttpd_002dstruct">3. Structures type definition</a></li>
@@ -4473,22 +5225,24 @@
<li><a name="toc-Enqueuing-a-response"
href="#microhttpd_002dresponse-enqueue">8.1 Enqueuing a response</a></li>
<li><a name="toc-Creating-a-response-object"
href="#microhttpd_002dresponse-create">8.2 Creating a response object</a></li>
<li><a name="toc-Adding-headers-to-a-response"
href="#microhttpd_002dresponse-headers">8.3 Adding headers to a
response</a></li>
- <li><a name="toc-Inspecting-a-response-object"
href="#microhttpd_002dresponse-inspect">8.4 Inspecting a response
object</a></li>
+ <li><a name="toc-Setting-response-options"
href="#microhttpd_002dresponse-options">8.4 Setting response options</a></li>
+ <li><a name="toc-Inspecting-a-response-object"
href="#microhttpd_002dresponse-inspect">8.5 Inspecting a response
object</a></li>
</ul></li>
- <li><a name="toc-Utilizing-Authentication" href="#microhttpd_002ddauth">9.
Utilizing Authentication</a>
+ <li><a name="toc-Flow-control_002e" href="#microhttpd_002dflow">9. Flow
control.</a></li>
+ <li><a name="toc-Utilizing-Authentication" href="#microhttpd_002ddauth">10.
Utilizing Authentication</a>
<ul class="toc">
- <li><a name="toc-Using-Basic-Authentication"
href="#microhttpd_002ddauth-basic">9.1 Using Basic Authentication</a></li>
- <li><a name="toc-Using-Digest-Authentication"
href="#microhttpd_002ddauth-digest">9.2 Using Digest Authentication</a></li>
+ <li><a name="toc-Using-Basic-Authentication"
href="#microhttpd_002ddauth-basic">10.1 Using Basic Authentication</a></li>
+ <li><a name="toc-Using-Digest-Authentication"
href="#microhttpd_002ddauth-digest">10.2 Using Digest Authentication</a></li>
</ul></li>
- <li><a name="toc-Adding-a-POST-processor" href="#microhttpd_002dpost">10.
Adding a <code>POST</code> processor</a>
+ <li><a name="toc-Adding-a-POST-processor" href="#microhttpd_002dpost">11.
Adding a <code>POST</code> processor</a>
<ul class="toc">
- <li><a name="toc-Programming-interface-for-the-POST-processor"
href="#microhttpd_002dpost-api">10.1 Programming interface for the
<code>POST</code> processor</a></li>
+ <li><a name="toc-Programming-interface-for-the-POST-processor"
href="#microhttpd_002dpost-api">11.1 Programming interface for the
<code>POST</code> processor</a></li>
</ul></li>
- <li><a name="toc-Obtaining-and-modifying-status-information_002e"
href="#microhttpd_002dinfo">11. Obtaining and modifying status information.</a>
+ <li><a name="toc-Obtaining-and-modifying-status-information_002e"
href="#microhttpd_002dinfo">12. Obtaining and modifying status information.</a>
<ul class="toc">
- <li><a name="toc-Obtaining-state-information-about-an-MHD-daemon"
href="#microhttpd_002dinfo-daemon">11.1 Obtaining state information about an
MHD daemon</a></li>
- <li><a name="toc-Obtaining-state-information-about-a-connection"
href="#microhttpd_002dinfo-conn">11.2 Obtaining state information about a
connection</a></li>
- <li><a name="toc-Setting-custom-options-for-an-individual-connection"
href="#microhttpd_002doption-conn">11.3 Setting custom options for an
individual connection</a></li>
+ <li><a name="toc-Obtaining-state-information-about-an-MHD-daemon"
href="#microhttpd_002dinfo-daemon">12.1 Obtaining state information about an
MHD daemon</a></li>
+ <li><a name="toc-Obtaining-state-information-about-a-connection"
href="#microhttpd_002dinfo-conn">12.2 Obtaining state information about a
connection</a></li>
+ <li><a name="toc-Setting-custom-options-for-an-individual-connection"
href="#microhttpd_002doption-conn">12.3 Setting custom options for an
individual connection</a></li>
</ul></li>
<li><a name="toc-GNU_002dLGPL-1" href="#GNU_002dLGPL">GNU-LGPL</a></li>
<li><a name="toc-GNU-GPL-with-eCos-Extension-1"
href="#GNU-GPL-with-eCos-Extension">GNU GPL with eCos Extension</a>
@@ -4520,9 +5274,10 @@
<li><a name="stoc-Implementing-external-select"
href="#microhttpd_002dinspect">6. Implementing external
<code>select</code></a></li>
<li><a name="stoc-Handling-requests" href="#microhttpd_002drequests">7.
Handling requests</a></li>
<li><a name="stoc-Building-responses-to-requests"
href="#microhttpd_002dresponses">8. Building responses to requests</a></li>
-<li><a name="stoc-Utilizing-Authentication" href="#microhttpd_002ddauth">9.
Utilizing Authentication</a></li>
-<li><a name="stoc-Adding-a-POST-processor" href="#microhttpd_002dpost">10.
Adding a <code>POST</code> processor</a></li>
-<li><a name="stoc-Obtaining-and-modifying-status-information_002e"
href="#microhttpd_002dinfo">11. Obtaining and modifying status
information.</a></li>
+<li><a name="stoc-Flow-control_002e" href="#microhttpd_002dflow">9. Flow
control.</a></li>
+<li><a name="stoc-Utilizing-Authentication" href="#microhttpd_002ddauth">10.
Utilizing Authentication</a></li>
+<li><a name="stoc-Adding-a-POST-processor" href="#microhttpd_002dpost">11.
Adding a <code>POST</code> processor</a></li>
+<li><a name="stoc-Obtaining-and-modifying-status-information_002e"
href="#microhttpd_002dinfo">12. Obtaining and modifying status
information.</a></li>
<li><a name="stoc-GNU_002dLGPL-1" href="#GNU_002dLGPL">GNU-LGPL</a></li>
<li><a name="stoc-GNU-GPL-with-eCos-Extension-1"
href="#GNU-GPL-with-eCos-Extension">GNU GPL with eCos Extension</a></li>
<li><a name="stoc-GNU_002dFDL-1" href="#GNU_002dFDL">GNU-FDL</a></li>
@@ -4541,7 +5296,7 @@
</tr></table>
<h1>About This Document</h1>
<p>
- This document was generated by <em>Christian Grothoff</em> on <em>September
12, 2011</em> using <a href="http://www.nongnu.org/texi2html/";><em>texi2html
1.82</em></a>.
+ This document was generated by <em>Christian Grothoff</em> on <em>October 3,
2014</em> using <a href="http://www.nongnu.org/texi2html/";><em>texi2html
1.82</em></a>.
</p>
<p>
The buttons in the navigation panels have the following meaning:
@@ -4643,7 +5398,7 @@
<hr size="1">
<p>
<font size="-1">
- This document was generated by <em>Christian Grothoff</em> on <em>September
12, 2011</em> using <a href="http://www.nongnu.org/texi2html/";><em>texi2html
1.82</em></a>.
+ This document was generated by <em>Christian Grothoff</em> on <em>October 3,
2014</em> using <a href="http://www.nongnu.org/texi2html/";><em>texi2html
1.82</em></a>.
</font>
<br>
Modified: libmicrohttpd-docs/WWW/microhttpd.pdf
===================================================================
(Binary files differ)
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [GNUnet-SVN] r34325 - libmicrohttpd-docs/WWW,
gnunet <=