Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_EXPECT_100_TIMEOUT_MS.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2017, 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_EXPECT_100_TIMEOUT_MS 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
24
25 .SH NAME
26 CURLOPT_EXPECT_100_TIMEOUT_MS \- timeout for Expect: 100-continue response
27 .SH SYNOPSIS
28 .nf
29 #include <curl/curl.h>
30
31 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_EXPECT_100_TIMEOUT_MS,
32                           long milliseconds);
33 .SH DESCRIPTION
34 Pass a long to tell libcurl the number of \fImilliseconds\fP to wait for a
35 server response with the HTTP status 100 (Continue), 417 (Expectation Failed)
36 or similar after sending a HTTP request containing an Expect: 100-continue
37 header. If this times out before a response is received, the request body is
38 sent anyway.
39 .SH DEFAULT
40 1000 milliseconds
41 .SH PROTOCOLS
42 HTTP
43 .SH EXAMPLE
44 .nf
45 CURL *curl = curl_easy_init();
46 if(curl) {
47   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
48
49   /* wait 3 seconds for 100-continue */
50   curl_easy_setopt(curl, CURLOPT_EXPECT_100_TIMEOUT_MS, 3000L);
51
52   curl_easy_perform(curl);
53 }
54 .fi
55 .SH AVAILABILITY
56 Added in 7.36.0
57 .SH RETURN VALUE
58 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
59 .SH "SEE ALSO"
60 .BR CURLOPT_POST "(3), " CURLOPT_HTTPPOST "(3), "