Return to CURLINFO_LASTSOCKET.3 CVS log

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

Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_LASTSOCKET.3, revision 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_LASTSOCKET 3 "May 06, 2017" "libcurl 7.70.0" "curl_easy_getinfo options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLINFO_LASTSOCKET \- get the last socket used
        !            27: .SH SYNOPSIS
        !            28: #include <curl/curl.h>
        !            29: 
        !            30: CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_LASTSOCKET, long *socket);
        !            31: .SH DESCRIPTION
        !            32: Deprecated since 7.45.0. Use \fICURLINFO_ACTIVESOCKET(3)\fP instead.
        !            33: 
        !            34: Pass a pointer to a long to receive the last socket used by this curl
        !            35: session. If the socket is no longer valid, -1 is returned. When you finish
        !            36: working with the socket, you must call curl_easy_cleanup() as usual and let
        !            37: libcurl close the socket and cleanup other resources associated with the
        !            38: handle. This is typically used in combination with
        !            39: \fICURLOPT_CONNECT_ONLY(3)\fP.
        !            40: 
        !            41: NOTE: this API is deprecated since it is not working on win64 where the SOCKET
        !            42: type is 64 bits large while its 'long' is 32 bits. Use the
        !            43: \fICURLINFO_ACTIVESOCKET(3)\fP instead, if possible.
        !            44: .SH PROTOCOLS
        !            45: All
        !            46: .SH EXAMPLE
        !            47: .nf
        !            48: CURL *curl = curl_easy_init();
        !            49: if(curl) {
        !            50:   long sockfd; /* doesn't work on win64! */
        !            51:   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
        !            52: 
        !            53:   /* Do not do the transfer - only connect to host */
        !            54:   curl_easy_setopt(curl, CURLOPT_CONNECT_ONLY, 1L);
        !            55:   res = curl_easy_perform(curl);
        !            56: 
        !            57:   /* Extract the socket from the curl handle */
        !            58:   res = curl_easy_getinfo(curl, CURLINFO_LASTSOCKET, &sockfd);
        !            59: 
        !            60:   if(res != CURLE_OK) {
        !            61:     printf("Error: %s\\n", curl_easy_strerror(res));
        !            62:     return 1;
        !            63:   }
        !            64: }
        !            65: .fi
        !            66: .SH AVAILABILITY
        !            67: Added in 7.15.2
        !            68: .SH RETURN VALUE
        !            69: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
        !            70: .SH "SEE ALSO"
        !            71: .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
        !            72: .BR CURLINFO_ACTIVESOCKET "(3), "