Blame view

3rdparty/curl/share/man/man3/CURLOPT_ALTSVC_CTRL.3 3.35 KB
a86c63ca   Hu Chunming   提交三方库文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
  .\" **************************************************************************
  .\" *                                  _   _ ____  _
  .\" *  Project                     ___| | | |  _ \| |
  .\" *                             / __| | | | |_) | |
  .\" *                            | (__| |_| |  _ <| |___
  .\" *                             \___|\___/|_| \_\_____|
  .\" *
  .\" * Copyright (C) 1998 - 2020, 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.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_ALTSVC_CTRL 3 "November 04, 2020" "libcurl 7.77.0" "curl_easy_setopt options"
  
  .SH NAME
  CURLOPT_ALTSVC_CTRL \- control alt-svc behavior
  .SH SYNOPSIS
  .nf
  #include <curl/curl.h>
  
  #define CURLALTSVC_READONLYFILE (1<<2)
  #define CURLALTSVC_H1           (1<<3)
  #define CURLALTSVC_H2           (1<<4)
  #define CURLALTSVC_H3           (1<<5)
  
  CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ALTSVC_CTRL, long bitmask);
  .fi
  .SH DESCRIPTION
  Populate the long \fIbitmask\fP with the correct set of features to instruct
  libcurl how to handle Alt-Svc for the transfers using this handle.
  
  libcurl will only accept Alt-Svc headers over a secure transport, meaning
  HTTPS. It will also only complete a request to an alternative origin if that
  origin is properly hosted over HTTPS. These requirements are there to make
  sure both the source and the destination are legitimate.
  
  Setting any bit will enable the alt-svc engine.
  .IP "CURLALTSVC_READONLYFILE"
  Do not write the alt-svc cache back to the file specified with
  \fICURLOPT_ALTSVC(3)\fP even if it gets updated. By default a file specified
  with that option will be read and written to as deemed necessary.
  .IP "CURLALTSVC_H1"
  Accept alternative services offered over HTTP/1.1.
  .IP "CURLALTSVC_H2"
  Accept alternative services offered over HTTP/2. This will only be used if
  libcurl was also built to actually support HTTP/2, otherwise this bit will be
  ignored.
  .IP "CURLALTSVC_H3"
  Accept alternative services offered over HTTP/3. This will only be used if
  libcurl was also built to actually support HTTP/3, otherwise this bit will be
  ignored.
  .SH DEFAULT
  Alt-Svc handling is disabled by default. If \fICURLOPT_ALTSVC(3)\fP is set,
  \fICURLOPT_ALTSVC_CTRL(3)\fP has a default value corresponding to
  CURLALTSVC_H1 | CURLALTSVC_H2 | CURLALTSVC_H3 - the HTTP/2 and HTTP/3 bits are
  only set if libcurl was built with support for those versions.
  .SH PROTOCOLS
  HTTPS
  .SH EXAMPLE
  .nf
  CURL *curl = curl_easy_init();
  if(curl) {
    curl_easy_setopt(curl, CURLOPT_ALTSVC_CTRL, CURLALTSVC_H1);
    curl_easy_setopt(curl, CURLOPT_ALTSVC, "altsvc-cache.txt");
    curl_easy_perform(curl);
  }
  .fi
  .SH AVAILABILITY
  Added in 7.64.1
  .SH RETURN VALUE
  Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  .SH "SEE ALSO"
  .BR CURLOPT_ALTSVC "(3), " CURLOPT_CONNECT_TO "(3), " CURLOPT_RESOLVE "(3), "