CURLOPT_SSL_ENABLE_ALPN.3 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 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.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. .\" * SPDX-License-Identifier: curl
  22. .\" *
  23. .\" **************************************************************************
  24. .\"
  25. .TH CURLOPT_SSL_ENABLE_ALPN 3 "19 Jun 2014" libcurl libcurl
  26. .SH NAME
  27. CURLOPT_SSL_ENABLE_ALPN \- Application Layer Protocol Negotiation
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_ENABLE_ALPN, long npn);
  32. .fi
  33. .SH DESCRIPTION
  34. Pass a long as parameter, 0 or 1 where 1 is for enable and 0 for disable. This
  35. option enables/disables ALPN in the SSL handshake (if the SSL backend libcurl
  36. is built to use supports it), which can be used to negotiate http2.
  37. .SH DEFAULT
  38. 1, enabled
  39. .SH PROTOCOLS
  40. HTTP
  41. .SH EXAMPLE
  42. .nf
  43. CURL *curl = curl_easy_init();
  44. if(curl) {
  45. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  46. curl_easy_setopt(curl, CURLOPT_SSL_ENABLE_ALPN, 0L);
  47. ret = curl_easy_perform(curl);
  48. curl_easy_cleanup(curl);
  49. }
  50. .fi
  51. .SH AVAILABILITY
  52. Added in 7.36.0
  53. .SH RETURN VALUE
  54. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  55. .SH "SEE ALSO"
  56. .BR CURLOPT_SSL_ENABLE_NPN "(3), " CURLOPT_SSL_OPTIONS "(3), "