Skip to content

Commit 1efcc30

Browse files
yurrriqyurrriq
committed
doc: generate
1 parent 9cab05e commit 1efcc30

12 files changed

+635
-0
lines changed

‎doc/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
2+
3+
# The elli_websocket application #
4+
5+
6+
## Modules ##
7+
8+
9+
<table width="100%" border="0" summary="list of modules">
10+
<tr><td><a href="elli_bstr.md" class="module">elli_bstr</a></td></tr>
11+
<tr><td><a href="elli_example_websocket.md" class="module">elli_example_websocket</a></td></tr>
12+
<tr><td><a href="elli_proplists.md" class="module">elli_proplists</a></td></tr>
13+
<tr><td><a href="elli_websocket.md" class="module">elli_websocket</a></td></tr>
14+
<tr><td><a href="elli_websocket_handler.md" class="module">elli_websocket_handler</a></td></tr>
15+
<tr><td><a href="elli_ws_http.md" class="module">elli_ws_http</a></td></tr>
16+
<tr><td><a href="elli_ws_protocol.md" class="module">elli_ws_protocol</a></td></tr>
17+
<tr><td><a href="elli_ws_request_adapter.md" class="module">elli_ws_request_adapter</a></td></tr></table>
18+

‎doc/edoc-info

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
%% encoding: UTF-8
2+
{application,elli_websocket}.
3+
{modules,[elli_bstr,elli_example_websocket,elli_proplists,elli_websocket,
4+
elli_websocket_handler,elli_ws_http,elli_ws_protocol,
5+
elli_ws_request_adapter]}.

