diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2019-07-21 23:48:58 +0200 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2019-07-21 23:49:03 +0200 |
| commit | 3af0e76d1e71995b7790c74e79b76af86ee7c681 (patch) | |
| tree | b80190acaf03d83f5f408cc6da3ec1a9f831d8d3 /docs/libcurl/opts | |
| parent | 7644abf8e8101910ed86ab2869b7cc4031b27720 (diff) | |
HTTP3: initial (experimental) support
USe configure --with-ngtcp2 or --with-quiche
Using either option will enable a HTTP3 build.
Co-authored-by: Alessandro Ghedini <alessandro@ghedini.me>
Closes #3500
Diffstat (limited to 'docs/libcurl/opts')
| -rw-r--r-- | docs/libcurl/opts/CURLOPT_H3.3 | 61 | ||||
| -rw-r--r-- | docs/libcurl/opts/Makefile.inc | 1 |
2 files changed, 62 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLOPT_H3.3 b/docs/libcurl/opts/CURLOPT_H3.3 new file mode 100644 index 000000000..be521b6bf --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_H3.3 @@ -0,0 +1,61 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_H3 3 "27 Nov 2018" "libcurl 7.66.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_H3 \- specify HTTP/3 protocol behavior +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_H3, long bitmask); +.SH EXPERIMENTAL +Warning: this feature is early code and is marked as experimental. It can only +be enabled by explicitly invoking configure with \fB--with-quiche\fP or +\fB--with-ngtcp2\fP. You are advised to not ship this feature used in +production before the experimental label is removed. +.SH DESCRIPTION +This function accepts a long \fIbitmask\fP with a set of flags set that +controls the HTTP/3 behavior for this transfer. +.IP "CURLH3_DIRECT" +If this bit is set in \fIbitmask\fP, the host name and port number given in +the URL will be used to connect to directly with QUIC and the port number then +being a UDP port number. +.SH DEFAULT +0 +.SH PROTOCOLS +HTTPS +.SH EXAMPLE +.nf +CURL *curl = curl_easy_init(); +if(curl) { + CURLcode ret; + curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/"); + curl_easy_setopt(curl, CURLOPT_H3, (long)CURLH3_DIRECT); + ret = curl_easy_perform(curl); +} +.fi +.SH AVAILABILITY +Added in 7.66.0 +.SH RETURN VALUE +Returns CURLE_OK if supported, an error otherwise. +.SH "SEE ALSO" +.BR CURLOPT_HTTP_VERSION "(3), " diff --git a/docs/libcurl/opts/Makefile.inc b/docs/libcurl/opts/Makefile.inc index c8e15a5ed..5460b2a57 100644 --- a/docs/libcurl/opts/Makefile.inc +++ b/docs/libcurl/opts/Makefile.inc @@ -150,6 +150,7 @@ man_MANS = \ CURLOPT_FTP_USE_EPSV.3 \ CURLOPT_FTP_USE_PRET.3 \ CURLOPT_GSSAPI_DELEGATION.3 \ + CURLOPT_H3.3 \ CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS.3 \ CURLOPT_HAPROXYPROTOCOL.3 \ CURLOPT_HEADER.3 \ |