docs/libcurl/opts/CURLOPT_SSL_FALSESTART.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_SSL_FALSESTART 3 "May 15, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_SSL_FALSESTART \- enable TLS false start
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_FALSESTART, long enable);
  31 .SH DESCRIPTION
  32 Pass a long as parameter set to 1L to enable or 0 to disable.
  33
  34 This option determines whether libcurl should use false start during the TLS
  35 handshake. False start is a mode where a TLS client will start sending
  36 application data before verifying the server's Finished message, thus saving a
  37 round trip when performing a full handshake.
  38 .SH DEFAULT
  39 0
  40 .SH PROTOCOLS
  41 All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  42 .SH EXAMPLE
  43 .nf
  44 CURL *curl = curl_easy_init();
  45 if(curl) {
  46   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  47   curl_easy_setopt(curl, CURLOPT_SSL_FALSESTART, 1L);
  48   curl_easy_perform(curl);
  49 }
  50 .fi
  51 .SH AVAILABILITY
  52 Added in 7.42.0. This option is currently only supported by the NSS and
  53 Secure Transport (on iOS 7.0 or later, or OS X 10.9 or later) TLS backends.
  54 .SH RETURN VALUE
  55 Returns CURLE_OK if false start is supported by the SSL backend, otherwise
  56 returns CURLE_NOT_BUILT_IN.