Home Explore Help
Sign In
OWEALs
/
curl
mirror of https://github.com/curl/curl.git
2
0
Fork 0
Files Issues 8 Wiki
Tree: 8f48b5d783
Branches Tags
curl
/
docs
/
libcurl
/
opts
/
CURLOPT_SSL_ENABLE_ALPN.3

CURLOPT_SSL_ENABLE_ALPN.3 2.1 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455 
  1. .\" **************************************************************************
    2. 

  2. .\" *                                  _   _ ____  _
    3. 

  3. .\" *  Project                     ___| | | |  _ \| |
    4. 

  4. .\" *                             / __| | | | |_) | |
    5. 

  5. .\" *                            | (__| |_| |  _ <| |___
    6. 

  6. .\" *                             \___|\___/|_| \_\_____|
    7. 

  7. .\" *
    8. 

  8. .\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
    9. 

  9. .\" *
    10. 

  10. .\" * This software is licensed as described in the file COPYING, which
    11. 

  11. .\" * you should have received as part of this distribution. The terms
    12. 

  12. .\" * are also available at https://curl.se/docs/copyright.html.
    13. 

  13. .\" *
    14. 

  14. .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
    15. 

  15. .\" * copies of the Software, and permit persons to whom the Software is
    16. 

  16. .\" * furnished to do so, under the terms of the COPYING file.
    17. 

  17. .\" *
    18. 

  18. .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
    19. 

  19. .\" * KIND, either express or implied.
    20. 

  20. .\" *
    21. 

  21. .\" **************************************************************************
    22. 

  22. .\"
    23. 

  23. .TH CURLOPT_SSL_ENABLE_ALPN 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
    24. 

  24. .SH NAME
    25. 

  25. CURLOPT_SSL_ENABLE_ALPN \- Application Layer Protocol Negotiation
    26. 

  26. .SH SYNOPSIS
    27. 

  27. .nf
    28. 

  28. #include <curl/curl.h>
    29. 

  29. 

  30. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_ENABLE_ALPN, long npn);
    31. 

  31. .fi
    32. 

  32. .SH DESCRIPTION
    33. 

  33. Pass a long as parameter, 0 or 1 where 1 is for enable and 0 for disable. This
    34. 

  34. option enables/disables ALPN in the SSL handshake (if the SSL backend libcurl
    35. 

  35. is built to use supports it), which can be used to negotiate http2.
    36. 

  36. .SH DEFAULT
    37. 

  37. 1, enabled
    38. 

  38. .SH PROTOCOLS
    39. 

  39. HTTP
    40. 

  40. .SH EXAMPLE
    41. 

  41. .nf
    42. 

  42. CURL *curl = curl_easy_init();
    43. 

  43. if(curl) {
    44. 

  44.   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
    45. 

  45.   curl_easy_setopt(curl, CURLOPT_SSL_ENABLE_ALPN, 0L);
    46. 

  46.   ret = curl_easy_perform(curl);
    47. 

  47.   curl_easy_cleanup(curl);
    48. 

  48. }
    49. 

  49. .fi
    50. 

  50. .SH AVAILABILITY
    51. 

  51. Added in 7.36.0
    52. 

  52. .SH RETURN VALUE
    53. 

  53. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
    54. 

  54. .SH "SEE ALSO"
    55. 

  55. .BR CURLOPT_SSL_ENABLE_NPN "(3), " CURLOPT_SSL_OPTIONS "(3), "
    56.