diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2012-08-16 23:32:55 +0200 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2012-08-16 23:34:23 +0200 |
| commit | 41a3bff3da6b13fb8cab952c41e81ecfb518ec87 (patch) | |
| tree | 403557f4fa2b3197f4711f202f27470cce7cc793 | |
| parent | 82b0aebef36953604aa41b13669d48b2dc8983b8 (diff) | |
curl_easy_setopt: documented CURLSOCKTYPE_ACCEPT for SOCKOPTFUNCTION
| -rw-r--r-- | TODO-RELEASE | 2 | ||||
| -rw-r--r-- | docs/libcurl/curl_easy_setopt.3 | 20 | ||||
| -rw-r--r-- | docs/libcurl/symbols-in-versions | 1 |
3 files changed, 13 insertions, 10 deletions
diff --git a/TODO-RELEASE b/TODO-RELEASE index ac7b5d418..63e790545 100644 --- a/TODO-RELEASE +++ b/TODO-RELEASE @@ -6,8 +6,6 @@ To be addressed in 7.28 312 - custom Content-Length appears in CONNECT, solve it by offering a separate option to provide headers for the CONNECT request -314 - CURL_SOCKOPTFUNCTION for accept()ed connection, see Gokhan Sengun's patch - 315 - multiple receivers with SMTP and one fails 317 - CURLINFO_SSL_TRUST to return SSL-specific data for a darwinssl build diff --git a/docs/libcurl/curl_easy_setopt.3 b/docs/libcurl/curl_easy_setopt.3 index 68117d5cf..3b0dc6c9d 100644 --- a/docs/libcurl/curl_easy_setopt.3 +++ b/docs/libcurl/curl_easy_setopt.3 @@ -274,14 +274,18 @@ Pass a pointer to a function that matches the following prototype: \fBint function(void *clientp, curl_socket_t curlfd, curlsocktype purpose);\fP. This function gets called by libcurl after the socket() call but before the connect() call. The callback's \fIpurpose\fP argument identifies the exact -purpose for this particular socket, and currently only one value is supported: -\fICURLSOCKTYPE_IPCXN\fP for the primary connection (meaning the control -connection in the FTP case). Future versions of libcurl may support more -purposes. It passes the newly created socket descriptor so additional -setsockopt() calls can be done at the user's discretion. Return 0 (zero) from -the callback on success. Return 1 from the callback function to signal an -unrecoverable error to the library and it will close the socket and return -\fICURLE_COULDNT_CONNECT\fP. (Option added in 7.16.0) +purpose for this particular socket: + +\fICURLSOCKTYPE_IPCXN\fP for actively created connections or since 7.28.0 +\fICURLSOCKTYPE_ACCEPT\fP for FTP when the connection was setup with PORT/EPSV +(in earlier versions these sockets weren't passed to this callback). + +Future versions of libcurl may support more purposes. It passes the newly +created socket descriptor so additional setsockopt() calls can be done at the +user's discretion. Return 0 (zero) from the callback on success. Return 1 +from the callback function to signal an unrecoverable error to the library and +it will close the socket and return \fICURLE_COULDNT_CONNECT\fP. (Option +added in 7.16.0) Added in 7.21.5, the callback function may return \fICURL_SOCKOPT_ALREADY_CONNECTED\fP, which tells libcurl that the socket is diff --git a/docs/libcurl/symbols-in-versions b/docs/libcurl/symbols-in-versions index c738259eb..74e2958f9 100644 --- a/docs/libcurl/symbols-in-versions +++ b/docs/libcurl/symbols-in-versions @@ -567,6 +567,7 @@ CURLSHOPT_SHARE 7.10.3 CURLSHOPT_UNLOCKFUNC 7.10.3 CURLSHOPT_UNSHARE 7.10.3 CURLSHOPT_USERDATA 7.10.3 +CURLSOCKTYPE_ACCEPT 7.28.0 CURLSOCKTYPE_IPCXN 7.16.0 CURLSSH_AUTH_AGENT 7.28.0 CURLSSH_AUTH_ANY 7.16.1 |