mirror of
https://github.com/curl/curl.git
synced 2026-07-04 23:47:21 +03:00
eefcc1bda4
curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
75 lines
1.4 KiB
Markdown
75 lines
1.4 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_CLOSESOCKETDATA
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLOPT_CLOSESOCKETFUNCTION (3)
|
|
- CURLOPT_OPENSOCKETFUNCTION (3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_CLOSESOCKETDATA - pointer passed to the socket close callback
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CLOSESOCKETDATA,
|
|
void *pointer);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Pass a *pointer* that remains untouched by libcurl and passed as the first
|
|
argument in the closesocket callback set with
|
|
CURLOPT_CLOSESOCKETFUNCTION(3).
|
|
|
|
# DEFAULT
|
|
|
|
The default value of this parameter is NULL.
|
|
|
|
# PROTOCOLS
|
|
|
|
All except file:
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
struct priv {
|
|
void *custom;
|
|
};
|
|
|
|
static int closesocket(void *clientp, curl_socket_t item)
|
|
{
|
|
struct priv *my = clientp;
|
|
printf("our ptr: %p\n", my->custom);
|
|
|
|
printf("libcurl wants to close %d now\n", (int)item);
|
|
return 0;
|
|
}
|
|
|
|
int main(void)
|
|
{
|
|
struct priv myown;
|
|
CURL *curl = curl_easy_init();
|
|
|
|
/* call this function to close sockets */
|
|
curl_easy_setopt(curl, CURLOPT_CLOSESOCKETFUNCTION, closesocket);
|
|
curl_easy_setopt(curl, CURLOPT_CLOSESOCKETDATA, &myown);
|
|
|
|
curl_easy_perform(curl);
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
Added in 7.21.7
|
|
|
|
# RETURN VALUE
|
|
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|