‎doc/elli_bstr.md

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
2+
3+
# Module elli_bstr #
4+
* [Description](#description)
5+
* [Data Types](#types)
6+
* [Function Index](#index)
7+
* [Function Details](#functions)
8+
9+
Binary String Helper Functions.
10+
11+
Copyright (c) 2013, Maas-Maarten Zeeman; 2018, elli-lib team
12+
13+
__Authors:__ Maas-Maarten Zeeman ([`[email protected]`](mailto:[email protected])).
14+
15+
<a name="types"></a>
16+
17+
## Data Types ##
18+
19+
20+
21+
22+
### <a name="type-ascii_char">ascii_char()</a> ###
23+
24+
25+
<pre><code>
26+
ascii_char() = 0..127
27+
</code></pre>
28+
29+
<a name="index"></a>
30+
31+
## Function Index ##
32+
33+
34+
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#is_equal_ci-2">is_equal_ci/2</a></td><td>Compare two binary values.</td></tr><tr><td valign="top"><a href="#lchr-1">lchr/1</a></td><td>convert character to lowercase.</td></tr><tr><td valign="top"><a href="#to_lower-1">to_lower/1</a></td><td>Convert ascii Bin to lowercase.</td></tr><tr><td valign="top"><a href="#trim-1">trim/1</a></td><td>Remove leading and trailing whitespace.</td></tr><tr><td valign="top"><a href="#trim_left-1">trim_left/1</a></td><td>Remove leading whitespace from Bin.</td></tr><tr><td valign="top"><a href="#trim_right-1">trim_right/1</a></td><td>Remove trailing whitespace from Bin.</td></tr></table>
35+
36+
37+
<a name="functions"></a>
38+
39+
## Function Details ##
40+
41+
<a name="is_equal_ci-2"></a>
42+
43+
### is_equal_ci/2 ###
44+
45+
<pre><code>
46+
is_equal_ci(Bin::binary(), Bin2::binary()) -&gt; boolean()
47+
</code></pre>
48+
<br />
49+
50+
Compare two binary values.
51+
Return true iff they are equal by a caseless compare.
52+
53+
<a name="lchr-1"></a>
54+
55+
### lchr/1 ###
56+
57+
<pre><code>
58+
lchr(Chr::<a href="#type-ascii_char">ascii_char()</a>) -&gt; <a href="#type-ascii_char">ascii_char()</a>
59+
</code></pre>
60+
<br />
61+
62+
convert character to lowercase.
63+
64+
<a name="to_lower-1"></a>
65+
66+
### to_lower/1 ###
67+
68+
<pre><code>
69+
to_lower(Bin::binary()) -&gt; binary()
70+
</code></pre>
71+
<br />
72+
73+
Convert ascii Bin to lowercase
74+
75+
<a name="trim-1"></a>
76+
77+
### trim/1 ###
78+
79+
<pre><code>
80+
trim(Bin::binary()) -&gt; binary()
81+
</code></pre>
82+
<br />
83+
84+
Remove leading and trailing whitespace.
85+
86+
<a name="trim_left-1"></a>
87+
88+
### trim_left/1 ###
89+
90+
<pre><code>
91+
trim_left(Bin::binary()) -&gt; binary()
92+
</code></pre>
93+
<br />
94+
95+
Remove leading whitespace from Bin
96+
97+
<a name="trim_right-1"></a>
98+
99+
### trim_right/1 ###
100+
101+
<pre><code>
102+
trim_right(Bin::binary()) -&gt; binary()
103+
</code></pre>
104+
<br />
105+
106+
Remove trailing whitespace from Bin
107+

‎doc/elli_example_websocket.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
2+
3+
# Module elli_example_websocket #
4+
* [Function Index](#index)
5+
* [Function Details](#functions)
6+
7+
__Behaviours:__ [`elli_handler`](https://github.com/elli-lib/elli/blob/develop/doc/elli_handler.md), [`elli_websocket_handler`](elli_websocket_handler.md).
8+
9+
<a name="index"></a>
10+
11+
## Function Index ##
12+
13+
14+
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#handle-2">handle/2</a></td><td></td></tr><tr><td valign="top"><a href="#handle_event-3">handle_event/3</a></td><td></td></tr><tr><td valign="top"><a href="#init-2">init/2</a></td><td></td></tr><tr><td valign="top"><a href="#websocket_handle-3">websocket_handle/3</a></td><td></td></tr><tr><td valign="top"><a href="#websocket_handle_event-3">websocket_handle_event/3</a></td><td></td></tr><tr><td valign="top"><a href="#websocket_info-3">websocket_info/3</a></td><td></td></tr><tr><td valign="top"><a href="#websocket_init-2">websocket_init/2</a></td><td>.</td></tr></table>
15+
16+
17+
<a name="functions"></a>
18+
19+
## Function Details ##
20+
21+
<a name="handle-2"></a>
22+
23+
### handle/2 ###
24+
25+
`handle(Req, Args) -> any()`
26+
27+
<a name="handle_event-3"></a>
28+
29+
### handle_event/3 ###
30+
31+
`handle_event(Name, EventArgs, ElliArgs) -> any()`
32+
33+
<a name="init-2"></a>
34+
35+
### init/2 ###
36+
37+
`init(Req, Args) -> any()`
38+
39+
<a name="websocket_handle-3"></a>
40+
41+
### websocket_handle/3 ###
42+
43+
`websocket_handle(Req, Message, State) -> any()`
44+
45+
<a name="websocket_handle_event-3"></a>
46+
47+
### websocket_handle_event/3 ###
48+
49+
`websocket_handle_event(X1, X2, X3) -> any()`
50+
51+
<a name="websocket_info-3"></a>
52+
53+
### websocket_info/3 ###
54+
55+
`websocket_info(Req, Message, State) -> any()`
56+
57+
<a name="websocket_init-2"></a>
58+
59+
### websocket_init/2 ###
60+
61+
`websocket_init(Req, Opts) -> any()`
62+

‎doc/elli_proplists.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
3+
# Module elli_proplists #
4+
* [Function Index](#index)
5+
* [Function Details](#functions)
6+
7+
<a name="index"></a>
8+
9+
## Function Index ##
10+
11+
12+
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#get_all_values_ci-2">get_all_values_ci/2</a></td><td></td></tr><tr><td valign="top"><a href="#get_value_ci-2">get_value_ci/2</a></td><td></td></tr></table>
13+
14+
15+
<a name="functions"></a>
16+
17+
## Function Details ##
18+
19+
<a name="get_all_values_ci-2"></a>
20+
21+
### get_all_values_ci/2 ###
22+
23+
`get_all_values_ci(Key, Proplist) -> any()`
24+
25+
<a name="get_value_ci-2"></a>
26+
27+
### get_value_ci/2 ###
28+
29+
`get_value_ci(Key, Rest) -> any()`
30+

‎doc/elli_websocket.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
2+
3+
# Module elli_websocket #
4+
* [Description](#description)
5+
* [Data Types](#types)
6+
* [Function Index](#index)
7+
* [Function Details](#functions)
8+
9+
Elli Websocket Handler.
10+
11+
Copyright (c) 2012-2013, Maas-Maarten Zeeman; 2018, elli-lib team
12+
13+
__Authors:__ Maas-Maarten Zeeman ([`[email protected]`](mailto:[email protected])).
14+
15+
<a name="types"></a>
16+
17+
## Data Types ##
18+
19+
20+
21+
22+
### <a name="type-event">event()</a> ###
23+
24+
25+
<pre><code>
26+
event() = websocket_open | websocket_close | websocket_throw | websocket_error | websocket_exit
27+
</code></pre>
28+
29+
30+
31+
32+
### <a name="type-message">message()</a> ###
33+
34+
35+
<pre><code>
36+
message() = {text, <a href="#type-payload">payload()</a>} | {binary, <a href="#type-payload">payload()</a>} | {ping, <a href="#type-payload">payload()</a>} | {pong, <a href="#type-payload">payload()</a>}
37+
</code></pre>
38+
39+
40+
41+
42+
### <a name="type-payload">payload()</a> ###
43+
44+
45+
<pre><code>
46+
payload() = binary() | iolist()
47+
</code></pre>
48+
49+
<a name="index"></a>
50+
51+
## Function Index ##
52+
53+
54+
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#upgrade-2">upgrade/2</a></td><td>Upgrade the request to a websocket, will respond with
55+
bad request when something is wrong.</td></tr></table>
56+
57+
58+
<a name="functions"></a>
59+
60+
## Function Details ##
61+
62+
<a name="upgrade-2"></a>
63+
64+
### upgrade/2 ###
65+
66+
<pre><code>
67+
upgrade(Req::<a href="http://raw.github.com/elli-lib/elli/develop/doc/elli.md#type-req">elli:req()</a>, Args::list()) -&gt; ok
68+
</code></pre>
69+
<br />
70+
71+
Upgrade the request to a websocket, will respond with
72+
bad request when something is wrong.
73+

‎doc/elli_websocket_handler.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
3+
# Module elli_websocket_handler #
4+
* [Description](#description)
5+
6+
Elli WebSocket Handler Behaviour.
7+
8+
Copyright (c) 2013, Maas-Maarten Zeeman; 2018, elli-lib team
9+
10+
__This module defines the `elli_websocket_handler` behaviour.__<br /> Required callback functions: `websocket_init/2`, `websocket_handle/3`, `websocket_info/3`, `websocket_handle_event/3`.
11+
12+
__Authors:__ Maas-Maarten Zeeman ([`[email protected]`](mailto:[email protected])).
13+

‎doc/elli_ws_http.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
2+
3+
# Module elli_ws_http #
4+
* [Description](#description)
5+
* [Function Index](#index)
6+
* [Function Details](#functions)
7+
8+
Some simple parsing routines.
9+
10+
<a name="index"></a>
11+
12+
## Function Index ##
13+
14+
15+
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#tokens-1">tokens/1</a></td><td>Parse tokens.</td></tr></table>
16+
17+
18+
<a name="functions"></a>
19+
20+
## Function Details ##
21+
22+
<a name="tokens-1"></a>
23+
24+
### tokens/1 ###
25+
26+
<pre><code>
27+
tokens(L::binary() | [binary() | [binary() | list()]]) -&gt; [bitstring()]
28+
</code></pre>
29+
<br />
30+
31+
Parse tokens
32+

0 commit comments

Comments
 (0)