CURLOPT_SSL_ENABLE_NPN.3 2.0 KB

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