Skip to content

Commit 8955641

Browse files
committed
fix typo error
1 parent b99a428 commit 8955641

File tree

4 files changed

+87
-11
lines changed

4 files changed

+87
-11
lines changed

Directives.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -171,11 +171,36 @@ e.g.
171171

172172
```nginx
173173
jvm_handler_type java;
174-
jvm_init_handler_name com.foo.handlers.MyHelloHandler;
174+
jvm_init_handler_name com.foo.handlers.MyJvmInitHandler;
175175
176176
## or for clojure
177177
jvm_handler_type clojure;
178-
jvm_init_handler_name foo.core/MyHelloHandler;
178+
jvm_init_handler_name foo.core/my-jvm-init-handler;
179+
```
180+
181+
* **Java**
182+
183+
```java
184+
package com.foo.handlers;
185+
186+
import nginx.clojure.java.NginxJavaRingHandler;
187+
188+
public class MyJvmInitHandler implements NginxJavaRingHandler {
189+
public Object[] invoke(Map<String, String> fakeReq) {
190+
//do some initializing here
191+
}
192+
}
193+
194+
```
195+
196+
197+
* **Clojure**
198+
199+
```clojure
200+
(ns foo.core)
201+
(defn my-jvm-init-handler[_]
202+
;;; do some initializing here
203+
)
179204
```
180205

181206
## jvm_init_handler_code
@@ -213,7 +238,7 @@ e.g.
213238

214239
```nginx
215240
jvm_handler_type clojure;
216-
jvm_init_handler_code '(fn[_]
241+
jvm_exit_handler_code '(fn[_]
217242
(do-some-cleaning-work)
218243
nil)
219244
';
@@ -284,6 +309,7 @@ Then we can reference it in nginx.conf
284309
```java
285310
package mytest;
286311
import static nginx.clojure.MiniConstants.*;
312+
import nginx.clojure.java.NginxJavaRingHandler;
287313

288314
import java.util.HashMap;
289315
import java.util.Map;

Directives.md.html

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -212,11 +212,35 @@ <h2>
212212
<p>e.g.</p>
213213

214214
<div class="highlight highlight-source-nginx"><pre><span class="pl-k">jvm_handler_type</span> java;
215-
<span class="pl-k">jvm_init_handler_name</span> com.foo.handlers.MyHelloHandler;
215+
<span class="pl-k">jvm_init_handler_name</span> com.foo.handlers.MyJvmInitHandler;
216216

217217
<span class="pl-c">## or for clojure</span>
218218
<span class="pl-k">jvm_handler_type</span> clojure;
219-
<span class="pl-k">jvm_init_handler_name</span> foo.core/MyHelloHandler;</pre></div>
219+
<span class="pl-k">jvm_init_handler_name</span> foo.core/my-jvm-init-handler;</pre></div>
220+
221+
<ul>
222+
<li><strong>Java</strong></li>
223+
</ul>
224+
225+
<div class="highlight highlight-source-java"><pre><span class="pl-k">package</span> <span class="pl-smi">com.foo.handlers</span>;
226+
227+
<span class="pl-k">import</span> <span class="pl-smi">nginx.clojure.java.NginxJavaRingHandler</span>;
228+
229+
<span class="pl-k">public</span> <span class="pl-k">class</span> <span class="pl-en">MyJvmInitHandler</span> <span class="pl-k">implements</span> <span class="pl-e">NginxJavaRingHandler</span> {
230+
<span class="pl-k">public</span> <span class="pl-k">Object</span>[] <span class="pl-en">invoke</span>(<span class="pl-k">Map&lt;<span class="pl-smi">String</span>, <span class="pl-smi">String</span>&gt;</span> <span class="pl-v">fakeReq</span>) {
231+
<span class="pl-c">//do some initializing here</span>
232+
}
233+
}
234+
</pre></div>
235+
236+
<ul>
237+
<li><strong>Clojure</strong></li>
238+
</ul>
239+
240+
<div class="highlight highlight-source-clojure"><pre>(<span class="pl-k">ns</span> <span class="pl-e">foo.core</span>)
241+
(<span class="pl-k">defn</span> <span class="pl-e">my-jvm-init-handler</span>[_]
242+
<span class="pl-c">;;; do some initializing here </span>
243+
)</pre></div>
220244

