akosut 96/11/28 00:34:05
Modified: htdocs/manual/misc client_block_api.html Log: Update *_client_block documentation to match Roy's changes. Revision Changes Path 1.3 +17 -4 apache/htdocs/manual/misc/client_block_api.html Index: client_block_api.html =================================================================== RCS file: /export/home/cvs/apache/htdocs/manual/misc/client_block_api.html,v retrieving revision 1.2 retrieving revision 1.3 diff -C3 -r1.2 -r1.3 *** client_block_api.html 1996/11/21 09:55:47 1.2 --- client_block_api.html 1996/11/28 08:34:05 1.3 *************** *** 26,32 **** <h3>The New API Functions</h3> <pre> ! int setup_client_block (request_rec *); int should_client_block (request_rec *); long get_client_block (request_rec *, char *buffer, int buffer_size); </pre> --- 26,32 ---- <h3>The New API Functions</h3> <pre> ! int setup_client_block (request_rec *, int read_policy); int should_client_block (request_rec *); long get_client_block (request_rec *, char *buffer, int buffer_size); </pre> *************** *** 35,41 **** <li>Call <code>setup_client_block()</code> near the beginning of the request handler. This will set up all the neccessary properties, and will return either OK, or an error code. If the latter, ! the module should return that error code. <li>When you are ready to possibly accept input, call <code>should_client_block()</code>. --- 35,54 ---- <li>Call <code>setup_client_block()</code> near the beginning of the request handler. This will set up all the neccessary properties, and will return either OK, or an error code. If the latter, ! the module should return that error code. The second parameter ! selects the policy to apply if the request message indicates a ! body, and how a chunked ! transfer-coding sho uld be interpreted. Choose one of ! <pre> ! REQUEST_NO_BODY Send 413 error if message has any body ! REQUEST_CHUNKED_ERROR Send 411 error if body without Content-Length ! REQUEST_CHUNKED_DECHUNK If chunked, remove the chunks for me. ! REQUEST_CHUNKED_PASS Pass the chunks to me without removal. ! </pre> ! In order to use the last two options, the caller MUST provide a buffer ! large enough to hold a chunk-size line, including any extensions. ! ! <li>When you are ready to possibly accept input, call <code>should_client_block()</code>. *************** *** 52,59 **** buffer and its size. It will put data into the buffer (not neccessarily the full buffer, in the case of chunked inputs), and return the length of ! the input block. When it is done reading, it will return 0, and ! the module should proceed. </ol> --- 65,72 ---- buffer and its size. It will put data into the buffer (not neccessarily the full buffer, in the case of chunked inputs), and return the length of ! the input block. When it is done reading, it will ! return 0 if EOF, or -1 if there was an error. </ol>