diff options
author | Evgeny Grin (Karlson2k) <k2k@narod.ru> | 2022-03-14 21:22:21 +0300 |
---|---|---|
committer | Evgeny Grin (Karlson2k) <k2k@narod.ru> | 2022-03-14 21:22:21 +0300 |
commit | c3563144ee580e94e242c187772c51714e1b2311 (patch) | |
tree | 32c3673264006828abbf5cadfd23e699b737e49d /src/include | |
parent | 470e65c68fd346d8c5367d141f049bbc018ca0fb (diff) | |
download | libmicrohttpd-c3563144ee580e94e242c187772c51714e1b2311.tar.gz libmicrohttpd-c3563144ee580e94e242c187772c51714e1b2311.zip |
MHD_queue_response(): significantly improved doxy
Diffstat (limited to 'src/include')
-rw-r--r-- | src/include/microhttpd.h | 22 |
1 files changed, 18 insertions, 4 deletions
diff --git a/src/include/microhttpd.h b/src/include/microhttpd.h index d26702da..e49afdad 100644 --- a/src/include/microhttpd.h +++ b/src/include/microhttpd.h | |||
@@ -3224,10 +3224,24 @@ MHD_lookup_connection_value_n (struct MHD_Connection *connection, | |||
3224 | * For suspended connection this function can be called at any moment. Response | 3224 | * For suspended connection this function can be called at any moment. Response |
3225 | * will be sent as soon as connection is resumed. | 3225 | * will be sent as soon as connection is resumed. |
3226 | * | 3226 | * |
3227 | * If response object is used to answer HEAD request then the body of | 3227 | * If HTTP specifications require use no body in reply, like @a status_code with |
3228 | * the response is not used, while all headers (including automatic headers) | 3228 | * value 1xx, the response body is automatically not sent even if it is present |
3229 | * are used. In practice, the same response object can be used to respond to | 3229 | * in the response. No "Content-Length" or "Transfer-Encoding" headers are |
3230 | * both HEAD and GET requests. | 3230 | * generated and added. |
3231 | * | ||
3232 | * When the response is used to respond HEAD request or used with @a status_code | ||
3233 | * #MHD_HTTP_NOT_MODIFIED, then response body is not sent, but "Content-Length" | ||
3234 | * header is added automatically based the size of the body in the response. | ||
3235 | * If body size it set to #MHD_SIZE_UNKNOWN or chunked encoding is enforced | ||
3236 | * then "Transfer-Encoding: chunked" header (for HTTP/1.1 only) is added instead | ||
3237 | * of "Content-Length" header. | ||
3238 | * | ||
3239 | * In situations, where reply body is required, like answer for the GET request | ||
3240 | * with @a status_code #MHD_HTTP_OK, headers "Content-Length" (for known body | ||
3241 | * size) or "Transfer-Encoding: chunked" (for #MHD_SIZE_UNKNOWN with HTTP/1.1) | ||
3242 | * are added automatically. | ||
3243 | * In practice, the same response object can be used to respond to both HEAD and | ||
3244 | * GET requests. | ||
3231 | * | 3245 | * |
3232 | * @param connection the connection identifying the client | 3246 | * @param connection the connection identifying the client |
3233 | * @param status_code HTTP status code (i.e. #MHD_HTTP_OK) | 3247 | * @param status_code HTTP status code (i.e. #MHD_HTTP_OK) |