aboutsummaryrefslogtreecommitdiff
path: root/src/include
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2016-10-17 10:16:42 +0200
committerChristian Grothoff <christian@grothoff.org>2016-10-17 10:16:42 +0200
commit36d3808c1e7f9646e6a9ca1cad42a4297f12c5ee (patch)
treea896bcdc150e45d8e3f9b769c3032c6f3a459fee /src/include
parent22a5fb5239fa471c97e81f93e5058e7fb7143eaa (diff)
downloadlibmicrohttpd-36d3808c1e7f9646e6a9ca1cad42a4297f12c5ee.tar.gz
libmicrohttpd-36d3808c1e7f9646e6a9ca1cad42a4297f12c5ee.zip
clean up leftovers in upgrade documentation
Diffstat (limited to 'src/include')
-rw-r--r--src/include/microhttpd.h27
1 files changed, 8 insertions, 19 deletions
diff --git a/src/include/microhttpd.h b/src/include/microhttpd.h
index 06b23972..ebd94c7a 100644
--- a/src/include/microhttpd.h
+++ b/src/include/microhttpd.h
@@ -2299,25 +2299,14 @@ MHD_upgrade_action (struct MHD_UpgradeResponseHandle *urh,
2299 * successfully and the socket should now be controlled by some 2299 * successfully and the socket should now be controlled by some
2300 * protocol other than HTTP. 2300 * protocol other than HTTP.
2301 * 2301 *
2302 * Any data received on the socket will be made available in 2302 * Any data already received on the socket will be made available in
2303 * 'data_in'. The function should update 'data_in_size' to 2303 * @e extra_in. This can happen if the application sent extra data
2304 * reflect the number of bytes consumed from 'data_in' (the remaining 2304 * before MHD send the upgrade response. The application should
2305 * bytes will be made available in the next call to the handler). 2305 * treat data from @a extra_in as if it had read it from the socket.
2306 * 2306 *
2307 * Any data that should be transmitted on the socket should be 2307 * Note that the application must not close() @a sock directly,
2308 * stored in 'data_out'. '*data_out_size' is initially set to 2308 * but instead use #MHD_upgrade_action() for special operations
2309 * the available buffer space in 'data_out'. It should be set to 2309 * on @a sock.
2310 * the number of bytes stored in 'data_out' (which can be zero).
2311 *
2312 * The return value is a BITMASK that indicates how the function
2313 * intends to interact with the event loop. It can request to be
2314 * notified for reading, writing, request to UNCORK the send buffer
2315 * (which MHD is allowed to ignore, if it is not possible to uncork on
2316 * the local platform), to wait for the 'external' select loop to
2317 * trigger another round. It is also possible to specify "no events"
2318 * to terminate the connection; in this case, the
2319 * #MHD_RequestCompletedCallback will be called and all resources of
2320 * the connection will be released.
2321 * 2310 *
2322 * Except when in 'thread-per-connection' mode, implementations 2311 * Except when in 'thread-per-connection' mode, implementations
2323 * of this function should never block (as it will still be called 2312 * of this function should never block (as it will still be called