summaryrefslogblamecommitdiffstats
path: root/docs/en/cowboy/2.3/manual/cowboy_handler/index.html
blob: 50b156f850c68e1ba50ce56eca53fef94737b47c (plain) (tree) 
d2a3f2ce









d2a3f2ce



34bea68b

d2a3f2ce

































d2a3f2ce


















d2a3f2ce

92b54aac

d2a3f2ce

92b54aac



d2a3f2ce

92b54aac


d2a3f2ce



92b54aac















d2a3f2ce

92b54aac


d2a3f2ce

92b54aac

d2a3f2ce

92b54aac


d2a3f2ce

92b54aac

d2a3f2ce

92b54aac


d2a3f2ce


































3edee0ac


44127242


fec98300


d2a3f2ce






























bfd2b6e0

d2a3f2ce











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









                                                                                           


                                                                                                                      
                                                   
































                                                                                                                                                                                   

















                                                                                                                                                                             
                        
                                           
                                      


                                                                                                                                                                                                                                                                                                                                                                  
                                  

                                                                                         


                                            














                                                                                                                                                                                                                                                                            
     

                                                                                                                                                                                                                                                                                    
     
     
                              

                                                                                                                                  
     
     
                                

                                 

































                                                                                    

                                                                     

                                                                     

                                                                     





























                                                                                                                                                                                                                           
                                                             










                                         
<!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_handler(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=2" 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_handler(3)</span></h1>

<h2 id="_name">Name</h2>
<p>cowboy_handler - Plain HTTP handlers</p>
<h2 id="_description">Description</h2>
<p>The <code>cowboy_handler</code> middleware executes the handler selected by the router or any other preceding middleware.</p>
<p>This middleware takes the handler module and initial state from the <code>handler</code> and <code>handler_opts</code> environment values, respectively. On completion, it adds a <code>result</code> value to the middleware environment, containing the return value of the <code>terminate/3</code> callback (if defined) and <code>ok</code> otherwise.</p>
<p>This module also defines a callback interface for handling HTTP requests.</p>
<h2 id="_callbacks">Callbacks</h2>
<p>Plain HTTP handlers implement the following interface:</p>
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><b><font color="#000000">init</font></b>(<font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-&gt;</font> {<font color="#FF6600">ok</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>}

<b><font color="#000000">terminate</font></b>(<font color="#009900">Reason</font>, <font color="#009900">Req</font>, <font color="#009900">State</font>) <font color="#990000">-&gt;</font> <font color="#FF6600">ok</font>  <i><font color="#9A1900">%% optional</font></i>

<font color="#009900">Req</font>    <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()
<font color="#009900">State</font>  <font color="#990000">::</font> <b><font color="#000000">any</font></b>()
<font color="#009900">Reason</font> <font color="#990000">::</font> <b><font color="#000080">normal</font></b>
        | {<font color="#FF6600">crash</font>, <font color="#FF6600">error</font> | <b><font color="#000080">exit</font></b> | <b><font color="#000080">throw</font></b>, <b><font color="#000000">any</font></b>()}</tt></pre>
</div></div>
<p>These two callbacks are common to all handlers.</p>
<p>Plain HTTP handlers do all their work in the <code>init/2</code> callback. Returning <code>ok</code> terminates the handler. If no response is sent, Cowboy will send a <code>204 No Content</code>.</p>
<p>The optional <code>terminate/3</code> callback will ultimately be called with the reason for the termination of the handler. Cowboy will terminate the process right after this. There is no need to perform any cleanup in this callback.</p>
<p>The following terminate reasons are defined for plain HTTP handlers:</p>
<dl><dt>normal</dt>
<dd><p>The connection was closed normally.</p>
</dd>
<dt>{crash, Class, Reason}</dt>
<dd><p>A crash occurred in the handler. <code>Class</code> and <code>Reason</code> can be used to obtain more information about the crash. The function <code>erlang:get_stacktrace/0</code> can also be called to obtain the stacktrace of the process when the crash occurred.</p>
</dd>
</dl>
<h2 id="_exports">Exports</h2>
<p>The following function should be called by modules implementing custom handlers to execute the optional terminate callback:</p>
<ul><li><a href="../cowboy_handler.terminate">cowboy_handler:terminate(3)</a> - Terminate the handler
</li>
</ul>
<h2 id="_see_also">See also</h2>
<p><a href="..">cowboy(7)</a></p>






</div>

<div class="span3 sidecol">


<h3>
	Cowboy
	2.3
	Function Reference
	
</h3>

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

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

<h4>Version select</h4>
<ul>
	
	
	
		<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>
	
		<li><a href="/docs/en/cowboy/2.3/manual">2.3</a></li>
	
		<li><a href="/docs/en/cowboy/2.2/manual">2.2</a></li>
	
		<li><a href="/docs/en/cowboy/2.1/manual">2.1</a></li>
	
		<li><a href="/docs/en/cowboy/2.0/manual">2.0</a></li>
	
		<li><a href="/docs/en/cowboy/1.0/manual">1.0</a></li>
	
</ul>

</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-11-04 21:58:32 +0000