summaryrefslogtreecommitdiffstats
path: root/web/server/h2o/libh2o/doc/configure/mruby_directives.html
blob: 2a188a5b4f2695718419c5ed50919f9f91e69a4f (plain)
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
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1,user-scalable=no" />
<base href="../" />

<!-- oktavia -->
<link rel="stylesheet" href="assets/searchstyle.css" type="text/css" />
<script src="search/jquery-1.9.1.min.js"></script>
<script src="search/oktavia-jquery-ui.js"></script>
<script src="search/oktavia-english-search.js"></script>
<!-- /oktavia -->

<link rel="stylesheet" href="assets/style.css" type="text/css" />

<title>Mruby Directives - Configure - H2O - the optimized HTTP/2 server</title>
</head>
<body>
<div id="body">
<div id="top">

<h1>
<a href="index.html">H2O</a>
</h1>
<p class="description">the optimized HTTP/1.x, HTTP/2 server</p>

<!-- oktavia -->
<form id="searchform">
<input class="search" type="search" name="search" id="search" results="5" value="" placeholder="Search" />
<div id="searchresult_box">
<div id="close_search_box">&times;</div>
<div id="searchresult_summary"></div>
<div id="searchresult"></div>
<div id="searchresult_nav"></div>
<span class="pr">Powered by <a href="https://github.com/shibukawa/oktavia">Oktavia</a></span>
</div>
</form>
<!-- /oktavia -->

</div>

<table id="menu">
<tr>
<td><a href="index.html">Top</a></td>
<td><a href="install.html">Install</a></td>
<td class="selected">Configure</td>
<td><a href="faq.html">FAQ</a></td>
<td><a href="http://blog.kazuhooku.com/search/label/H2O" target="_blank">Blog</a></td>
<td><a href="http://github.com/h2o/h2o/" target="_blank">Source</a></td>
</tr>
</table>

<div id="main">

<h2>
<a href="configure.html">Configure</a> &gt;
Mruby Directives
</h2>


<p>
The following are the configuration directives of the mruby handler.
Please refer to <a href="configure/mruby.html">Using mruby</a> to find out how to write handlers using mruby.
</p>

<div id="mruby.handler" class="directive-head">
<h3><a href="configure/mruby_directives.html#mruby.handler"><code>"mruby.handler"</code></a></h3>
</div>

<dl class="directive-desc">
<dt>Description:</dt>
<dd>
<p>
Upon start-up evaluates given mruby expression, and uses the returned mruby object to handle the incoming requests.

</p>


<div class="example">
<div class="caption">Example. Hello-world in mruby</div>
<pre><code>mruby.handler: |
  Proc.new do |env|
    [200, {&#39;content-type&#39; =&gt; &#39;text/plain&#39;}, [&quot;Hello world\n&quot;]]
  end
</code></pre>
</div>


<p>
Note that the provided expression is evaluated more than once (typically for every thread that accepts incoming connections).
</p>

</dd>
<dt><a href="configure/syntax_and_structure.html#config_levels">Level</a>:</dt>
<dd>path</dd>
<dt>See also:</dt>
<dd><a href="configure/mruby_directives.html#mruby.handler-file"><code>mruby.handler-file</code></a>
</dd>
</dl>

<div id="mruby.handler-file" class="directive-head">
<h3><a href="configure/mruby_directives.html#mruby.handler-file"><code>"mruby.handler-file"</code></a></h3>
</div>

<dl class="directive-desc">
<dt>Description:</dt>
<dd>
<p>
Upon start-up evaluates given mruby file, and uses the returned mruby object to handle the incoming requests.

</p>


<div class="example">
<div class="caption">Example. Hello-world in mruby</div>
<pre><code>mruby.handler-file: /path/to/my-mruby-handler.rb
</code></pre>
</div>


<p>
Note that the provided expression is evaluated more than once (typically for every thread that accepts incoming connections).
</p>

</dd>
<dt><a href="configure/syntax_and_structure.html#config_levels">Level</a>:</dt>
<dd>path</dd>
<dt>See also:</dt>
<dd><a href="configure/mruby_directives.html#mruby.handler"><code>mruby.handler</code></a>
</dd>
</dl>




</div>
<div id="footer">
<p>
Copyright &copy; 2015 <a href="http://dena.com/intl/">DeNA Co., Ltd.</a> et al.
</p>
</div>
</body>
</html>