aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/CURLOPT_OPENSOCKETFUNCTION.3
diff options
context:
space:
mode:
authorDan Fandrich <dan@coneharvesters.com>2014-07-01 07:59:28 +0200
committerDan Fandrich <dan@coneharvesters.com>2014-07-01 08:12:11 +0200
commit46a886cd4880a2b4ab45c856b4695eaf3328431f (patch)
treef54b4bce1d4827c9858dd1d4164bda7eb4033222 /docs/libcurl/opts/CURLOPT_OPENSOCKETFUNCTION.3
parent1b6bc02fb926403f04061721f9159e9887202a96 (diff)
opts: Document the socket callback function parameters
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_OPENSOCKETFUNCTION.3')
-rw-r--r--docs/libcurl/opts/CURLOPT_OPENSOCKETFUNCTION.33
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLOPT_OPENSOCKETFUNCTION.3 b/docs/libcurl/opts/CURLOPT_OPENSOCKETFUNCTION.3
index bff7283e3..9977f0700 100644
--- a/docs/libcurl/opts/CURLOPT_OPENSOCKETFUNCTION.3
+++ b/docs/libcurl/opts/CURLOPT_OPENSOCKETFUNCTION.3
@@ -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