cerc-io/plugeth-utils
13
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
708c7643ee
plugeth-utils/docs/_build/html/plugin_loader.html
philip-morlier 708c7643ee
Moving Austin's work into most current version
2021-10-05 15:43:09 -07:00

172 lines
10 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Plugin Loader &mdash; Plugeth Austin Roberts documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Selected Plugin Hooks" href="hooks.html" />
<link rel="prev" title="API" href="api.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Plugeth
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Overview</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="project.html">Project Design</a></li>
<li class="toctree-l1"><a class="reference internal" href="types.html">Basic Types of Plugins</a></li>
</ul>
<p class="caption"><span class="caption-text">Tutorials</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="install.html">Install</a></li>
<li class="toctree-l1"><a class="reference internal" href="build.html">Build and Deploy</a></li>
<li class="toctree-l1"><a class="reference internal" href="custom.html">Building a Custom Plugin</a></li>
</ul>
<p class="caption"><span class="caption-text">Reference</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="system_req.html">System Requirements</a></li>
<li class="toctree-l1"><a class="reference internal" href="version.html">Version</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Plugin Loader</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#lookup">Lookup</a></li>
<li class="toctree-l2"><a class="reference internal" href="#getfeed">GetFeed</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="hooks.html">Selected Plugin Hooks</a></li>
<li class="toctree-l1"><a class="reference internal" href="hook_writing.html">Hook Writing Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="core_restricted.html">PluGeth-utils Subpackages</a></li>
</ul>
<p class="caption"><span class="caption-text">Contact</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="contact.html">Get in touch with us</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Plugeth</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Plugin Loader</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/plugin_loader.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="plugin-loader">
<span id="id1"></span><h1>Plugin Loader<a class="headerlink" href="#plugin-loader" title="Permalink to this headline"></a></h1>
<p>The Plugin Loader is provided to each Plugin through the Initialize()``
function. It provides plugins with:</p>
<div class="section" id="lookup">
<h2>Lookup<a class="headerlink" href="#lookup" title="Permalink to this headline"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">Lookup(name</span> <span class="pre">string,</span> <span class="pre">validate</span> <span class="pre">func(interface{})</span> <span class="pre">bool)</span> <span class="pre">[]interface{}</span></code></p>
<p>Returns a list of values from plugins identified by <code class="docutils literal notranslate"><span class="pre">name</span></code>, which match the
provided <code class="docutils literal notranslate"><span class="pre">validate</span></code> predicate. For example:</p>
<div class="highlight-go notranslate"><div class="highlight"><pre><span></span><span class="nx">pl</span><span class="p">.</span><span class="nx">Lookup</span><span class="p">(</span><span class="s">&quot;Version&quot;</span><span class="p">,</span> <span class="kd">func</span><span class="p">(</span><span class="nx">item</span> <span class="kd">interface</span><span class="p">{})</span> <span class="kt">bool</span> <span class="p">{</span>
<span class="nx">_</span><span class="p">,</span> <span class="nx">ok</span> <span class="o">:=</span> <span class="nx">item</span><span class="p">.(</span><span class="kt">int</span><span class="p">)</span>
<span class="k">return</span> <span class="nx">ok</span>
<span class="p">})</span>
</pre></div>
</div>
<p>Would return a list of <code class="docutils literal notranslate"><span class="pre">int</span></code> objects named <code class="docutils literal notranslate"><span class="pre">Version</span></code> in any loaded plugins.
This can enable Plugins to interact with each other, accessing values and
functions implemented in other plugins.</p>
</div>
<div class="section" id="getfeed">
<h2>GetFeed<a class="headerlink" href="#getfeed" title="Permalink to this headline"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">GetFeed()</span> <span class="pre">Feed</span></code></p>
<p>Returns a new feed that the plugin can used for publish/subscribe models.</p>
<p>For example:</p>
<div class="highlight-go notranslate"><div class="highlight"><pre><span></span><span class="nx">feed</span> <span class="o">:=</span> <span class="nx">pl</span><span class="p">.</span><span class="nx">GetFeed</span><span class="p">()</span>
<span class="k">go</span> <span class="kd">func</span><span class="p">()</span> <span class="p">{</span>
<span class="nx">ch</span> <span class="o">:=</span> <span class="nb">make</span><span class="p">(</span><span class="kd">chan</span> <span class="kt">string</span><span class="p">)</span>
<span class="nx">sub</span> <span class="o">:=</span> <span class="nx">feed</span><span class="p">.</span><span class="nx">Subscribe</span><span class="p">(</span><span class="nx">ch</span><span class="p">)</span>
<span class="k">for</span> <span class="p">{</span>
<span class="k">select</span> <span class="p">{</span>
<span class="k">case</span> <span class="nx">item</span> <span class="o">:=</span> <span class="o">&lt;-</span><span class="nx">ch</span><span class="p">:</span>
<span class="c1">// Do something with item</span>
<span class="k">case</span> <span class="nx">err</span> <span class="o">:=</span> <span class="p">&lt;</span><span class="nx">sub</span><span class="p">.</span><span class="nx">Err</span><span class="p">():</span>
<span class="nx">log</span><span class="p">.</span><span class="nx">Error</span><span class="p">(</span><span class="s">&quot;An error has occurred&quot;</span><span class="p">,</span> <span class="s">&quot;err&quot;</span><span class="p">,</span> <span class="nx">err</span><span class="p">)</span>
<span class="nx">sub</span><span class="p">.</span><span class="nx">Unsubscribe</span><span class="p">()</span>
<span class="nb">close</span><span class="p">(</span><span class="nx">ch</span><span class="p">)</span>
<span class="k">return</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}()</span>
<span class="nx">feed</span><span class="p">.</span><span class="nx">Send</span><span class="p">(</span><span class="s">&quot;hello&quot;</span><span class="p">)</span>
<span class="nx">feed</span><span class="p">.</span><span class="nx">Send</span><span class="p">(</span><span class="s">&quot;world&quot;</span><span class="p">)</span>
</pre></div>
</div>
<p>Note that you can send any type through a feed, but the subscribed channel and
sent objects must be of matching types.</p>
</div>
</div>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="api.html" class="btn btn-neutral float-left" title="API" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="hooks.html" class="btn btn-neutral float-right" title="Selected Plugin Hooks" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021, Philip Morlier.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink