diff options
Diffstat (limited to 'docs/libcurl/curl_easy_pause.3')
| -rw-r--r-- | docs/libcurl/curl_easy_pause.3 | 35 |
1 files changed, 20 insertions, 15 deletions
diff --git a/docs/libcurl/curl_easy_pause.3 b/docs/libcurl/curl_easy_pause.3 index b97da63cb..aba9d4fd4 100644 --- a/docs/libcurl/curl_easy_pause.3 +++ b/docs/libcurl/curl_easy_pause.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -19,7 +19,7 @@ .\" * KIND, either express or implied. .\" * .\" ************************************************************************** -.TH curl_easy_pause 3 "December 22, 2020" "libcurl 7.78.0" "libcurl Manual" +.TH curl_easy_pause 3 "October 31, 2021" "libcurl 7.80.0" "libcurl Manual" .SH NAME curl_easy_pause - pause and unpause a connection @@ -36,7 +36,7 @@ paused, and you can unpause a connection that was previously paused. A connection can be paused by using this function or by letting the read or the write callbacks return the proper magic return code (\fICURL_READFUNC_PAUSE\fP and \fICURL_WRITEFUNC_PAUSE\fP). A write callback -that returns pause signals to the library that it couldn't take care of any +that returns pause signals to the library that it could not take care of any data at all, and that data will then be delivered again to the callback when the transfer is unpaused. @@ -60,19 +60,15 @@ connection. The following bits can be used: .IP CURLPAUSE_RECV Pause receiving data. There will be no data received on this connection until this function is called again without this bit set. Thus, the write callback -(\fICURLOPT_WRITEFUNCTION(3)\fP) won't be called. +(\fICURLOPT_WRITEFUNCTION(3)\fP) will not be called. .IP CURLPAUSE_SEND Pause sending data. There will be no data sent on this connection until this function is called again without this bit set. Thus, the read callback -(\fICURLOPT_READFUNCTION(3)\fP) won't be called. +(\fICURLOPT_READFUNCTION(3)\fP) will not be called. .IP CURLPAUSE_ALL Convenience define that pauses both directions. .IP CURLPAUSE_CONT Convenience define that unpauses both directions. -.SH RETURN VALUE -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 -\fIlibcurl-errors(3)\fP man page for the full list with descriptions. .SH LIMITATIONS The pausing of transfers does not work with protocols that work without network connectivity, like FILE://. Trying to pause such a transfer, in any @@ -89,11 +85,14 @@ buffering 32 megabyte of data for a paused stream. When such a paused stream is unpaused again, any buffered data will be delivered first. -.SH AVAILABILITY -Added in libcurl 7.18.0. +.SH EXAMPLE +.nf +/* pause a transfer in both directions */ +curl_easy_pause(curl, CURL_READFUNC_PAUSE | CURL_WRITEFUNC_PAUSE); +.fi .SH "MEMORY USE" 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 +the read data is already in libcurl's internal buffers so it will have to keep it in an allocated buffer until the receiving is again unpaused using this function. @@ -101,8 +100,14 @@ 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 receiving -if you allow libcurl to uncompress data automatically. +in a large data amount needing to be allocated to save the data during the +pause. This said, you should probably consider not using paused receiving if +you allow libcurl to uncompress data automatically. +.SH AVAILABILITY +Added in 7.18.0. +.SH RETURN VALUE +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 +\fIlibcurl-errors(3)\fP man page for the full list with descriptions. .SH "SEE ALSO" .BR curl_easy_cleanup "(3), " curl_easy_reset "(3)" |