luo980/curl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

OPENSOCKETFUNCTION.3: correct the purpose description

Browse Source 
Reported-by: Jeff Mears
Bug: https://curl.haxx.se/mail/lib-2019-12/0007.html

Closes #4667
This commit is contained in:
Daniel Stenberg 2019-12-03 09:29:43 +01:00
parent 48da3ac67b
commit 0092b6bf8a
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
1 changed files with 4 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___ .\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____| .\" * \___|\___/|_| \_\_____|
.\" * .\" *
.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * .\" *
.\" * This software is licensed as described in the file COPYING, which .\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms .\" * you should have received as part of this distribution. The terms
@ -29,8 +29,6 @@ CURLOPT_OPENSOCKETFUNCTION \- set callback for opening sockets
typedef enum { typedef enum {
CURLSOCKTYPE_IPCXN, /* socket created for a specific IP connection */ CURLSOCKTYPE_IPCXN, /* socket created for a specific IP connection */
CURLSOCKTYPE_ACCEPT, /* socket created by accept() call */
CURLSOCKTYPE_LAST /* never use */
} curlsocktype; } curlsocktype;
struct curl_sockaddr { struct curl_sockaddr {
@ -52,10 +50,9 @@ shown above.
This callback function gets called by libcurl instead of the \fIsocket(2)\fP This callback function gets called by libcurl instead of the \fIsocket(2)\fP
call. The callback's \fIpurpose\fP argument identifies the exact purpose for call. The callback's \fIpurpose\fP argument identifies the exact purpose for
this particular socket: \fICURLSOCKTYPE_IPCXN\fP is for IP based connections this particular socket. \fICURLSOCKTYPE_IPCXN\fP is for IP based connections
and \fICURLSOCKTYPE_ACCEPT\fP is for sockets created after accept() - such as and is the only purpose currently used in libcurl. Future versions of libcurl
when doing active FTP. Future versions of libcurl may support more may support more purposes.
purposes.
The \fIclientp\fP pointer contains whatever user-defined value set using the The \fIclientp\fP pointer contains whatever user-defined value set using the
\fICURLOPT_OPENSOCKETDATA(3)\fP function. \fICURLOPT_OPENSOCKETDATA(3)\fP function.