Return to CURLINFO_ACTIVESOCKET.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_ACTIVESOCKET.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2017, 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 "May 06, 2017" "libcurl 7.70.0" "curl_easy_getinfo options"
                     24: 
                     25: .SH NAME
                     26: CURLINFO_ACTIVESOCKET \- get the active socket
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_ACTIVESOCKET,
                     31:                            curl_socket_t *socket);
                     32: .SH DESCRIPTION
                     33: Pass a pointer to a curl_socket_t to receive the active socket used by this
                     34: curl session. If the socket is no longer valid, \fICURL_SOCKET_BAD\fP is
                     35: returned. When you finish working with the socket, you must call
                     36: \fIcurl_easy_cleanup(3)\fP as usual on the easy handle and let libcurl close
                     37: the socket and cleanup other resources associated with the handle. This is
                     38: typically used in combination with \fICURLOPT_CONNECT_ONLY(3)\fP.
                     39: 
                     40: This option was added as a replacement for \fICURLINFO_LASTSOCKET(3)\fP since
                     41: that one isn't working on all platforms.
                     42: .SH PROTOCOLS
                     43: All
                     44: .SH EXAMPLE
                     45: .nf
                     46: CURL *curl = curl_easy_init();
                     47: if(curl) {
                     48:   curl_socket_t sockfd;
                     49:   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
                     50: 
                     51:   /* Do not do the transfer - only connect to host */
                     52:   curl_easy_setopt(curl, CURLOPT_CONNECT_ONLY, 1L);
                     53:   res = curl_easy_perform(curl);
                     54: 
                     55:   /* Extract the socket from the curl handle */
                     56:   res = curl_easy_getinfo(curl, CURLINFO_ACTIVESOCKET, &sockfd);
                     57: 
                     58:   if(res != CURLE_OK) {
                     59:     printf("Error: %s\\n", curl_easy_strerror(res));
                     60:     return 1;
                     61:   }
                     62: }
                     63: .fi
                     64: .SH AVAILABILITY
                     65: Added in 7.45.0
                     66: .SH RETURN VALUE
                     67: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
                     68: .SH "SEE ALSO"
                     69: .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
                     70: .BR CURLINFO_LASTSOCKET "(3), "