From 46a886cd4880a2b4ab45c856b4695eaf3328431f Mon Sep 17 00:00:00 2001 From: Dan Fandrich Date: Tue, 1 Jul 2014 07:59:28 +0200 Subject: opts: Document the socket callback function parameters --- docs/libcurl/opts/CURLOPT_OPENSOCKETFUNCTION.3 | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs/libcurl/opts/CURLOPT_OPENSOCKETFUNCTION.3') 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 -- cgit v1.2.3