Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_FORBID_REUSE.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_FORBID_REUSE 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
24
25 .SH NAME
26 CURLOPT_FORBID_REUSE \- make connection get closed at once after use
27 .SH SYNOPSIS
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FORBID_REUSE, long close);
31 .SH DESCRIPTION
32 Pass a long. Set \fIclose\fP to 1 to make libcurl explicitly close the
33 connection when done with the transfer. Normally, libcurl keeps all
34 connections alive when done with one transfer in case a succeeding one follows
35 that can re-use them.  This option should be used with caution and only if you
36 understand what it does as it can seriously impact performance.
37
38 Set to 0 to have libcurl keep the connection open for possible later re-use
39 (default behavior).
40 .SH DEFAULT
41 0
42 .SH PROTOCOLS
43 Most
44 .SH EXAMPLE
45 .nf
46 {
47   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
48   curl_easy_setopt(curl, CURLOPT_FORBID_REUSE, 1L);
49   curl_easy_perform(curl);
50
51   /* this second transfer may not reuse the same connection */
52   curl_easy_perform(curl);
53 }
54 .fi
55 .SH AVAILABILITY
56 Always
57 .SH RETURN VALUE
58 Returns CURLE_OK
59 .SH "SEE ALSO"
60 .BR CURLOPT_FRESH_CONNECT "(3), " CURLOPT_MAXCONNECTS "(3), "