1caaf61e5539d3ed1e5369cdcfd75acf8204b46b
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_FRESH_CONNECT.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2014, 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 http://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_FRESH_CONNECT 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_FRESH_CONNECT \- force a new connection to be used
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FRESH_CONNECT, long fresh);
30 .SH DESCRIPTION
31 Pass a long. Set to 1 to make the next transfer use a new (fresh) connection
32 by force instead of trying to re-use an existing one.  This option should be
33 used with caution and only if you understand what it does as it may seriously
34 impact performance.
35
36 Related functionality is \fICURLOPT_FORBID_REUSE(3)\fP which makes sure the
37 connection is closed after use so that it won't be re-used.
38
39 Set \fIfresh\fP to 0 to have libcurl attempt re-using an existing connection
40 (default behavior).
41 .SH DEFAULT
42 0
43 .SH PROTOCOLS
44 Most
45 .SH EXAMPLE
46 TODO
47 .SH AVAILABILITY
48 Always
49 .SH RETURN VALUE
50 Returns CURLE_OK
51 .SH "SEE ALSO"
52 .BR CURLOPT_FORBID_REUSE "(3), "