docs/libcurl/opts/CURLOPT_SSL_ENABLE_ALPN.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_ENABLE_ALPN 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_SSL_ENABLE_ALPN \- enable ALPN
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_ENABLE_ALPN, long npn);
  31 .SH DESCRIPTION
  32 Pass a long as parameter, 0 or 1 where 1 is for enable and 0 for disable. This
  33 option enables/disables ALPN in the SSL handshake (if the SSL backend libcurl
  34 is built to use supports it), which can be used to negotiate http2.
  35 .SH DEFAULT
  36 1, enabled
  37 .SH PROTOCOLS
  38 HTTP
  39 .SH EXAMPLE
  40 .nf
  41 CURL *curl = curl_easy_init();
  42 if(curl) {
  43   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  44   curl_easy_setopt(curl, CURLOPT_SSL_ENABLE_ALPN, 0L);
  45   ret = curl_easy_perform(curl);
  46   curl_easy_cleanup(curl);
  47 }
  48 .fi
  49 .SH AVAILABILITY
  50 Added in 7.36.0
  51 .SH RETURN VALUE
  52 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  53 .SH "SEE ALSO"
  54 .BR CURLOPT_SSL_ENABLE_NPN "(3), " CURLOPT_SSL_OPTIONS "(3), "