Skip to content

Commit

Permalink
Merge b8335da into 03ef6d4
Browse files Browse the repository at this point in the history
  • Loading branch information
lpgauth committed Jul 15, 2019
2 parents 03ef6d4 + b8335da commit e54951e
Show file tree
Hide file tree
Showing 31 changed files with 906 additions and 247 deletions.
15 changes: 2 additions & 13 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,21 +1,10 @@
addons:
apt:
sources:
- ubuntu-toolchain-r-test
packages:
- gcc-5
cache:
directories:
- $HOME/.cache/rebar3
- $TRAVIS_BUILD_DIR/_build
env:
- CC=gcc-5
install: true
language: erlang
notifications:
email: false
otp_release:
- 21.0.3
- 22.0
- 21.3.8
- 20.3
- 19.3
- 18.3
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,12 @@ shackle_pool:start(pool_name(), client(), client_options(), pool_options())
<td>1024</td>
<td>maximum number of concurrent requests per connection</td>
</tr>
<tr>
<td>max_retries</td>
<td>non_neg_integer()</td>
<td>3</td>
<td>>maximum number of tries to find an active server</td>
</tr>
<tr>
<td>pool_size</td>
<td>pos_integer()</td>
Expand Down
3 changes: 2 additions & 1 deletion doc/edoc-info
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
{application,shackle}.
{modules,[shackle,shackle_app,shackle_backlog,shackle_backoff,shackle_client,
shackle_pool,shackle_queue,shackle_server_utils,shackle_ssl_server,
shackle_sup,shackle_tcp_server,shackle_udp_server,shackle_utils]}.
shackle_status,shackle_sup,shackle_tcp_server,shackle_udp_server,
shackle_utils]}.
14 changes: 12 additions & 2 deletions doc/shackle.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,16 @@ init_options() = term()



### <a name="type-max_retries">max_retries()</a> ###


<pre><code>
max_retries() = non_neg_integer()
</code></pre>




### <a name="type-pool_name">pool_name()</a> ###


Expand All @@ -66,7 +76,7 @@ pool_name() = atom()


<pre><code>
pool_option() = {backlog_size, <a href="#type-backlog_size">backlog_size()</a>} | {pool_size, <a href="#type-pool_size">pool_size()</a>} | {pool_strategy, <a href="#type-pool_strategy">pool_strategy()</a>}
pool_option() = {backlog_size, <a href="#type-backlog_size">backlog_size()</a>} | {max_retries, <a href="#type-max_retries">max_retries()</a>} | {pool_size, <a href="#type-pool_size">pool_size()</a>} | {pool_strategy, <a href="#type-pool_strategy">pool_strategy()</a>}
</code></pre>


Expand Down Expand Up @@ -165,7 +175,7 @@ call(PoolName::<a href="#type-pool_name">pool_name()</a>, Request::term()) -&gt;
### call/3 ###

<pre><code>
call(PoolName::atom(), Request::term(), Timeout::timeout()) -&gt; term() | {error, term()}
call(PoolName::atom(), Request::term(), Timeout::timeout()) -&gt; term() | {error, atom()}
</code></pre>
<br />

Expand Down
12 changes: 11 additions & 1 deletion doc/shackle_app.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,21 @@ init_options() = term()



### <a name="type-max_retries">max_retries()</a> ###


<pre><code>
max_retries() = non_neg_integer()
</code></pre>




### <a name="type-pool_option">pool_option()</a> ###


<pre><code>
pool_option() = {backlog_size, <a href="#type-backlog_size">backlog_size()</a>} | {pool_size, <a href="#type-pool_size">pool_size()</a>} | {pool_strategy, <a href="#type-pool_strategy">pool_strategy()</a>}
pool_option() = {backlog_size, <a href="#type-backlog_size">backlog_size()</a>} | {max_retries, <a href="#type-max_retries">max_retries()</a>} | {pool_size, <a href="#type-pool_size">pool_size()</a>} | {pool_strategy, <a href="#type-pool_strategy">pool_strategy()</a>}
</code></pre>


