Return to CURLOPT_CLOSESOCKETDATA.3 CVS log

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

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_CLOSESOCKETDATA.3, revision 1.1

1.1     ! misho       1: .\" **************************************************************************
        !             2: .\" *                                  _   _ ____  _
        !             3: .\" *  Project                     ___| | | |  _ \| |
        !             4: .\" *                             / __| | | | |_) | |
        !             5: .\" *                            | (__| |_| |  _ <| |___
        !             6: .\" *                             \___|\___/|_| \_\_____|
        !             7: .\" *
        !             8: .\" * Copyright (C) 1998 - 2020, 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 CURLOPT_CLOSESOCKETDATA 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLOPT_CLOSESOCKETDATA \- pointer passed to the socket close callback
        !            27: .SH SYNOPSIS
        !            28: #include <curl/curl.h>
        !            29: 
        !            30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CLOSESOCKETDATA, void *pointer);
        !            31: .SH DESCRIPTION
        !            32: Pass a \fIpointer\fP that will be untouched by libcurl and passed as the first
        !            33: argument in the closesocket callback set with
        !            34: \fICURLOPT_CLOSESOCKETFUNCTION(3)\fP.
        !            35: .SH DEFAULT
        !            36: The default value of this parameter is NULL.
        !            37: .SH PROTOCOLS
        !            38: All except file:
        !            39: .SH EXAMPLE
        !            40: .nf
        !            41: static int closesocket(void *clientp, curl_socket_t item)
        !            42: {
        !            43:   printf("libcurl wants to close %d now\\n", (int)item);
        !            44:   return 0;
        !            45: }
        !            46: 
        !            47: /* call this function to close sockets */
        !            48: curl_easy_setopt(curl, CURLOPT_CLOSESOCKETFUNCTION, closesocket);
        !            49: curl_easy_setopt(curl, CURLOPT_CLOSESOCKETDATA, &sockfd);
        !            50: .fi
        !            51: .SH AVAILABILITY
        !            52: Added in 7.21.7
        !            53: .SH RETURN VALUE
        !            54: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
        !            55: .SH "SEE ALSO"
        !            56: .BR CURLOPT_CLOSESOCKETFUNCTION "(3), " CURLOPT_OPENSOCKETFUNCTION "(3), "