aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2008-04-10 09:06:47 +0000
committerDaniel Stenberg <daniel@haxx.se>2008-04-10 09:06:47 +0000
commit098106b54c1249d050603a70847ad651c491980f (patch)
treee2782ee2f90d88fdb2a5100fdf1d7e72e14f1030
parent74bb59fa5792ac1639930a623a42089ee6a6a6d7 (diff)
mention what happens to the data when a write callback returns pause
-rw-r--r--docs/libcurl/curl_easy_pause.35
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/libcurl/curl_easy_pause.3 b/docs/libcurl/curl_easy_pause.3
index 247b39c27..ae2ed90a0 100644
--- a/docs/libcurl/curl_easy_pause.3
+++ b/docs/libcurl/curl_easy_pause.3
@@ -14,7 +14,10 @@ paused, and you can unpause a connection that was previously paused.
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
-(\fICURL_READFUNC_PAUSE\fP and \fICURL_WRITEFUNC_PAUSE\fP).
+(\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
+data at all, and that data will then be delivered again to the callback when
+the writing is later unpaused.
NOTE: while it may feel tempting, take care and notice that you cannot call
this function from another thread.