node-red-contrib-sitx

<!DOCTYPE html> <html class="writer-html5" lang="en" > <head> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>pytak.RXWorker — PyTAK 0.1.1 documentation</title> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />  <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> <script src="../_static/doctools.js"></script> <script src="../_static/sphinx_highlight.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="pytak.QueueWorker" href="pytak.QueueWorker.html" /> <link rel="prev" title="pytak.TXWorker" href="pytak.TXWorker.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"> PyTAK </a> <div class="version"> 0.1.1 </div> <div role="search"> <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> <input type="text" name="q" placeholder="Search docs" aria-label="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"> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="../config.html">Configuration</a></li> <li class="toctree-l1"><a class="reference internal" href="../compat.html">Compatibility</a></li> <li class="toctree-l1"><a class="reference internal" href="../clients.html">Clients</a></li> <li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li> <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="pytak.html">pytak</a></li> <li class="toctree-l2"><a class="reference internal" href="pytak.Worker.html">pytak.Worker</a></li> <li class="toctree-l2"><a class="reference internal" href="pytak.TXWorker.html">pytak.TXWorker</a></li> <li class="toctree-l2 current"><a class="current reference internal" href="#">pytak.RXWorker</a><ul> <li class="toctree-l3"><a class="reference internal" href="#pytak.RXWorker"><code class="docutils literal notranslate"><span class="pre">RXWorker</span></code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#pytak.RXWorker.__init__"><code class="docutils literal notranslate"><span class="pre">RXWorker.__init__()</span></code></a></li> </ul> </li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="pytak.QueueWorker.html">pytak.QueueWorker</a></li> <li class="toctree-l2"><a class="reference internal" href="pytak.CLITool.html">pytak.CLITool</a></li> <li class="toctree-l2"><a class="reference internal" href="pytak.create_udp_client.html">pytak.create_udp_client</a></li> <li class="toctree-l2"><a class="reference internal" href="pytak.protocol_factory.html">pytak.protocol_factory</a></li> <li class="toctree-l2"><a class="reference internal" href="pytak.txworker_factory.html">pytak.txworker_factory</a></li> <li class="toctree-l2"><a class="reference internal" href="pytak.rxworker_factory.html">pytak.rxworker_factory</a></li> <li class="toctree-l2"><a class="reference internal" href="pytak.cli.html">pytak.cli</a></li> <li class="toctree-l2"><a class="reference internal" href="pytak.read_pref_package.html">pytak.read_pref_package</a></li> </ul> </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">PyTAK</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" aria-label="Home"></a></li> <li class="breadcrumb-item"><a href="../api.html">API</a></li> <li class="breadcrumb-item active">pytak.RXWorker</li> <li class="wy-breadcrumbs-aside"> <a href="../_sources/generated/pytak.RXWorker.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"> <section id="pytak-rxworker"> <h1>pytak.RXWorker<a class="headerlink" href="#pytak-rxworker" title="Permalink to this heading"></a></h1> <dl class="py class"> <dt class="sig sig-object py" id="pytak.RXWorker"> <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pytak.</span></span><span class="sig-name descname"><span class="pre">RXWorker</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">queue</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Queue</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Queue</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">SectionProxy</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reader</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Protocol</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pytak.RXWorker" title="Permalink to this definition"></a></dt> <dd><p>Async receive (input) queue worker.</p> <p>Reads events from a <cite>pytak.protocol_factory()</cite> reader and adds them to an <cite>rx_queue</cite>.</p> <p>Most implementations use this to drain an RX buffer on a socket.</p> <p>pytak([asyncio.Protocol]->[pytak.EventReceiver]->[queue.Queue])</p> <dl class="py method"> <dt class="sig sig-object py" id="pytak.RXWorker.__init__"> <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">queue</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Queue</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Queue</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">SectionProxy</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reader</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Protocol</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#pytak.RXWorker.__init__" title="Permalink to this definition"></a></dt> <dd><p>Initialize a RXWorker instance.</p> </dd></dl> <p class="rubric">Methods</p> <table class="autosummary longtable docutils align-default"> <tbody> <tr class="row-odd"><td><p><a class="reference internal" href="#pytak.RXWorker.__init__" title="pytak.RXWorker.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>(queue, config, reader)</p></td> <td><p>Initialize a RXWorker instance.</p></td> </tr> <tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">fts_compat</span></code>()</p></td> <td><p>Apply FreeTAKServer (FTS) compatibility.</p></td> </tr> <tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">handle_data</span></code>(data)</p></td> <td><p>Handle data (placeholder method, please override).</p></td> </tr> <tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">readcot</span></code>()</p></td> <td><p>Read CoT from the wire until we hit an event boundary.</p></td> </tr> <tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">run</span></code>([number_of_iterations])</p></td> <td><p>Run this worker.</p></td> </tr> </tbody> </table> </dd></dl> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="pytak.TXWorker.html" class="btn btn-neutral float-left" title="pytak.TXWorker" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="pytak.QueueWorker.html" class="btn btn-neutral float-right" title="pytak.QueueWorker" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div> <hr/> <div role="contentinfo"> <p>© Copyright 2023 Sensors & Signals LLC.</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>