docs/libcurl/opts/CURLOPT_SSL_FALSESTART.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2015, 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_SSL_FALSESTART 3 "14 Feb 2015" "libcurl 7.41.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_SSL_FALSESTART \- enable TLS false start
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_FALSESTART, long enable);
  30 .SH DESCRIPTION
  31 Pass a long as parameter set to 1 to enable or 0 to disable.
  32
  33 This option determines whether libcurl should use false start during the TLS
  34 handshake. False start is a mode where a TLS client will start sending
  35 application data before verifying the server's Finished message, thus saving a
  36 round trip when performing a full handshake.
  37 .SH DEFAULT
  38 0
  39 .SH PROTOCOLS
  40 All TLS based protocols: HTTPS, FTPS, IMAPS, POP3, SMTPS etc.
  41 .SH EXAMPLE
  42 TODO
  43 .SH AVAILABILITY
  44 Added in 7.42.0. This option is currently only supported by the NSS and
  45 Secure Transport (on iOS 7.0 or later, or OS X 10.9 or later) TLS backends.
  46 .SH RETURN VALUE
  47 Returns CURLE_OK if false start is supported by the SSL backend, otherwise
  48 returns CURLE_NOT_BUILT_IN.