[libmicrohttpd2] branch master updated: plan, remove flow.inc, already done

[Admin]

This is an automated email from the git hooks/post-receive script.

grothoff pushed a commit to branch master
in repository libmicrohttpd2.

The following commit(s) were added to refs/heads/master by this push:
     new 56c9ec6  plan, remove flow.inc, already done
56c9ec6 is described below

commit 56c9ec62e8cd2ab640e9fe695ac9d53f11373910
Author: Christian Grothoff <christian@grothoff.org>
AuthorDate: Mon Feb 17 00:17:08 2025 +0100

    plan, remove flow.inc, already done
---
 doc/libmicrohttpd2.texi                   | 33 ++++---------
 doc/manual/flow.inc                       | 77 -------------------------------
 doc/manual/{websocket.inc => upgrade.inc} |  0
 3 files changed, 9 insertions(+), 101 deletions(-)

diff --git a/doc/libmicrohttpd2.texi b/doc/libmicrohttpd2.texi
index bb2a561..56f96d3 100644
--- a/doc/libmicrohttpd2.texi
+++ b/doc/libmicrohttpd2.texi
@@ -62,7 +62,7 @@ Free Documentation License".
 * libmicrohttpd2-actions::          Acting on HTTP requests.
 * libmicrohttpd2-responses::        Generating HTTP responses.
 * libmicrohttpd2-post::             Parsing @code{POST} data.
-* libmicrohttpd2-auth::             Utilizing HTTP authentication.
+* libmicrohttpd2-auth::             Using HTTP authentication.
 * libmicrohttpd2-upgrade::          Upgrading HTTP/1.1 connections.
 * libmicrohttpd2-introspection::    Obtaining status information.
 * libmicrohttpd2-util::             Utilities and special-use functions.
@@ -115,47 +115,32 @@ Indices
 @include manual/postprocessor.inc
 
 @node libmicrohttpd2-authentication
-@chapter Handling HTTP authentication
+@chapter Using HTTP authentication
 @include manual/authentication.inc
 
-
 @c NEXT:
-@c - auth [Sa]
-@c - introspection [Su]
-@c - upgrade + response-upgrade [Mo]
-@c - migration! [Di]
-@c - add more examples! [Mi]
+@c - introspection [Mo]
+@c - upgrade + response-upgrade [Di]
+@c - migration! [Mi]
 @c - doptions! [Do]
 @c - request options! [Fr]
 @c - other options (connection, session?) [Sa]
-@c - what about flow?
 
 @bye
 
 
-
-
-@node libmicrohttpd2-flow
-@chapter Flow control.
-@include manual/flow.inc
-
-@node libmicrohttpd2-dauth
-@chapter Utilizing Authentication
-@include manual/authentication.inc
-
-
 @node libmicrohttpd2-info
 @chapter Obtaining and modifying status information.
 @include manual/introspection.inc
 
-@node libmicrohttpd2-util
-@chapter Utility functions.
-@include manual/utility.inc
-
 @node libmicrohttpd2-websocket
 @chapter Websocket functions.
 @include manual/websocket.inc
 
+@node libmicrohttpd2-util
+@chapter Utility functions.
+@include manual/utility.inc
+
 @node GNU-LGPL
 @unnumbered GNU-LGPL
 @cindex license
diff --git a/doc/manual/flow.inc b/doc/manual/flow.inc
deleted file mode 100644
index bb07354..0000000
--- a/doc/manual/flow.inc
+++ /dev/null
@@ -1,77 +0,0 @@
-@noindent
-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} 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.
-
-Instead, applications using thread modes other than
-@code{MHD_USE_THREAD_PER_CONNECTION} should use the
-following functions to perform flow control.
-
-@deftypefun enum MHD_Result MHD_suspend_connection (struct MHD_Connection 
*connection)
-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.
-
-If you use this API in conjunction with a internal select or a
-thread pool, you must set the option @code{MHD_ALLOW_SUSPEND_RESUME} to
-ensure that a resumed connection is immediately processed by MHD.
-
-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.
-
-The only safe time to suspend a connection is from the
-@code{MHD_AccessHandlerCallback} or from the respective
-@code{MHD_ContentReaderCallback} (but in this case the
-response object must not be shared among multiple
-connections).
-
-When suspending from the @code{MHD_AccessHandlerCallback}
-you MUST afterwards return @code{MHD_YES} from the access handler
-callback (as MHD_NO would imply to both close and suspend
-the connection, which is not allowed).
-
-Finally, it is an API violation to call @code{MHD_stop_daemon} 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.
-
-@table @var
-@item connection
-the connection to suspend
-@end table
-@end deftypefun
-
-@deftypefun enum MHD_Result MHD_resume_connection (struct MHD_Connection 
*connection)
-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.
-
-If you are using this function in ``external'' select mode, you must
-make sure to run @code{MHD_run} afterwards (before again calling
-@code{MHD_get_fdset}), as otherwise the change may not be reflected in
-the set returned by @code{MHD_get_fdset} and you may end up with a
-connection that is stuck until the next network activity.
-
-You can check whether a connection is currently suspended using
-@code{MHD_get_connection_info} by querying for
-@code{MHD_CONNECTION_INFO_CONNECTION_SUSPENDED}.
-
-@table @var
-@item connection
-the connection to resume
-@end table
-@end deftypefun
-
diff --git a/doc/manual/websocket.inc b/doc/manual/upgrade.inc
similarity index 100%
rename from doc/manual/websocket.inc
rename to doc/manual/upgrade.inc

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.