generic-library/curl
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Added blurb for the READFUNCTION, including the new CURL_READFUNC_ABORT

Browse Source 
return code.
This commit is contained in:
Daniel Stenberg
2004-06-21 14:09:23 +00:00
parent 7291772b1f
commit 1886893d66
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/libcurl/curl_easy_setopt.3
View File

@@ -119,6 +119,15 @@ filled with at most \fIsize\fP multiplied with \fInmemb\fP number of
bytes. Your function must return the actual number of bytes that you stored in bytes. Your function must return the actual number of bytes that you stored in
that memory area. Returning 0 will signal end-of-file to the library and cause that memory area. Returning 0 will signal end-of-file to the library and cause
it to stop the current transfer. it to stop the current transfer.
If you stop the current transfer by returning 0 "pre-maturely" (i.e before the
server expected it, like when you've told you will upload N bytes and you
upload less than N bytes), you may experience that the server "hangs" waiting
for the rest of the data that won't come.
In libcurl 7.12.1 and later, the read callback may return
\fICURL_READFUNC_ABORT\fP to stop the current operation at once, with a
\fICURLE_ABORTED_BY_CALLBACK\fP error code from the transfer.
.IP CURLOPT_READDATA .IP CURLOPT_READDATA
Data pointer to pass to the file read function. Note that if you specify the Data pointer to pass to the file read function. Note that if you specify the
\fICURLOPT_READFUNCTION\fP, this is the pointer you'll get as input. If you \fICURLOPT_READFUNCTION\fP, this is the pointer you'll get as input. If you