diff options
author | Loïc Hoguin <[email protected]> | 2024-01-29 15:40:26 +0100 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2024-01-29 15:40:26 +0100 |
commit | 2368dc53d0c724f1899aeb2874ba1a763e11f0b8 (patch) | |
tree | 37343cf8386eb4b02a096ac507b2208d84b07b43 /docs/en/cowboy/2.5/guide/listeners/index.html | |
parent | c4b13de35093b72a84c8782c0e8b0461d4aeaa13 (diff) | |
download | ninenines.eu-2368dc53d0c724f1899aeb2874ba1a763e11f0b8.tar.gz ninenines.eu-2368dc53d0c724f1899aeb2874ba1a763e11f0b8.tar.bz2 ninenines.eu-2368dc53d0c724f1899aeb2874ba1a763e11f0b8.zip |
Cowboy 2.11
Diffstat (limited to 'docs/en/cowboy/2.5/guide/listeners/index.html')
-rw-r--r-- | docs/en/cowboy/2.5/guide/listeners/index.html | 234 |
1 files changed, 0 insertions, 234 deletions
diff --git a/docs/en/cowboy/2.5/guide/listeners/index.html b/docs/en/cowboy/2.5/guide/listeners/index.html deleted file mode 100644 index 2c70d01d..00000000 --- a/docs/en/cowboy/2.5/guide/listeners/index.html +++ /dev/null @@ -1,234 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - -<head> - <meta charset="utf-8"> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <meta name="description" content=""> - <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> - - <title>Nine Nines: Listeners</title> - - <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> - <link href="/css/99s.css?r=7" rel="stylesheet"> - - <link rel="shortcut icon" href="/img/ico/favicon.ico"> - <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> - <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> - <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> - - </head> - - -<body class=""> - <header id="page-head"> - <div id="topbar" class="container"> - <div class="row"> - <div class="span2"> - <h1 id="logo"><a href="/" title="99s">99s</a></h1> - </div> - <div class="span10"> - - <div id="side-header"> - <nav> - <ul> - <li><a title="Hear my thoughts" href="/articles">Articles</a></li> - <li><a title="Watch my talks" href="/talks">Talks</a></li> - <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> - <li><a title="Request my services" href="/services">Consulting & Training</a></li> - </ul> - </nav> - <ul id="social"> - <li> - <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> - </li> - <li> - <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> - </li> - </ul> - </div> - </div> - </div> - </div> - - -</header> - -<div id="contents" class="two_col"> -<div class="container"> -<div class="row"> -<div id="docs" class="span9 maincol"> - -<h1 class="lined-header"><span>Listeners</span></h1> - -<p>A listener is a set of processes that listens on a port for new connections. Incoming connections get handled by Cowboy. Depending on the connection handshake, one or another protocol may be used.</p> -<p>This chapter is specific to Cowboy. Please refer to the <a href="https://ninenines.eu/docs/en/ranch/1.3/guide/listeners/">Ranch User Guide</a> for more information about listeners.</p> -<p>Cowboy provides two types of listeners: one listening for clear TCP connections, and one listening for secure TLS connections. Both of them support the HTTP/1.1 and HTTP/2 protocols.</p> -<h2 id="_clear_tcp_listener">Clear TCP listener</h2> -<p>The clear TCP listener will accept connections on the given port. A typical HTTP server would listen on port 80. Port 80 requires special permissions on most platforms however so a common alternative is port 8080.</p> -<p>The following snippet starts listening for connections on port 8080:</p> -<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 -by Lorenzo Bettini -http://www.lorenzobettini.it -http://www.gnu.org/software/src-highlite --> -<pre><tt><b><font color="#000000">start</font></b>(<font color="#009900">_Type</font>, <font color="#009900">_Args</font>) <font color="#990000">-></font> - <font color="#009900">Dispatch</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_router:compile</font></b>([ - {<font color="#FF6600">'_'</font>, [{<font color="#FF0000">"/"</font>, <font color="#FF6600">hello_handler</font>, []}]} - ]), - {<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy:start_clear</font></b>(<font color="#FF6600">my_http_listener</font>, - [{<font color="#FF6600">port</font>, <font color="#993399">8080</font>}], - #{<font color="#0000FF">env</font> <font color="#990000">=></font> #{<font color="#0000FF">dispatch</font> <font color="#990000">=></font> <font color="#009900">Dispatch</font>}} - ), - <b><font color="#000000">hello_erlang_sup:start_link</font></b>()<font color="#990000">.</font></tt></pre> -</div></div> -<p>The <a href="../getting_started">Getting Started</a> chapter uses a clear TCP listener.</p> -<p>Clients connecting to Cowboy on the clear listener port are expected to use either HTTP/1.1 or HTTP/2.</p> -<p>Cowboy supports both methods of initiating a clear HTTP/2 connection: through the Upgrade mechanism (<a href="https://tools.ietf.org/html/rfc7540#section-3.2">RFC 7540 3.2</a>) or by sending the preface directly (<a href="https://tools.ietf.org/html/rfc7540#section-3.4">RFC 7540 3.4</a>).</p> -<p>Compatibility with HTTP/1.0 is provided by Cowboy's HTTP/1.1 implementation.</p> -<h2 id="_secure_tls_listener">Secure TLS listener</h2> -<p>The secure TLS listener will accept connections on the given port. A typical HTTPS server would listen on port 443. Port 443 requires special permissions on most platforms however so a common alternative is port 8443.</p> -<!-- @todo Make a complete list of restrictions.--> -<p>The function provided by Cowboy will ensure that the TLS options given are following the HTTP/2 RFC with regards to security. For example some TLS extensions or ciphers may be disabled. This also applies to HTTP/1.1 connections on this listener. If this is not desirable, Ranch can be used directly to setup a custom listener.</p> -<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 -by Lorenzo Bettini -http://www.lorenzobettini.it -http://www.gnu.org/software/src-highlite --> -<pre><tt><b><font color="#000000">start</font></b>(<font color="#009900">_Type</font>, <font color="#009900">_Args</font>) <font color="#990000">-></font> - <font color="#009900">Dispatch</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_router:compile</font></b>([ - {<font color="#FF6600">'_'</font>, [{<font color="#FF0000">"/"</font>, <font color="#FF6600">hello_handler</font>, []}]} - ]), - {<font color="#FF6600">ok</font>, <font color="#990000">_</font>} <font color="#990000">=</font> <b><font color="#000000">cowboy:start_tls</font></b>(<font color="#FF6600">my_http_listener</font>, - [ - {<font color="#FF6600">port</font>, <font color="#993399">8443</font>}, - {<font color="#FF6600">certfile</font>, <font color="#FF0000">"/path/to/certfile"</font>}, - {<font color="#FF6600">keyfile</font>, <font color="#FF0000">"/path/to/keyfile"</font>} - ], - #{<font color="#0000FF">env</font> <font color="#990000">=></font> #{<font color="#0000FF">dispatch</font> <font color="#990000">=></font> <font color="#009900">Dispatch</font>}} - ), - <b><font color="#000000">hello_erlang_sup:start_link</font></b>()<font color="#990000">.</font></tt></pre> -</div></div> -<p>Clients connecting to Cowboy on the secure listener are expected to use the ALPN TLS extension to indicate what protocols they understand. Cowboy always prefers HTTP/2 over HTTP/1.1 when both are supported. When neither are supported by the client, or when the ALPN extension was missing, Cowboy expects HTTP/1.1 to be used.</p> -<p>Cowboy also advertises HTTP/2 support through the older NPN TLS extension for compatibility. Note however that this support will likely not be enabled by default when Cowboy 2.0 gets released.</p> -<p>Compatibility with HTTP/1.0 is provided by Cowboy's HTTP/1.1 implementation.</p> -<h2 id="_protocol_configuration">Protocol configuration</h2> -<p>The HTTP/1.1 and HTTP/2 protocols share the same semantics; only their framing differs. The first is a text protocol and the second a binary protocol.</p> -<p>Cowboy doesn't separate the configuration for HTTP/1.1 and HTTP/2. Everything goes into the same map. Many options are shared.</p> -<!-- @todo Describe good to know options for both protocols?--> -<!-- Maybe do that in separate chapters?--> - - - - - - - - - - - - <nav style="margin:1em 0"> - - <a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.5/guide/flow_diagram/"> - Flow diagram - </a> - - - - <a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.5/guide/routing/"> - Routing - </a> - - </nav> - - - - -</div> - -<div class="span3 sidecol"> - - -<h3> - Cowboy - 2.5 - - User Guide -</h3> - -<ul> - - <li><a href="/docs/en/cowboy/2.5/guide">User Guide</a></li> - - - <li><a href="/docs/en/cowboy/2.5/manual">Function Reference</a></li> - - -</ul> - -<h4 id="docs-nav">Navigation</h4> - -<h4>Version select</h4> -<ul> - - - - <li><a href="/docs/en/cowboy/2.10/guide">2.10</a></li> - - <li><a href="/docs/en/cowboy/2.9/guide">2.9</a></li> - - <li><a href="/docs/en/cowboy/2.8/guide">2.8</a></li> - - <li><a href="/docs/en/cowboy/2.7/guide">2.7</a></li> - - <li><a href="/docs/en/cowboy/2.6/guide">2.6</a></li> - - <li><a href="/docs/en/cowboy/2.5/guide">2.5</a></li> - -</ul> - -<h3 id="_like_my_work__donate">Like my work? Donate!</h3> -<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> -<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> -<input type="hidden" name="cmd" value="_donations"> -<input type="hidden" name="business" value="[email protected]"> -<input type="hidden" name="lc" value="FR"> -<input type="hidden" name="item_name" value="Loic Hoguin"> -<input type="hidden" name="item_number" value="99s"> -<input type="hidden" name="currency_code" value="EUR"> -<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> -<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> -<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> -</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> - - - -</div> -</div> -</div> -</div> - - <footer> - <div class="container"> - <div class="row"> - <div class="span6"> - <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> - <nav> - <ul> - <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> - </ul> - </nav> - </div> - <div class="span6 credits"> - <p><img src="/img/footer_logo.png"></p> - <p>Copyright © Loïc Hoguin 2012-2018</p> - </div> - </div> - </div> - </footer> - - - <script src="/js/custom.js"></script> - </body> -</html> - - |