Return to CURLOPT_CLOSESOCKETFUNCTION.3 CVS log

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

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_CLOSESOCKETFUNCTION.3, revision 1.1.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_CLOSESOCKETFUNCTION 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_CLOSESOCKETFUNCTION \- callback to socket close replacement function
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: int closesocket_callback(void *clientp, curl_socket_t item);
                     31: 
                     32: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CLOSESOCKETFUNCTION, closesocket_callback);
                     33: .SH DESCRIPTION
                     34: Pass a pointer to your callback function, which should match the prototype
                     35: shown above.
                     36: 
                     37: This callback function gets called by libcurl instead of the \fIclose(3)\fP or
                     38: \fIclosesocket(3)\fP call when sockets are closed (not for any other file
                     39: descriptors). This is pretty much the reverse to the
                     40: \fICURLOPT_OPENSOCKETFUNCTION(3)\fP option. Return 0 to signal success and 1
                     41: if there was an error.
                     42: 
                     43: The \fIclientp\fP pointer is set with
                     44: \fICURLOPT_CLOSESOCKETDATA(3)\fP. \fIitem\fP is the socket libcurl wants to be
                     45: closed.
                     46: .SH DEFAULT
                     47: By default libcurl uses the standard socket close function.
                     48: .SH PROTOCOLS
                     49: All
                     50: .SH EXAMPLE
                     51: .nf
                     52: static int closesocket(void *clientp, curl_socket_t item)
                     53: {
                     54:   printf("libcurl wants to close %d now\\n", (int)item);
                     55:   return 0;
                     56: }
                     57: 
                     58: /* call this function to close sockets */
                     59: curl_easy_setopt(curl, CURLOPT_CLOSESOCKETFUNCTION, closesocket);
                     60: curl_easy_setopt(curl, CURLOPT_CLOSESOCKETDATA, &sockfd);
                     61: .fi
                     62: .SH AVAILABILITY
                     63: Added in 7.21.7
                     64: .SH RETURN VALUE
                     65: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
                     66: .SH "SEE ALSO"
                     67: .BR CURLOPT_CLOSESOCKETDATA "(3), " CURLOPT_OPENSOCKETFUNCTION "(3), "