commit 475cfd18d10d3aa76faa64da2f958632a097c350
parent 0ae9a4c10b2534f58b0e2aa0841fc837dfe5aa2a
Author: Evgeny Grin (Karlson2k) <k2k@narod.ru>
Date: Tue, 9 Nov 2021 20:57:02 +0300
Updated doxy for MHD_AccessHandlerCallback
Diffstat:
1 file changed, 11 insertions(+), 4 deletions(-)
diff --git a/src/include/microhttpd.h b/src/include/microhttpd.h
@@ -2354,23 +2354,30 @@ typedef enum MHD_Result
* #MHD_HTTP_METHOD_POST, etc).
*
* The callback must call MHD function MHD_queue_response() to provide content
- * to give back to the client and return an HTTP status code
- * (i.e. #MHD_HTTP_OK, #MHD_HTTP_NOT_FOUND, etc.). The response can be created
+ * to give back to the client and return an HTTP status code (i.e.
+ * #MHD_HTTP_OK, #MHD_HTTP_NOT_FOUND, etc.). The response can be created
* in this callback or prepared in advance.
- * As soon as response is provided this callback will not be called anymore
- * for the current request.
* Alternatively, callback may call MHD_suspend_connection() to temporarily
* suspend data processing for this connection.
+ *
+ * As soon as response is provided this callback will not be called anymore
+ * for the current request.
+ *
* For each HTTP request this callback is called several times:
* * after request headers are fully received and decoded,
* * for each received part of request body (optional, if request has body),
* * when request is fully received.
+ *
* If response is provided before request is fully received, the rest
* of the request is discarded and connection is automatically closed
* after sending response.
+ *
* If the request is fully received, but response hasn't been provided and
* connection is not suspended, the callback can be called again immediately.
*
+ * The response cannot be queued when this callback is called to process
+ * the client upload data (when @a upload_data is not NULL).
+ *
* @param cls argument given together with the function
* pointer when the handler was registered with MHD
* @param url the requested url