Expand Down
54 changes: 47 additions & 7 deletions doc/shackle_backlog.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,31 @@ init_options() = term()



### <a name="type-max_retries">max_retries()</a> ###


<pre><code>
max_retries() = non_neg_integer()
</code></pre>




### <a name="type-pool_name">pool_name()</a> ###


<pre><code>
pool_name() = atom()
</code></pre>




### <a name="type-pool_option">pool_option()</a> ###


<pre><code>
pool_option() = {backlog_size, <a href="#type-backlog_size">backlog_size()</a>} | {pool_size, <a href="#type-pool_size">pool_size()</a>} | {pool_strategy, <a href="#type-pool_strategy">pool_strategy()</a>}
pool_option() = {backlog_size, <a href="#type-backlog_size">backlog_size()</a>} | {max_retries, <a href="#type-max_retries">max_retries()</a>} | {pool_size, <a href="#type-pool_size">pool_size()</a>} | {pool_strategy, <a href="#type-pool_strategy">pool_strategy()</a>}
</code></pre>


Expand Down Expand Up @@ -112,6 +132,26 @@ request_id() = {<a href="#type-server_name">server_name()</a>, reference()}



### <a name="type-server_id">server_id()</a> ###


<pre><code>
server_id() = {<a href="#type-pool_name">pool_name()</a>, <a href="#type-server_index">server_index()</a>}
</code></pre>




### <a name="type-server_index">server_index()</a> ###


<pre><code>
server_index() = pos_integer()
</code></pre>




### <a name="type-server_name">server_name()</a> ###


Expand Down Expand Up @@ -146,7 +186,7 @@ time() = pos_integer()
### check/2 ###

<pre><code>
check(ServerName::<a href="#type-server_name">server_name()</a>, BacklogSize::<a href="#type-backlog_size">backlog_size()</a>) -&gt; boolean()
check(ServerId::<a href="#type-server_id">server_id()</a>, BacklogSize::<a href="#type-backlog_size">backlog_size()</a>) -&gt; boolean()
</code></pre>
<br />

