Skip to content

Commit

Permalink
Deploying to gh-pages from @ 0142400 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
jchristgit committed Jun 20, 2024
1 parent 4186c90 commit 31da5ce
Show file tree
Hide file tree
Showing 45 changed files with 713 additions and 711 deletions.
2 changes: 1 addition & 1 deletion .build
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ dist/lato-latin-ext-300-normal-VPGGJKJL.woff2
dist/lato-latin-ext-400-normal-N27NCBWW.woff2
dist/lato-latin-ext-700-normal-Q2L5DVMW.woff2
dist/remixicon-NKANDIL5.woff2
dist/search_data-4FAB4467.js
dist/search_data-625EEB12.js
dist/sidebar_items-9312FB79.js
event_handling.html
gateway_compression.html
Expand Down
14 changes: 7 additions & 7 deletions Nostrum.Api.Ratelimiter.html
Original file line number Diff line number Diff line change
Expand Up @@ -164,9 +164,9 @@ <h1>
<p>The ratelimiter is fully asynchronous internally. In theory, it also supports
queueing requests in an asynchronous manner. However, support for this is
currently not implemented in <a href="Nostrum.Api.html"><code class="inline">Nostrum.Api</code></a>.</p><p>If you want to make one or multiple asynchronous requests manually, you can
use the following pattern:</p><pre><code class="makeup elixir" translate="no"><span class="n">req</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">:gen_statem</span><span class="o">.</span><span class="n">send_request</span><span class="p" data-group-id="2040770539-1">(</span><span class="nc">Nostrum.Api.Ratelimiter</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="2040770539-2">{</span><span class="ss">:queue</span><span class="p">,</span><span class="w"> </span><span class="n">request</span><span class="p" data-group-id="2040770539-2">}</span><span class="p" data-group-id="2040770539-1">)</span><span class="w">
use the following pattern:</p><pre><code class="makeup elixir" translate="no"><span class="n">req</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">:gen_statem</span><span class="o">.</span><span class="n">send_request</span><span class="p" data-group-id="2186768513-1">(</span><span class="nc">Nostrum.Api.Ratelimiter</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="2186768513-2">{</span><span class="ss">:queue</span><span class="p">,</span><span class="w"> </span><span class="n">request</span><span class="p" data-group-id="2186768513-2">}</span><span class="p" data-group-id="2186768513-1">)</span><span class="w">
</span><span class="c1"># ...</span><span class="w">
</span><span class="n">response</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">:gen_statem</span><span class="o">.</span><span class="n">receive_response</span><span class="p" data-group-id="2040770539-3">(</span><span class="n">req</span><span class="p">,</span><span class="w"> </span><span class="n">timeout</span><span class="p" data-group-id="2040770539-3">)</span></code></pre><p>where <code class="inline">request</code> is a map describing the request to run - see <a href="Nostrum.Api.html"><code class="inline">Nostrum.Api</code></a>
</span><span class="n">response</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">:gen_statem</span><span class="o">.</span><span class="n">receive_response</span><span class="p" data-group-id="2186768513-3">(</span><span class="n">req</span><span class="p">,</span><span class="w"> </span><span class="n">timeout</span><span class="p" data-group-id="2186768513-3">)</span></code></pre><p>where <code class="inline">request</code> is a map describing the request to run - see <a href="Nostrum.Api.html"><code class="inline">Nostrum.Api</code></a>
for more information. You can also send multiple requests at the same time
and wait for their response: see <a href="https://www.erlang.org/doc/man/gen_statem.html#reqids_add-3"><code class="inline">:gen_statem.reqids_add/3</code></a> and
<a href="https://www.erlang.org/doc/man/gen_statem.html#wait_response-3"><code class="inline">:gen_statem.wait_response/3</code></a> for more information.</p><h2 id="module-multi-node" class="section-heading">
Expand Down Expand Up @@ -724,7 +724,7 @@ <h1 class="signature" translate="no">child_spec(opts)</h1>
</a>
<h1 class="signature" translate="no">code_change(version, state, data, extra)</h1>

<a href="https://github.com/Kraigie/nostrum/blob/master/lib/nostrum/api/ratelimiter.ex#L942" class="icon-action" rel="help" title="View Source">
<a href="https://github.com/Kraigie/nostrum/blob/master/lib/nostrum/api/ratelimiter.ex#L932" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
Expand All @@ -746,7 +746,7 @@ <h1 class="signature" translate="no">code_change(version, state, data, extra)</h
</a>
<h1 class="signature" translate="no">connected(arg1, request, data)</h1>

<a href="https://github.com/Kraigie/nostrum/blob/master/lib/nostrum/api/ratelimiter.ex#L402" class="icon-action" rel="help" title="View Source">
<a href="https://github.com/Kraigie/nostrum/blob/master/lib/nostrum/api/ratelimiter.ex#L392" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
Expand Down Expand Up @@ -812,7 +812,7 @@ <h1 class="signature" translate="no">disconnected(arg, arg2, data)</h1>
</a>
<h1 class="signature" translate="no">get_endpoint(route, method)</h1>

<a href="https://github.com/Kraigie/nostrum/blob/master/lib/nostrum/api/ratelimiter.ex#L1021" class="icon-action" rel="help" title="View Source">
<a href="https://github.com/Kraigie/nostrum/blob/master/lib/nostrum/api/ratelimiter.ex#L1031" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
Expand Down Expand Up @@ -840,7 +840,7 @@ <h1 class="signature" translate="no">get_endpoint(route, method)</h1>
</a>
<h1 class="signature" translate="no">global_limit(arg1, next, data)</h1>

<a href="https://github.com/Kraigie/nostrum/blob/master/lib/nostrum/api/ratelimiter.ex#L906" class="icon-action" rel="help" title="View Source">
<a href="https://github.com/Kraigie/nostrum/blob/master/lib/nostrum/api/ratelimiter.ex#L896" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
Expand Down Expand Up @@ -884,7 +884,7 @@ <h1 class="signature" translate="no">init(token)</h1>
</a>
<h1 class="signature" translate="no">queue(request)</h1>

<a href="https://github.com/Kraigie/nostrum/blob/master/lib/nostrum/api/ratelimiter.ex#L972" class="icon-action" rel="help" title="View Source">
<a href="https://github.com/Kraigie/nostrum/blob/master/lib/nostrum/api/ratelimiter.ex#L982" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
Expand Down
Loading

0 comments on commit 31da5ce

Please sign in to comment.