helpers/_docs_/genindex.html
2025-08-17 13:28:43 +02:00

405 lines
16 KiB
HTML

<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &#8212; helpers documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/classic.css?v=67a6116b" />
<link rel="stylesheet" type="text/css" href="_static/pydoctheme.css?v=5ff89526" />
<link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="_static/pygments_dark.css?v=5349f25f" />
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" /><link rel="stylesheet" href="_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">
<link rel="shortcut icon" type="image/png" href="_static/py.svg">
<script type="text/javascript" src="_static/copybutton.js"></script>
<script type="text/javascript" src="_static/menu.js"></script>
<script type="text/javascript" src="_static/search-focus.js"></script>
<script type="text/javascript" src="_static/themetoggle.js"></script>
</head>
<body>
<div class="mobile-nav">
<input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu">
<nav class="nav-content" role="navigation">
<label for="menuToggler" class="toggler__label">
<span></span>
</label>
<span class="nav-items-wrapper">
<a href="https://www.python.org/" class="nav-logo">
<img src="_static/py.svg" alt="Python logo">
</a>
<span class="version_switcher_placeholder"></span>
<form role="search" class="search" action="search.html" method="get">
<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
<path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>
</svg>
<input placeholder="Quick search" aria-label="Quick search" type="search" name="q">
<input type="submit" value="Go">
</form>
</span>
</nav>
<div class="menu-wrapper">
<nav class="menu" role="navigation" aria-label="main navigation">
<div class="language_switcher_placeholder"></div>
<label class="theme-selector-label">
Theme
<select class="theme-selector" oninput="activateTheme(this.value)">
<option value="auto" selected>Auto</option>
<option value="light">Light</option>
<option value="dark">Dark</option>
</select>
</label>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</nav>
</div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><img src="_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>
<li><a href="https://www.python.org/">Python</a> &#187;</li>
<li class="switchers">
<div class="language_switcher_placeholder"></div>
<div class="version_switcher_placeholder"></div>
</li>
<li>
<a href="index.html">helpers documentation</a> &#187;
</li>
<li class="nav-item nav-item-this"><a href="">Index</a></li>
<li class="right">
<div class="inline-search" role="search">
<form class="inline-search" action="search.html" method="get">
<input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">
<input type="submit" value="Go">
</form>
</div>
|
</li>
<li class="right">
<label class="theme-selector-label">
Theme
<select class="theme-selector" oninput="activateTheme(this.value)">
<option value="auto" selected>Auto</option>
<option value="light">Light</option>
<option value="dark">Dark</option>
</select>
</label> |</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
<a href="#A"><strong>A</strong></a>
| <a href="#C"><strong>C</strong></a>
| <a href="#D"><strong>D</strong></a>
| <a href="#E"><strong>E</strong></a>
| <a href="#H"><strong>H</strong></a>
| <a href="#I"><strong>I</strong></a>
| <a href="#M"><strong>M</strong></a>
| <a href="#P"><strong>P</strong></a>
| <a href="#Q"><strong>Q</strong></a>
| <a href="#R"><strong>R</strong></a>
| <a href="#S"><strong>S</strong></a>
</div>
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="helpers.html#helpers.ringbuffer.append">append() (helpers.ringbuffer method)</a>
</li>
</ul></td>
</tr></table>
<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="helpers.html#helpers.direct_socket_client.connect">connect() (helpers.direct_socket_client method)</a>
<ul>
<li><a href="helpers.html#helpers.direct_socket_stp_client.connect">(helpers.direct_socket_stp_client method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="helpers.html#helpers.continues_statistic">continues_statistic (class in helpers)</a>
</li>
<li><a href="helpers.html#helpers.continues_statistic_multivalue">continues_statistic_multivalue (class in helpers)</a>
</li>
</ul></td>
</tr></table>
<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="helpers.html#helpers.direct_socket_base.DEFAULT_CHANNEL_NAME">DEFAULT_CHANNEL_NAME (helpers.direct_socket_base attribute)</a>
</li>
<li><a href="helpers.html#helpers.direct_socket_base">direct_socket_base (class in helpers)</a>
</li>
<li><a href="helpers.html#helpers.direct_socket_client">direct_socket_client (class in helpers)</a>
</li>
<li><a href="helpers.html#helpers.direct_socket_server">direct_socket_server (class in helpers)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="helpers.html#helpers.direct_socket_stp_base">direct_socket_stp_base (class in helpers)</a>
</li>
<li><a href="helpers.html#helpers.direct_socket_stp_client">direct_socket_stp_client (class in helpers)</a>
</li>
<li><a href="helpers.html#helpers.direct_socket_stp_server">direct_socket_stp_server (class in helpers)</a>
</li>
<li><a href="helpers.html#helpers.direct_socket_base.disconnect">disconnect() (helpers.direct_socket_base method)</a>
</li>
</ul></td>
</tr></table>
<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="helpers.html#helpers.ringbuffer.extend">extend() (helpers.ringbuffer method)</a>
</li>
</ul></td>
</tr></table>
<h2 id="H">H</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
helpers
<ul>
<li><a href="helpers.html#module-helpers">module</a>
</li>
</ul></li>
</ul></td>
</tr></table>
<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="helpers.html#helpers.direct_socket_base.init_channel_name">init_channel_name() (helpers.direct_socket_base method)</a>
</li>
<li><a href="helpers.html#helpers.direct_socket_base.IS_CLIENT">IS_CLIENT (helpers.direct_socket_base attribute)</a>
<ul>
<li><a href="helpers.html#helpers.direct_socket_client.IS_CLIENT">(helpers.direct_socket_client attribute)</a>
</li>
<li><a href="helpers.html#helpers.direct_socket_server.IS_CLIENT">(helpers.direct_socket_server attribute)</a>
</li>
<li><a href="helpers.html#helpers.direct_socket_stp_base.IS_CLIENT">(helpers.direct_socket_stp_base attribute)</a>
</li>
<li><a href="helpers.html#helpers.direct_socket_stp_client.IS_CLIENT">(helpers.direct_socket_stp_client attribute)</a>
</li>
<li><a href="helpers.html#helpers.direct_socket_stp_server.IS_CLIENT">(helpers.direct_socket_stp_server attribute)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="helpers.html#helpers.direct_socket_base.is_connected">is_connected() (helpers.direct_socket_base method)</a>
</li>
</ul></td>
</tr></table>
<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="helpers.html#helpers.continues_statistic.max">max (helpers.continues_statistic property)</a>
</li>
<li><a href="helpers.html#helpers.continues_statistic.mean">mean (helpers.continues_statistic property)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="helpers.html#helpers.continues_statistic.min">min (helpers.continues_statistic property)</a>
</li>
<li>
module
<ul>
<li><a href="helpers.html#module-helpers">helpers</a>
</li>
</ul></li>
</ul></td>
</tr></table>
<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="helpers.html#helpers.continues_statistic.pop">pop() (helpers.continues_statistic method)</a>
<ul>
<li><a href="helpers.html#helpers.continues_statistic_multivalue.pop">(helpers.continues_statistic_multivalue method)</a>
</li>
</ul></li>
</ul></td>
</tr></table>
<h2 id="Q">Q</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="helpers.html#helpers.continues_statistic.quantifier">quantifier (helpers.continues_statistic property)</a>
</li>
</ul></td>
</tr></table>
<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="helpers.html#helpers.direct_socket_base.receive">receive() (helpers.direct_socket_base method)</a>
<ul>
<li><a href="helpers.html#helpers.direct_socket_stp_base.receive">(helpers.direct_socket_stp_base method)</a>
</li>
</ul></li>
<li><a href="helpers.html#helpers.direct_socket_client.reconnect">reconnect() (helpers.direct_socket_client method)</a>
<ul>
<li><a href="helpers.html#helpers.direct_socket_stp_client.reconnect">(helpers.direct_socket_stp_client method)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="helpers.html#helpers.direct_socket_base.register_callback">register_callback() (helpers.direct_socket_base method)</a>
</li>
<li><a href="helpers.html#helpers.direct_socket_base.register_connect_callback">register_connect_callback() (helpers.direct_socket_base method)</a>
</li>
<li><a href="helpers.html#helpers.direct_socket_base.register_disconnect_callback">register_disconnect_callback() (helpers.direct_socket_base method)</a>
</li>
<li><a href="helpers.html#helpers.ringbuffer">ringbuffer (class in helpers)</a>
</li>
</ul></td>
</tr></table>
<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="helpers.html#helpers.direct_socket_base.send">send() (helpers.direct_socket_base method)</a>
</li>
</ul></td>
</tr></table>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><img src="_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"></li>
<li><a href="https://www.python.org/">Python</a> &#187;</li>
<li class="switchers">
<div class="language_switcher_placeholder"></div>
<div class="version_switcher_placeholder"></div>
</li>
<li>
<a href="index.html">helpers documentation</a> &#187;
</li>
<li class="nav-item nav-item-this"><a href="">Index</a></li>
<li class="right">
<div class="inline-search" role="search">
<form class="inline-search" action="search.html" method="get">
<input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box">
<input type="submit" value="Go">
</form>
</div>
|
</li>
<li class="right">
<label class="theme-selector-label">
Theme
<select class="theme-selector" oninput="activateTheme(this.value)">
<option value="auto" selected>Auto</option>
<option value="light">Light</option>
<option value="dark">Dark</option>
</select>
</label> |</li>
</ul>
</div>
<div class="footer">
&copy;
Copyright
2025, Dirk Alders.
<br>
This page is licensed under the Python Software Foundation License Version 2.
<br>
Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
<br>
<br>
The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>
<br>
<br>
<br>
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</body>
</html>