Skip to content

Commit

Permalink
build based on fd9befe
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Aug 13, 2024
1 parent 708a530 commit 4ea03f2
Show file tree
Hide file tree
Showing 21 changed files with 1,280 additions and 2 deletions.
2 changes: 1 addition & 1 deletion stable
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v1.0.0
v2.0.1
1 change: 1 addition & 0 deletions v2
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v2.0.1
1 change: 1 addition & 0 deletions v2.0
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v2.0.1
1 change: 1 addition & 0 deletions v2.0.1/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-13T06:22:59","documenter_version":"1.5.0"}}
2 changes: 2 additions & 0 deletions v2.0.1/api/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API Reference · FuseExchangeProtocol</title><meta name="title" content="API Reference · FuseExchangeProtocol"/><meta property="og:title" content="API Reference · FuseExchangeProtocol"/><meta property="twitter:title" content="API Reference · FuseExchangeProtocol"/><meta name="description" content="Documentation for FuseExchangeProtocol."/><meta property="og:description" content="Documentation for FuseExchangeProtocol."/><meta property="twitter:description" content="Documentation for FuseExchangeProtocol."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">FuseExchangeProtocol</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">FuseExchangeProtocoleExchangeProtocol.jl</a></li><li class="is-active"><a class="tocitem" href>API Reference</a><ul class="internal"><li><a class="tocitem" href="#FuseExchangeProtocol"><span>FuseExchangeProtocol</span></a></li></ul></li><li><a class="tocitem" href="../license/">License</a></li><li><a class="tocitem" href="../notice/">Notice</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API Reference</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API Reference</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/ProjectTorreyPines/FuseExchangeProtocol.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/ProjectTorreyPines/FuseExchangeProtocol.jl/blob/master/docs/src/api.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="API-Reference"><a class="docs-heading-anchor" href="#API-Reference">API Reference</a><a id="API-Reference-1"></a><a class="docs-heading-anchor-permalink" href="#API-Reference" title="Permalink"></a></h1><h2 id="FuseExchangeProtocol"><a class="docs-heading-anchor" href="#FuseExchangeProtocol">FuseExchangeProtocol</a><a id="FuseExchangeProtocol-1"></a><a class="docs-heading-anchor-permalink" href="#FuseExchangeProtocol" title="Permalink"></a></h2><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="FuseExchangeProtocol.has_service_provider" href="#FuseExchangeProtocol.has_service_provider"><code>FuseExchangeProtocol.has_service_provider</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">has_service_provider(client::Jedis.Client, service_name::String)</code></pre><p>Checks if there is a provider for a given service</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ProjectTorreyPines/FuseExchangeProtocol.jl/blob/fd9befeb1719481ef3dc6d76a0750fdf309555c7/src/FuseExchangeProtocol.jl#L126-L130">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="FuseExchangeProtocol.json_pop" href="#FuseExchangeProtocol.json_pop"><code>FuseExchangeProtocol.json_pop</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">json_pop(client::Jedis.Client, session_id::String, service_name::String, whoami::Symbol; timeout::Float64, error_on_timeout::Bool=true)</code></pre><p>Pops and deserializes JSON data from a Redis list, using a key derived from session<em>id, service</em>name, and whoami</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ProjectTorreyPines/FuseExchangeProtocol.jl/blob/fd9befeb1719481ef3dc6d76a0750fdf309555c7/src/FuseExchangeProtocol.jl#L37-L41">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="FuseExchangeProtocol.json_push" href="#FuseExchangeProtocol.json_push"><code>FuseExchangeProtocol.json_push</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">json_push(client::Jedis.Client, session_id::String, service_name::String, whoami::Symbol; data...)</code></pre><p>Pushes serialized JSON data into a Redis list, using a key derived from session<em>id, service</em>name, and whoami</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ProjectTorreyPines/FuseExchangeProtocol.jl/blob/fd9befeb1719481ef3dc6d76a0750fdf309555c7/src/FuseExchangeProtocol.jl#L25-L29">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="FuseExchangeProtocol.json_sprint" href="#FuseExchangeProtocol.json_sprint"><code>FuseExchangeProtocol.json_sprint</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">json_sprint(data, args...; kw...)</code></pre><p>Serializes data into a JSON string</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ProjectTorreyPines/FuseExchangeProtocol.jl/blob/fd9befeb1719481ef3dc6d76a0750fdf309555c7/src/FuseExchangeProtocol.jl#L154-L158">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="FuseExchangeProtocol.negotiate_service" href="#FuseExchangeProtocol.negotiate_service"><code>FuseExchangeProtocol.negotiate_service</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">negotiate_service(client::Jedis.Client, session_id::String, service_name::String)</code></pre><p>Initializes service negotiation by cleaning up previous keys and publishing a request on a Redis channel</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ProjectTorreyPines/FuseExchangeProtocol.jl/blob/fd9befeb1719481ef3dc6d76a0750fdf309555c7/src/FuseExchangeProtocol.jl#L139-L143">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="FuseExchangeProtocol.new_client_copy" href="#FuseExchangeProtocol.new_client_copy"><code>FuseExchangeProtocol.new_client_copy</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">new_client_copy(client_in::Jedis.Client)</code></pre><p>Creates a copy of a Jedis client with the same connection parameters.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ProjectTorreyPines/FuseExchangeProtocol.jl/blob/fd9befeb1719481ef3dc6d76a0750fdf309555c7/src/FuseExchangeProtocol.jl#L9-L13">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="FuseExchangeProtocol.raw_pop" href="#FuseExchangeProtocol.raw_pop"><code>FuseExchangeProtocol.raw_pop</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">raw_pop(client::Jedis.Client, session_id::String, service_name::String, whoami::Symbol; timeout::Float64, error_on_timeout::Bool=true)</code></pre><p>Pops raw data from a Redis list, key determined by session<em>id, service</em>name, and whoami</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ProjectTorreyPines/FuseExchangeProtocol.jl/blob/fd9befeb1719481ef3dc6d76a0750fdf309555c7/src/FuseExchangeProtocol.jl#L67-L71">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="FuseExchangeProtocol.raw_push" href="#FuseExchangeProtocol.raw_push"><code>FuseExchangeProtocol.raw_push</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">raw_push(client::Jedis.Client, session_id::String, service_name::String, whoami::Symbol, raw_data::Any)</code></pre><p>Pushes raw data into a Redis list, key determined by session<em>id, service</em>name, and whoami</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ProjectTorreyPines/FuseExchangeProtocol.jl/blob/fd9befeb1719481ef3dc6d76a0750fdf309555c7/src/FuseExchangeProtocol.jl#L49-L53">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="FuseExchangeProtocol.register_service" href="#FuseExchangeProtocol.register_service"><code>FuseExchangeProtocol.register_service</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">register_service(client::Jedis.Client, service_name::String, service_function::Function; timeout::Float64=10.0)</code></pre><p>Registers a service by subscribing to a Redis channel and invoking the service_function when a message is received</p><p>The service_function must have the following call signature:</p><pre><code class="nohighlight hljs">service_function(client::Jedis.Client, session_id::String, service_name::String; timeout::Float64)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ProjectTorreyPines/FuseExchangeProtocol.jl/blob/fd9befeb1719481ef3dc6d76a0750fdf309555c7/src/FuseExchangeProtocol.jl#L93-L101">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« FuseExchangeProtocoleExchangeProtocol.jl</a><a class="docs-footer-nextpage" href="../license/">License »</a><div class="flexbox-break"></div><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 13 August 2024 06:22">Tuesday 13 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 4ea03f2

Please sign in to comment.