221245
<h2>
222246
<a id="user-content-jvm_init_handler_code" class="anchor" href="#jvm_init_handler_code" aria-hidden="true"><span class="octicon octicon-link"></span></a>jvm_init_handler_code</h2>
@@ -267,7 +291,7 @@ <h2>
267291
<p>e.g.</p>
268292

269293
<div class="highlight highlight-source-nginx"><pre><span class="pl-k">jvm_handler_type</span> clojure;
270-
<span class="pl-k">jvm_init_handler_code</span> <span class="pl-s">'(fn[_]</span>
294+
<span class="pl-k">jvm_exit_handler_code</span> <span class="pl-s">'(fn[_]</span>
271295
<span class="pl-s"> (do-some-cleaning-work)</span>
272296
<span class="pl-s"> nil)</span>
273297
<span class="pl-s">'</span>;</pre></div>
@@ -359,6 +383,7 @@ <h2>
359383

360384
<div class="highlight highlight-source-java"><pre><span class="pl-k">package</span> <span class="pl-smi">mytest</span>;
361385
<span class="pl-k">import static</span> <span class="pl-smi">nginx.clojure.MiniConstants.*</span>;
386+
<span class="pl-k">import</span> <span class="pl-smi">nginx.clojure.java.NginxJavaRingHandler</span>;
362387

363388
<span class="pl-k">import</span> <span class="pl-smi">java.util.HashMap</span>;
364389
<span class="pl-k">import</span> <span class="pl-smi">java.util.Map</span>;

