diff options
author | Christian Grothoff <christian@grothoff.org> | 2015-01-11 00:31:54 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2015-01-11 00:31:54 +0000 |
commit | 61876d057853557018e73cf4bde84d8021d11fbe (patch) | |
tree | 3c1c27a4da7df66eb05278c30bc95f3eb5af22dc | |
parent | f52cd063f107d39fb14e4e3830666051321f403d (diff) | |
download | libmicrohttpd-61876d057853557018e73cf4bde84d8021d11fbe.tar.gz libmicrohttpd-61876d057853557018e73cf4bde84d8021d11fbe.zip |
fix documentation
-rw-r--r-- | doc/libmicrohttpd.texi | 31 |
1 files changed, 20 insertions, 11 deletions
diff --git a/doc/libmicrohttpd.texi b/doc/libmicrohttpd.texi index c225b374..c0ad91a1 100644 --- a/doc/libmicrohttpd.texi +++ b/doc/libmicrohttpd.texi | |||
@@ -1097,17 +1097,26 @@ the data being uploaded (excluding headers): | |||
1097 | @cindex POST method | 1097 | @cindex POST method |
1098 | @cindex PUT method | 1098 | @cindex PUT method |
1099 | 1099 | ||
1100 | @itemize | 1100 | @code{POST} data @strong{will} be made available |
1101 | @item | 1101 | incrementally in @var{upload_data}; even if @code{POST} |
1102 | for a @code{POST} that fits into memory and that is encoded with a | 1102 | data is available, the first time the callback is |
1103 | supported encoding, the @code{POST} data will @strong{NOT} be given in | 1103 | invoked there won't be upload data, as this is done |
1104 | @var{upload_data} and is instead available as part of | 1104 | just after MHD parses the headers. If supported by |
1105 | @code{MHD_get_connection_values()}; | 1105 | the client and the HTTP version, the application can |
1106 | 1106 | at this point queue an error response to possibly | |
1107 | @item | 1107 | avoid the upload entirely. If no response is generated, |
1108 | very large @code{POST} data @strong{will} be made available | 1108 | MHD will (if required) automatically send a 100 CONTINUE |
1109 | incrementally in @var{upload_data}; | 1109 | reply to the client. |
1110 | @end itemize | 1110 | |
1111 | Afterwards, POST data will be passed to the callback | ||
1112 | to be processed incrementally by the application. The | ||
1113 | application may return @code{MHD_NO} to forcefully | ||
1114 | terminate the TCP connection without generating a | ||
1115 | proper HTTP response. Once all of the upload data has | ||
1116 | been provided to the application, the application | ||
1117 | will be called again with 0 bytes of upload data. | ||
1118 | At this point, a response should be queued to complete | ||
1119 | the handling of the request. | ||
1111 | 1120 | ||
1112 | @item upload_data_size | 1121 | @item upload_data_size |
1113 | set initially to the size of the @var{upload_data} provided; this | 1122 | set initially to the size of the @var{upload_data} provided; this |