Blame view

3rdparty/curl/share/man/man3/CURLOPT_OPENSOCKETDATA.3 2.98 KB
a86c63ca   Hu Chunming   提交三方库文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
  .\" **************************************************************************
  .\" *                                  _   _ ____  _
  .\" *  Project                     ___| | | |  _ \| |
  .\" *                             / __| | | | |_) | |
  .\" *                            | (__| |_| |  _ <| |___
  .\" *                             \___|\___/|_| \_\_____|
  .\" *
  .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
  .\" *
  .\" * This software is licensed as described in the file COPYING, which
  .\" * you should have received as part of this distribution. The terms
  .\" * are also available at https://curl.se/docs/copyright.html.
  .\" *
  .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  .\" * copies of the Software, and permit persons to whom the Software is
  .\" * furnished to do so, under the terms of the COPYING file.
  .\" *
  .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  .\" * KIND, either express or implied.
  .\" *
  .\" **************************************************************************
  .\"
  .TH CURLOPT_OPENSOCKETDATA 3 "November 04, 2020" "libcurl 7.77.0" "curl_easy_setopt options"
  
  .SH NAME
  CURLOPT_OPENSOCKETDATA \- custom pointer passed to open socket callback
  .SH SYNOPSIS
  #include <curl/curl.h>
  
  CURLcode curl_easy_setopt(CURL *handle, CURLOPT_OPENSOCKETDATA, void *pointer);
  .SH DESCRIPTION
  Pass a \fIpointer\fP that will be untouched by libcurl and passed as the first
  argument in the opensocket callback set with \fICURLOPT_OPENSOCKETFUNCTION(3)\fP.
  .SH DEFAULT
  The default value of this parameter is NULL.
  .SH PROTOCOLS
  All
  .SH EXAMPLE
  .nf
  /* make libcurl use the already established socket 'sockfd' */
  
  static curl_socket_t opensocket(void *clientp,
                                  curlsocktype purpose,
                                  struct curl_sockaddr *address)
  {
    curl_socket_t sockfd;
    sockfd = *(curl_socket_t *)clientp;
    /* the actual externally set socket is passed in via the OPENSOCKETDATA
       option */
    return sockfd;
  }
  
  static int sockopt_callback(void *clientp, curl_socket_t curlfd,
                              curlsocktype purpose)
  {
    /* This return code was added in libcurl 7.21.5 */
    return CURL_SOCKOPT_ALREADY_CONNECTED;
  }
  
  curl = curl_easy_init();
  if(curl) {
    /* libcurl will internally think that you connect to the host
     * and port that you specify in the URL option. */
    curl_easy_setopt(curl, CURLOPT_URL, "http://99.99.99.99:9999");
    /* call this function to get a socket */
    curl_easy_setopt(curl, CURLOPT_OPENSOCKETFUNCTION, opensocket);
    curl_easy_setopt(curl, CURLOPT_OPENSOCKETDATA, &sockfd);
  
    /* call this function to set options for the socket */
    curl_easy_setopt(curl, CURLOPT_SOCKOPTFUNCTION, sockopt_callback);
  
    res = curl_easy_perform(curl);
  
    curl_easy_cleanup(curl);
  }
  .fi
  .SH AVAILABILITY
  Added in 7.17.1
  .SH RETURN VALUE
  Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  .SH "SEE ALSO"
  .BR CURLOPT_OPENSOCKETFUNCTION "(3), " CURLOPT_SOCKOPTFUNCTION "(3), "