api/nginx.clojure.core.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE html>
22
<html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>nginx.clojure.core documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">nginx-clojure</span> <span class="project-version">0.4.3</span></span></a></h1></div><div class="sidebar primary"><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>nginx</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>clojure</span></div></div></li><li class="depth-3 branch current"><a href="nginx.clojure.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-3 branch"><a href="nginx.clojure.embed.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>embed</span></div></a></li><li class="depth-3"><a href="nginx.clojure.session.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>session</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="nginx.clojure.core.html#var-achannel"><div class="inner"><span>achannel</span></div></a></li><li class="depth-1"><a href="nginx.clojure.core.html#var-AsynchronousChannel"><div class="inner"><span>AsynchronousChannel</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-aclose.21"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>aclose!</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-aclosed.3F"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>aclosed?</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-aconnect.21"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>aconnect!</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-aget-context"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>aget-context</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-arecv.21"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>arecv!</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-asend.21"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>asend!</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-aset-context.21"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>aset-context!</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-aset-timeout.21"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>aset-timeout!</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-ashutdown.21"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ashutdown!</span></div></a></li><li class="depth-2"><a href="nginx.clojure.core.html#var-error-str"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>error-str</span></div></a></li><li class="depth-1"><a href="nginx.clojure.core.html#var-broadcast.21"><div class="inner"><span>broadcast!</span></div></a></li><li class="depth-1"><a href="nginx.clojure.core.html#var-build-topic.21"><div class="inner"><span>build-topic!</span></div></a></li><li class="depth-1"><a href="nginx.clojure.core.html#var-co-pcalls"><div class="inner"><span>co-pcalls</span></div></a></li><li class="depth-1"><a href="nginx.clojure.core.html#var-co-pvalues"><div class="inner"><span>co-pvalues</span></div></a></li><li class="depth-1"><a href="nginx.clojure.core.html#var-get-ngx-var"><div class="inner"><span>get-ngx-var</span></div></a></li><li class="depth-1"><a href="nginx.clojure.core.html#var-hijack.21"><div class="inner"><span>hijack!</span></div></a></li><li class="depth-1"><a href="nginx.clojure.core.html#var-HttpServerChannel"><div class="inner"><span>HttpServerChannel</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-add-aggregated-listener.21"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>add-aggregated-listener!</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-add-listener.21"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>add-listener!</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-close.21"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>close!</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-closed.3F"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>closed?</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-get-context"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>get-context</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-on-close.21"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>on-close!</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-send.21"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>send!</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-send-header.21"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>send-header!</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-send-response.21"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>send-response!</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-set-context.21"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>set-context!</span></div></a></li><li class="depth-2"><a href="nginx.clojure.core.html#var-websocket-upgrade.21"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>websocket-upgrade!</span></div></a></li><li class="depth-1"><a href="nginx.clojure.core.html#var-on-broadcast.21"><div class="inner"><span>on-broadcast!</span></div></a></li><li class="depth-1"><a href="nginx.clojure.core.html#var-on-broadcast-event-decode.21"><div class="inner"><span>on-broadcast-event-decode!</span></div></a></li><li class="depth-1"><a href="nginx.clojure.core.html#var-phase-done"><div class="inner"><span>phase-done</span></div></a></li><li class="depth-1"><a href="nginx.clojure.core.html#var-phrase-done"><div class="inner"><span>phrase-done</span></div></a></li><li class="depth-1"><a href="nginx.clojure.core.html#var-process-id"><div class="inner"><span>process-id</span></div></a></li><li class="depth-1"><a href="nginx.clojure.core.html#var-PubSubTopic"><div class="inner"><span>PubSubTopic</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-destory.21"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>destory!</span></div></a></li><li class="depth-2 branch"><a href="nginx.clojure.core.html#var-pub.21"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>pub!</span></div></a></li><li class="depth-2"><a href="nginx.clojure.core.html#var-sub.21"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>sub!</span></div></a></li><li class="depth-1"><a href="nginx.clojure.core.html#var-set-ngx-var.21"><div class="inner"><span>set-ngx-var!</span></div></a></li><li class="depth-1"><a href="nginx.clojure.core.html#var-without-coroutine"><div class="inner"><span>without-coroutine</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">nginx.clojure.core</h1><div class="doc"><pre class="plaintext">Core functions.
3-
</pre></div><div class="public anchor" id="var-achannel"><h3>achannel</h3><div class="usage"><code>(achannel)</code></div><div class="doc"><pre class="plaintext">create an asynchrouse socket channal.
4-
</pre></div><div class="src-link"><a href="https://github.com/nginx-clojure/nginx-clojure/blob/master/src/clojure/nginx/clojure/core.clj#L248">view source</a></div></div><div class="public anchor" id="var-AsynchronousChannel"><h3>AsynchronousChannel</h3><h4 class="type">protocol</h4><div class="usage"></div><div class="doc"><pre class="plaintext">only works on non-threadpool mode, viz. coroutine mode or default mode
3+
</pre></div><div class="public anchor" id="var-achannel"><h3>achannel</h3><div class="usage"><code>(achannel)</code></div><div class="doc"><pre class="plaintext">create an asynchronous socket channal.
4+
</pre></div><div class="src-link"><a href="https://github.com/nginx-clojure/nginx-clojure/blob/master/src/clojure/nginx/clojure/core.clj#L248">view source</a></div></div><div class="public anchor" id="var-AsynchronousChannel"><h3>AsynchronousChannel</h3><h4 class="type">protocol</h4><div class="usage"></div><div class="doc"><pre class="plaintext">Only works on non-threadpool mode, viz. coroutine mode or default mode.
55
</pre></div><div class="members"><h4>members</h4><div class="inner"><div class="public anchor" id="var-aclose.21"><h3>aclose!</h3><div class="usage"><code>(aclose! ch)</code></div><div class="doc"><pre class="plaintext">Close the channel
66
</pre></div></div><div class="public anchor" id="var-aclosed.3F"><h3>aclosed?</h3><div class="usage"><code>(aclosed? ch)</code></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-aconnect.21"><h3>aconnect!</h3><div class="usage"><code>(aconnect! ch url attachment on-err on-done)</code></div><div class="doc"><pre class="plaintext">Connect to the remote url.
77
`url can be &quot;192.168.2.34:80&quot; , &quot;www.bing.com:80&quot;, or unix domain socket &quot;unix:/var/mytest/server.sock&quot;

directives.html

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -312,11 +312,35 @@ <h2>
312312
<p>e.g.</p>
313313

314314
<div class="highlight highlight-source-nginx"><pre><span class="pl-k">jvm_handler_type</span> java;
315-
<span class="pl-k">jvm_init_handler_name</span> com.foo.handlers.MyHelloHandler;
315+
<span class="pl-k">jvm_init_handler_name</span> com.foo.handlers.MyJvmInitHandler;
316316

317317
<span class="pl-c">## or for clojure</span>
318318
<span class="pl-k">jvm_handler_type</span> clojure;
319-
<span class="pl-k">jvm_init_handler_name</span> foo.core/MyHelloHandler;</pre></div>
319+
<span class="pl-k">jvm_init_handler_name</span> foo.core/my-jvm-init-handler;</pre></div>
320+
321+
<ul>
322+
<li><strong>Java</strong></li>
323+
</ul>
324+
325+
<div class="highlight highlight-source-java"><pre><span class="pl-k">package</span> <span class="pl-smi">com.foo.handlers</span>;
326+
327+
<span class="pl-k">import</span> <span class="pl-smi">nginx.clojure.java.NginxJavaRingHandler</span>;
328+
329+
<span class="pl-k">public</span> <span class="pl-k">class</span> <span class="pl-en">MyJvmInitHandler</span> <span class="pl-k">implements</span> <span class="pl-e">NginxJavaRingHandler</span> {
330+
<span class="pl-k">public</span> <span class="pl-k">Object</span>[] <span class="pl-en">invoke</span>(<span class="pl-k">Map&lt;<span class="pl-smi">String</span>, <span class="pl-smi">String</span>&gt;</span> <span class="pl-v">fakeReq</span>) {
331+
<span class="pl-c">//do some initializing here</span>
332+
}
333+
}
334+
</pre></div>
335+
336+
<ul>
337+
<li><strong>Clojure</strong></li>
338+
</ul>
339+
340+
<div class="highlight highlight-source-clojure"><pre>(<span class="pl-k">ns</span> <span class="pl-e">foo.core</span>)
341+
(<span class="pl-k">defn</span> <span class="pl-e">my-jvm-init-handler</span>[_]
342+
<span class="pl-c">;;; do some initializing here </span>
343+
)</pre></div>
320344

321345
<h2>
322346
<a id="user-content-jvm_init_handler_code" class="anchor" href="#jvm_init_handler_code" aria-hidden="true"><span class="octicon octicon-link"></span></a>jvm_init_handler_code</h2>
@@ -367,7 +391,7 @@ <h2>
367391
<p>e.g.</p>
368392

369393
<div class="highlight highlight-source-nginx"><pre><span class="pl-k">jvm_handler_type</span> clojure;
370-
<span class="pl-k">jvm_init_handler_code</span> <span class="pl-s">'(fn[_]</span>
394+
<span class="pl-k">jvm_exit_handler_code</span> <span class="pl-s">'(fn[_]</span>
371395
<span class="pl-s"> (do-some-cleaning-work)</span>
372396
<span class="pl-s"> nil)</span>
373397
<span class="pl-s">'</span>;</pre></div>
@@ -459,6 +483,7 @@ <h2>
459483

460484
<div class="highlight highlight-source-java"><pre><span class="pl-k">package</span> <span class="pl-smi">mytest</span>;
461485
<span class="pl-k">import static</span> <span class="pl-smi">nginx.clojure.MiniConstants.*</span>;
486+
<span class="pl-k">import</span> <span class="pl-smi">nginx.clojure.java.NginxJavaRingHandler</span>;
462487

463488
<span class="pl-k">import</span> <span class="pl-smi">java.util.HashMap</span>;
464489
<span class="pl-k">import</span> <span class="pl-smi">java.util.Map</span>;

0 commit comments

Comments
 (0)