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