diff options
Diffstat (limited to 'ftp/curl/files/patch-docs::libcurl::curl_easy_pause.html')
| -rw-r--r-- | ftp/curl/files/patch-docs::libcurl::curl_easy_pause.html | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/ftp/curl/files/patch-docs::libcurl::curl_easy_pause.html b/ftp/curl/files/patch-docs::libcurl::curl_easy_pause.html new file mode 100644 index 000000000000..3f557dce5782 --- /dev/null +++ b/ftp/curl/files/patch-docs::libcurl::curl_easy_pause.html @@ -0,0 +1,21 @@ +diff -urN -urN -x .svn ../../vendor/curl/docs/libcurl/curl_easy_pause.html ./docs/libcurl/curl_easy_pause.html +--- ../../vendor/curl/docs/libcurl/curl_easy_pause.html 2008-01-28 13:31:59.000000000 +0200 ++++ ./docs/libcurl/curl_easy_pause.html 2008-04-02 15:51:19.000000000 +0300 +@@ -49,7 +49,7 @@ + <p class="level0"><span Class="bold">CURLcode curl_easy_pause(CURL *handle , int bitmask );</span> + <p class="level0"><a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2> + <p class="level0">Using this function, you can explicitly mark a running connection to get paused, and you can unpause a connection that was previously paused. +-<p class="level0">A connection can made to pause by using this function or by letting the read or the write callbacks return the proper magic return code (<span Class="emphasis">CURL_READFUNC_PAUSE</span> and <span Class="emphasis">CURL_WRITEFUNC_PAUSE</span>). ++<p class="level0">A connection can be paused by using this function or by letting the read or the write callbacks return the proper magic return code (<span Class="emphasis">CURL_READFUNC_PAUSE</span> and <span Class="emphasis">CURL_WRITEFUNC_PAUSE</span>). + <p class="level0">NOTE: while it may feel tempting, take care and notice that you cannot call this function from another thread. + <p class="level0">When this function is called to unpause reading, the chance is high that you will get your write callback called before this function returns. + <p class="level0">The <span Class="bold">handle</span> argument is of course identifying the handle that operates on the connection you want to pause or unpause. +@@ -65,7 +65,7 @@ + <p class="level0">CURLE_OK (zero) means that the option was set properly, and a non-zero return code means something wrong occurred after the new state was set. See the <span Class="emphasis">libcurl-errors(3)</span> man page for the full list with descriptions. <a name="AVAILABILITY"></a><h2 class="nroffsh">AVAILABILITY</h2> + <p class="level0">This function was added in libcurl 7.18.0. Before this version, there was no explicit support for pausing transfers. <a name="MEMORY"></a><h2 class="nroffsh">MEMORY USE</h2> + <p class="level0">When pausing a read by returning the magic return code from a write callback, the read data is already in libcurl's internal buffers so it'll have to keep it in an allocated buffer until the reading is again unpaused using this function. +-<p class="level0">If the downloaded data is compressed and is asked to get uncompressed automatially on download, libcurl will continue to uncompress the entire downloaded chunk and it will cache the data uncompressed. This has the side- effect that if you download something that is compressed a lot, it can result in a very large data amount needing to be allocated to save the data during the pause. This said, you should probably consider not using paused reading if you allow libcurl to uncompress data automatically. <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2> ++<p class="level0">If the downloaded data is compressed and is asked to get uncompressed automatically on download, libcurl will continue to uncompress the entire downloaded chunk and it will cache the data uncompressed. This has the side- effect that if you download something that is compressed a lot, it can result in a very large data amount needing to be allocated to save the data during the pause. This said, you should probably consider not using paused reading if you allow libcurl to uncompress data automatically. <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2> + <p class="level0"><a class="manpage" href="./curl_easy_cleanup.html">curl_easy_cleanup (3)</a> <a class="manpage" href="./curl_easy_reset.html"> curl_easy_reset (3)</a> <p class="roffit"> + This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>. + </body></html> |