Expand All @@ -155,7 +195,7 @@ check(ServerName::<a href="#type-server_name">server_name()</a>, BacklogSize::<a
### check/3 ###

<pre><code>
check(ServerName::<a href="#type-server_name">server_name()</a>, BacklogSize::<a href="#type-backlog_size">backlog_size()</a>, Increment::pos_integer()) -&gt; boolean()
check(ServerId::<a href="#type-server_id">server_id()</a>, BacklogSize::<a href="#type-backlog_size">backlog_size()</a>, Increment::pos_integer()) -&gt; boolean()
</code></pre>
<br />

Expand All @@ -164,7 +204,7 @@ check(ServerName::<a href="#type-server_name">server_name()</a>, BacklogSize::<a
### decrement/1 ###

<pre><code>
decrement(ServerName::<a href="#type-server_name">server_name()</a>) -&gt; non_neg_integer()
decrement(ServerId::<a href="#type-server_id">server_id()</a>) -&gt; non_neg_integer()
</code></pre>
<br />

Expand All @@ -173,7 +213,7 @@ decrement(ServerName::<a href="#type-server_name">server_name()</a>) -&gt; non_n
### decrement/2 ###

<pre><code>
decrement(ServerName::<a href="#type-server_name">server_name()</a>, Decrement::neg_integer()) -&gt; non_neg_integer()
decrement(ServerId::<a href="#type-server_id">server_id()</a>, Decrement::neg_integer()) -&gt; non_neg_integer()
</code></pre>
<br />

Expand All @@ -182,7 +222,7 @@ decrement(ServerName::<a href="#type-server_name">server_name()</a>, Decrement::
### delete/1 ###

<pre><code>
delete(ServerName::<a href="#type-server_name">server_name()</a>) -&gt; ok
delete(ServerId::<a href="#type-server_id">server_id()</a>) -&gt; ok
</code></pre>
<br />

Expand All @@ -200,7 +240,7 @@ init() -&gt; ok
### new/1 ###

<pre><code>
new(ServerName::<a href="#type-server_name">server_name()</a>) -&gt; ok
new(ServerId::<a href="#type-server_id">server_id()</a>) -&gt; ok
</code></pre>
<br />

12 changes: 11 additions & 1 deletion doc/shackle_backoff.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,21 @@ init_options() = term()



### <a name="type-max_retries">max_retries()</a> ###


<pre><code>
max_retries() = non_neg_integer()
</code></pre>




### <a name="type-pool_option">pool_option()</a> ###


<pre><code>
pool_option() = {backlog_size, <a href="#type-backlog_size">backlog_size()</a>} | {pool_size, <a href="#type-pool_size">pool_size()</a>} | {pool_strategy, <a href="#type-pool_strategy">pool_strategy()</a>}
pool_option() = {backlog_size, <a href="#type-backlog_size">backlog_size()</a>} | {max_retries, <a href="#type-max_retries">max_retries()</a>} | {pool_size, <a href="#type-pool_size">pool_size()</a>} | {pool_strategy, <a href="#type-pool_strategy">pool_strategy()</a>}
</code></pre>


Expand Down
12 changes: 11 additions & 1 deletion doc/shackle_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,21 @@ init_options() = term()



### <a name="type-max_retries">max_retries()</a> ###


<pre><code>
max_retries() = non_neg_integer()
</code></pre>




### <a name="type-pool_option">pool_option()</a> ###


<pre><code>
pool_option() = {backlog_size, <a href="#type-backlog_size">backlog_size()</a>} | {pool_size, <a href="#type-pool_size">pool_size()</a>} | {pool_strategy, <a href="#type-pool_strategy">pool_strategy()</a>}
pool_option() = {backlog_size, <a href="#type-backlog_size">backlog_size()</a>} | {max_retries, <a href="#type-max_retries">max_retries()</a>} | {pool_size, <a href="#type-pool_size">pool_size()</a>} | {pool_strategy, <a href="#type-pool_strategy">pool_strategy()</a>}
</code></pre>


Expand Down
14 changes: 12 additions & 2 deletions doc/shackle_pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,16 @@ init_options() = term()



### <a name="type-max_retries">max_retries()</a> ###


<pre><code>
max_retries() = non_neg_integer()
</code></pre>




### <a name="type-pool_name">pool_name()</a> ###


Expand All @@ -76,7 +86,7 @@ pool_name() = atom()


<pre><code>
pool_option() = {backlog_size, <a href="#type-backlog_size">backlog_size()</a>} | {pool_size, <a href="#type-pool_size">pool_size()</a>} | {pool_strategy, <a href="#type-pool_strategy">pool_strategy()</a>}
pool_option() = {backlog_size, <a href="#type-backlog_size">backlog_size()</a>} | {max_retries, <a href="#type-max_retries">max_retries()</a>} | {pool_size, <a href="#type-pool_size">pool_size()</a>} | {pool_strategy, <a href="#type-pool_strategy">pool_strategy()</a>}
</code></pre>


Expand Down Expand Up @@ -175,7 +185,7 @@ init() -&gt; ok
### server/1 ###

<pre><code>
server(Name::<a href="#type-pool_name">pool_name()</a>) -&gt; {ok, <a href="#type-client">client()</a>, pid()} | {error, atom()}
server(Name::<a href="#type-pool_name">pool_name()</a>) -&gt; {ok, <a href="#type-client">client()</a>, atom()} | {error, no_server}
</code></pre>
<br />

Expand Down

0 comments on commit e54951e

Please sign in to comment.