27fe1580287b20677fc1aa539ddee534fd038995
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_NOSIGNAL.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_NOSIGNAL 3 "16 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_NOSIGNAL \- skip all signal handling
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOSIGNAL, long onoff);
30 .SH DESCRIPTION
31 If \fIonoff\fP is 1, libcurl will not use any functions that install signal
32 handlers or any functions that cause signals to be sent to the process. This
33 option is here to allow multi-threaded unix applications to still set/use all
34 timeout options etc, without risking getting signals.
35
36 If this option is set and libcurl has been built with the standard name
37 resolver, timeouts will not occur while the name resolve takes place.
38 Consider building libcurl with the c-ares or threaded resolver backends to
39 enable asynchronous DNS lookups, to enable timeouts for name resolves without
40 the use of signals.
41
42 Setting \fICURLOPT_NOSIGNAL(3)\fP to 1 makes libcurl NOT ask the system to
43 ignore SIGPIPE signals, which otherwise are sent by the system when trying to
44 send data to a socket which is closed in the other end. libcurl makes an
45 effort to never cause such SIGPIPEs to trigger, but some operating systems
46 have no way to avoid them and even on those that have there are some corner
47 cases when they may still happen, contrary to our desire. In addition, using
48 \fICURLAUTH_NTLM_WB\fP authentication could cause a SIGCHLD signal to be
49 raised.
50 .SH DEFAULT
51 0
52 .SH AVAILABILITY
53 Added in 7.10
54 .SH RETURN VALUE
55 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.