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

opts: Document the socket callback function parameters

Browse Source
This commit is contained in:
Dan Fandrich 2014-07-01 07:59:28 +02:00
parent 1b6bc02fb9
commit 46a886cd48
2 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/libcurl/opts/CURLOPT_OPENSOCKETFUNCTION.3
View File

@ -57,6 +57,9 @@ and \fICURLSOCKTYPE_ACCEPT\fP is for sockets created after accept() - such as
when doing active FTP. Future versions of libcurl may support more
purposes.
The \fIclientp\fP pointer contains whatever user-defined value set using the
\fICURLOPT_OPENSOCKETDATA\fP function.
The callback gets the resolved peer address as the \fIaddress\fP argument and
is allowed to modify the address or refuse to connect completely. The callback
function should return the newly created socket or \fICURL_SOCKET_BAD\fP in

14
docs/libcurl/opts/CURLOPT_SOCKOPTFUNCTION.3
View File

@ -57,12 +57,16 @@ exact purpose for this particular socket:
(in earlier versions these sockets weren't passed to this callback).
Future versions of libcurl may support more purposes. libcurl passes the newly
created socket descriptor to the callback so additional setsockopt() calls can
be done at the user's discretion. Return \fICURL_SOCKOPT_OK\fP from the
callback on success. Return \fICURL_SOCKOPT_ERROR\fP from the callback
function to signal an unrecoverable error to the library and it will close the
socket and return \fICURLE_COULDNT_CONNECT\fP.
created socket descriptor to the callback in the \fIcurlfd\fP parameter so
additional setsockopt() calls can be done at the user's discretion.
The \fIclientp\fP pointer contains whatever user-defined value set using the
\fICURLOPT_SOCKOPTDATA\fP function.
Return \fICURL_SOCKOPT_OK\fP from the callback on success. Return
\fICURL_SOCKOPT_ERROR\fP from the callback function to signal an unrecoverable
error to the library and it will close the socket and return
\fICURLE_COULDNT_CONNECT\fP.
Alternatively, the callback function can return
\fICURL_SOCKOPT_ALREADY_CONNECTED\fP, to tell libcurl that the socket is
already connected and then libcurl will not attempt to connect it. This allows