build based on 22570be

previews/PR10/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-02T15:36:46","documenter_version":"1.5.0"}}
+{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-02T15:40:10","documenter_version":"1.5.0"}}

previews/PR10/index.html

@@ -16,9 +16,9 @@
 
 kill(server) # when you are done</code></pre><p>One can also use a <code>GoAWSConfig</code> with a GoAWS server launched outside of the Julia process. Simply set the <code>endpoint</code> and <code>region</code> using the keyword argument constructor:</p><pre><code class="language-julia hljs">aws_config = GoAWSConfig(; endpoint=&quot;localhost:5203&quot;, region=&quot;us-east-1&quot;) 
 # ... now we can use the config:
-SQS.create_queue(&quot;my_queue&quot;; aws_config)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/beacon-biosignals/GoAWS.jl/blob/53a33612fabdd0ac92e137ac15a761f7c0b54b05/src/aws_interop.jl#L1-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="GoAWS.Server-Tuple{}" href="#GoAWS.Server-Tuple{}"><code>GoAWS.Server</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">GoAWS.Server(; cmd=goaws_jll.goaws(),
+SQS.create_queue(&quot;my_queue&quot;; aws_config)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/beacon-biosignals/GoAWS.jl/blob/22570be24d6b0d1030b7f3ab5f3568e4bf01dd89/src/aws_interop.jl#L1-L37">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="GoAWS.Server-Tuple{}" href="#GoAWS.Server-Tuple{}"><code>GoAWS.Server</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">GoAWS.Server(; cmd=goaws_jll.goaws(),
              config=GoAWS.default_config(),
              address=GoAWS.DEFAULT_ADDRESS,
              region=&quot;us-east-2&quot;,
              detach::Bool=false,
-             verbose::Bool=false)</code></pre><p>A data structure for managing a <code>goaws</code> server process.</p><p>The passed-in <code>config</code> will be mutated in-place to add the <code>host</code> and <code>port</code> from <code>address</code>, and the <code>region</code>.</p><p>Supports <code>run</code>, as well as <code>kill</code>, <code>getpid</code>, <code>success</code>, <code>process_exited</code>, and <code>process_running</code> by forwarding to the process created by <code>run</code>.</p><p>Can also be used with <a href="#GoAWS.with_go_aws-Tuple{Any}"><code>with_go_aws</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/beacon-biosignals/GoAWS.jl/blob/53a33612fabdd0ac92e137ac15a761f7c0b54b05/src/server.jl#L18-L35">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="GoAWS.default_config-Tuple{}" href="#GoAWS.default_config-Tuple{}"><code>GoAWS.default_config</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">GoAWS.default_config() -&gt; Dict{Any,Any}</code></pre><p>Provides a copy of the default configuration used in <a href="#GoAWS.Server-Tuple{}"><code>Server</code></a> and <a href="#GoAWS.with_go_aws-Tuple{Any}"><code>with_go_aws</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/beacon-biosignals/GoAWS.jl/blob/53a33612fabdd0ac92e137ac15a761f7c0b54b05/src/GoAWS.jl#L13-L17">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="GoAWS.with_go_aws-Tuple{Any}" href="#GoAWS.with_go_aws-Tuple{Any}"><code>GoAWS.with_go_aws</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">with_go_aws(f; address=DEFAULT_ADDRESS, region=&quot;us-east-2&quot;, kw...)</code></pre><p>Starts up a GoAWS server, runs <code>f(go_aws_config::AbstractAWSConfig)</code>, with an AWS.jl-compatible config pointing to a live GoAWS server, and destroys the server when <code>f()</code> finishes or errors.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/beacon-biosignals/GoAWS.jl/blob/53a33612fabdd0ac92e137ac15a761f7c0b54b05/src/server.jl#L116-L121">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Tuesday 2 July 2024 15:36">Tuesday 2 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+             verbose::Bool=false)</code></pre><p>A data structure for managing a <code>goaws</code> server process.</p><p>The passed-in <code>config</code> will be mutated in-place to add the <code>host</code> and <code>port</code> from <code>address</code>, and the <code>region</code>.</p><p>Supports <code>run</code>, as well as <code>kill</code>, <code>getpid</code>, <code>success</code>, <code>process_exited</code>, and <code>process_running</code> by forwarding to the process created by <code>run</code>.</p><p>Can also be used with <a href="#GoAWS.with_go_aws-Tuple{Any}"><code>with_go_aws</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/beacon-biosignals/GoAWS.jl/blob/22570be24d6b0d1030b7f3ab5f3568e4bf01dd89/src/server.jl#L18-L35">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="GoAWS.default_config-Tuple{}" href="#GoAWS.default_config-Tuple{}"><code>GoAWS.default_config</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">GoAWS.default_config() -&gt; Dict{Any,Any}</code></pre><p>Provides a copy of the default configuration used in <a href="#GoAWS.Server-Tuple{}"><code>Server</code></a> and <a href="#GoAWS.with_go_aws-Tuple{Any}"><code>with_go_aws</code></a>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/beacon-biosignals/GoAWS.jl/blob/22570be24d6b0d1030b7f3ab5f3568e4bf01dd89/src/GoAWS.jl#L13-L17">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="GoAWS.with_go_aws-Tuple{Any}" href="#GoAWS.with_go_aws-Tuple{Any}"><code>GoAWS.with_go_aws</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">with_go_aws(f; address=DEFAULT_ADDRESS, region=&quot;us-east-2&quot;, kw...)</code></pre><p>Starts up a GoAWS server, runs <code>f(go_aws_config::AbstractAWSConfig)</code>, with an AWS.jl-compatible config pointing to a live GoAWS server, and destroys the server when <code>f()</code> finishes or errors.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/beacon-biosignals/GoAWS.jl/blob/22570be24d6b0d1030b7f3ab5f3568e4bf01dd89/src/server.jl#L116-L121">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Tuesday 2 July 2024 15:40">Tuesday 2 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>