moparisthebest
/
curl
mirror of https://github.com/moparisthebest/curl
1
0
Fork 0
Code Issues Releases Wiki Activity

clarify what the default read callback does and how it uses the READDATA 

option
This commit is contained in:
Daniel Stenberg 2005-09-22 10:15:10 +00:00
parent a2210d23c3
commit da192f7955
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/libcurl/curl_easy_setopt.3
View File

@ -21,7 +21,7 @@
.\" * $Id$ .\" * $Id$
.\" ************************************************************************** .\" **************************************************************************
.\" .\"
.TH curl_easy_setopt 3 "4 Sep 2005" "libcurl 7.14.2" "libcurl Manual" .TH curl_easy_setopt 3 "22 Sep 2005" "libcurl 7.14.2" "libcurl Manual"
.SH NAME .SH NAME
curl_easy_setopt - set options for a curl easy handle curl_easy_setopt - set options for a curl easy handle
.SH SYNOPSIS .SH SYNOPSIS
@ -136,13 +136,18 @@ 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 upload less than N bytes), you may experience that the server "hangs" waiting
for the rest of the data that won't come. for the rest of the data that won't come.
In libcurl 7.12.1 and later, the read callback may return The read callback may return \fICURL_READFUNC_ABORT\fP to stop the current
\fICURL_READFUNC_ABORT\fP to stop the current operation at once, with a operation immediately, resulting in a \fICURLE_ABORTED_BY_CALLBACK\fP error
\fICURLE_ABORTED_BY_CALLBACK\fP error code from the transfer. code from the transfer (Added in 7.12.1)
If you set the callback pointer to NULL, or doesn't set it at all, the default
internal read function will be used. It is simply doing an fread() on the FILE
* stream set with \fICURLOPT_READDATA\fP.
.IP CURLOPT_READDATA .IP CURLOPT_READDATA
Data pointer to pass to the file read function. If you use the Data pointer to pass to the file read function. If you use the
\fICURLOPT_READFUNCTION\fP option, this is the pointer you'll get as input. If \fICURLOPT_READFUNCTION\fP option, this is the pointer you'll get as input. If
you don't specify a read callback, this must be a valid FILE *. you don't specify a read callback but instead rely on the default internal
read function, this data must be a valid readable FILE *.
If you're using libcurl as a win32 DLL, you MUST use a If you're using libcurl as a win32 DLL, you MUST use a
\fICURLOPT_READFUNCTION\fP if you set this option. \fICURLOPT_READFUNCTION\fP if you set this option.