docs/libcurl/opts/CURLINFO_ACTIVESOCKET.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
   9 .\" *
  10 .\" * This software is licensed as described in the file COPYING, which
  11 .\" * you should have received as part of this distribution. The terms
  12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
  13 .\" *
  14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15 .\" * copies of the Software, and permit persons to whom the Software is
  16 .\" * furnished to do so, under the terms of the COPYING file.
  17 .\" *
  18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19 .\" * KIND, either express or implied.
  20 .\" *
  21 .\" **************************************************************************
  22 .\"
  23 .TH CURLINFO_ACTIVESOCKET 3 "12 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
  24 .SH NAME
  25 CURLINFO_ACTIVESOCKET \- get the active socket
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_ACTIVESOCKET,
  30                            curl_socket_t *socket);
  31 .SH DESCRIPTION
  32 Pass a pointer to a curl_socket_t to receive the active socket used by this
  33 curl session. If the socket is no longer valid, \fICURL_SOCKET_BAD\fP is
  34 returned. When you finish working with the socket, you must call
  35 \fIcurl_easy_cleanup(3)\fP as usual on the easy handle and let libcurl close
  36 the socket and cleanup other resources associated with the handle. This is
  37 typically used in combination with \fICURLOPT_CONNECT_ONLY(3)\fP.
  38
  39 This option was added as a replacement for \fICURLINFO_LASTSOCKET(3)\fP since
  40 that one isn't working on all platforms.
  41 .SH PROTOCOLS
  42 All
  43 .SH EXAMPLE
  44 TODO
  45 .SH AVAILABILITY
  46 Added in 7.45.0
  47 .SH RETURN VALUE
  48 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  49 .SH "SEE ALSO"
  50 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
  51 .BR CURLINFO_LASTSOCKET "(3), "