summaryrefslogblamecommitdiffstats
path: root/docs/en/cowboy/2.7/manual/cowboy/index.html
blob: d026c025563a48e47390c7dbdf8cbb30ff46e3de (plain) (tree) 
49005631









8459bebc

49005631


53a79df4

49005631

















































8459bebc

49005631


8459bebc

49005631

8459bebc














49005631



8459bebc








49005631

8459bebc




49005631



8459bebc

49005631

8459bebc





























49005631

8459bebc

49005631












8459bebc

49005631







8459bebc

49005631

8459bebc


49005631











48f39402


849fab72


8459bebc








49005631














519eb0a3

49005631

































1
2
3
4
5
6
7
8
9

10

11
12

13

14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

63

64
65

66

67

68
69
70
71
72
73
74
75
76
77
78
79
80
81

82
83
84

85
86
87
88
89
90
91
92

93

94
95
96
97

98
99
100

101

102

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

132

133

134
135
136
137
138
139
140
141
142
143
144
145

146

147
148
149
150
151
152
153

154

155

156
157

158
159
160
161
162
163
164
165
166
167
168

169
170

171
172

173
174
175
176
177
178
179
180

181
182
183
184
185
186
187
188
189
190
191
192
193
194

195

196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228









                                                                                           
                                        

                                                                                                                      
                                                   
















































                                                                                                                                                                                   
                                                    

                        
                           
                                      













                                                                                                          


                                            







                                                                                                                                                            
            



                                                                                                                                                                                


                                            
                                                                                                                                                                                                                                      
            




























                                                                                                                                                                                                                                
                                
                                                                  











                           
              






                          
                                                                           
        

                                                                                    










                                 

                                                                     

                                                                     







                                                                     













                                                                                                                                                                   
                                                                                                                                                                                                                                  
































                                                                                                                                                                                                                           
<!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: cowboy(3)</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>cowboy(3)</span></h1>

<h2 id="_name">Name</h2>
<p>cowboy - HTTP server</p>
<h2 id="_description">Description</h2>
<p>The module <code>cowboy</code> provides convenience functions for manipulating Ranch listeners.</p>
<h2 id="_exports">Exports</h2>
<ul><li><a href="../cowboy.start_clear">cowboy:start_clear(3)</a> - Listen for connections using plain TCP
</li>
<li><a href="../cowboy.start_tls">cowboy:start_tls(3)</a> - Listen for connections using TLS
</li>
<li><a href="../cowboy.stop_listener">cowboy:stop_listener(3)</a> - Stop the given listener
</li>
<li><a href="../cowboy.set_env">cowboy:set_env(3)</a> - Update a listener&apos;s environment value
</li>
</ul>
<h2 id="_types">Types</h2>
<h3 id="_fields">fields()</h3>
<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">fields</font></b>() <font color="#990000">::</font> [<font color="#009900">Name</font>
           | {<font color="#009900">Name</font>, <font color="#009900">Constraints</font>}
           | {<font color="#009900">Name</font>, <font color="#009900">Constraints</font>, <font color="#009900">Default</font>}]

<font color="#009900">Name</font>        <font color="#990000">::</font> <b><font color="#000080">atom</font></b>()
<font color="#009900">Constraints</font> <font color="#990000">::</font> <font color="#009900">Constraint</font> | [<font color="#009900">Constraint</font>]
<font color="#009900">Constraint</font>  <font color="#990000">::</font> <b><font color="#000000">cowboy_constraints:constraint</font></b>()
<font color="#009900">Default</font>     <font color="#990000">::</font> <b><font color="#000000">any</font></b>()</tt></pre>
</div></div>
<p>Fields description for match operations.</p>
<p>This type is used in <a href="../cowboy_router">cowboy_router(3)</a> for matching bindings and in the match functions found in <a href="../cowboy_req">cowboy_req(3)</a>.</p>
<h3 id="_http_headers">http_headers()</h3>
<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">http_headers</font></b>() <font color="#990000">::</font> #{<b><font color="#000080">binary</font></b>() <font color="#990000">=&gt;</font> <b><font color="#000000">iodata</font></b>()}</tt></pre>
</div></div>
<p>HTTP headers.</p>
<h3 id="_http_status">http_status()</h3>
<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">http_status</font></b>() <font color="#990000">::</font> <b><font color="#000000">non_neg_integer</font></b>() | <b><font color="#000080">binary</font></b>()</tt></pre>
</div></div>
<p>HTTP response status.</p>
<p>A binary status can be used to set a reason phrase. Note however that HTTP/2 only sends the status code and drops the reason phrase entirely.</p>
<h3 id="_http_version">http_version()</h3>
<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">http_version</font></b>() <font color="#990000">::</font> <font color="#FF6600">'HTTP/2'</font> | <font color="#FF6600">'HTTP/1.1'</font> | <font color="#FF6600">'HTTP/1.0'</font></tt></pre>
</div></div>
<p>HTTP version.</p>
<p>Note that semantically, HTTP/1.1 and HTTP/2 are equivalent.</p>
<h3 id="_opts">opts()</h3>
<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">opts</font></b>() <font color="#990000">::</font> <b><font color="#000000">map</font></b>()</tt></pre>
</div></div>
<p>Options for the HTTP/1.1, HTTP/2 and Websocket protocols.</p>
<p>The protocol options are in a map containing all the options for the different protocols that may be involved when connecting to the listener, including HTTP/1.1 and HTTP/2.</p>
<p>The HTTP/1.1 options are documented in the <a href="../cowboy_http">cowboy_http(3)</a> manual and the HTTP/2 options in <a href="../cowboy_http2">cowboy_http2(3)</a>.</p>
<h2 id="_see_also">See also</h2>
<p><a href="..">cowboy(7)</a>, <a href="../ranch">ranch(3)</a></p>






</div>

<div class="span3 sidecol">


<h3>
	Cowboy
	2.7
	Function Reference
	
</h3>

<ul>
	
		<li><a href="/docs/en/cowboy/2.7/guide">User Guide</a></li>
	
	
		<li><a href="/docs/en/cowboy/2.7/manual">Function Reference</a></li>
	
	
</ul>

<h4 id="docs-nav">Navigation</h4>

<h4>Version select</h4>
<ul>
	
	
	
		<li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li>
	
		<li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li>
	
		<li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li>
	
		<li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li>
	
		<li><a href="/docs/en/cowboy/2.5/manual">2.5</a></li>
	
		<li><a href="/docs/en/cowboy/2.4/manual">2.4</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 &copy; Loïc Hoguin 2012-2018</p>
            </div>
          </div>
        </div>
      </footer>

    
    <script src="/js/custom.js"></script>
  </body>
</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-18 16:06:23 +0000