pylib/socket_protocol
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
socket_protocol/_docs_/index.html

801 lines
43 KiB
HTML
Raw Normal View History

Documentation update
2021-01-01 20:16:12 +01:00
<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Welcome to socket_protocol’s documentation! &mdash; socket_protocol 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 type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.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="#" class="icon icon-home" alt="Documentation Home"> socket_protocol
</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="main navigation">
<!-- Local TOC -->
<div class="local-toc"><ul>
<li><a class="reference internal" href="#">Welcome to socket_protocol’s documentation!</a><ul>
<li><a class="reference internal" href="#socket-protocol-socket-protocol">socket_protocol (Socket Protocol)</a></li>
</ul>
</li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</div>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">socket_protocol</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home"></a> &raquo;</li>
<li>Welcome to socket_protocol’s documentation!</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.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="module-socket_protocol">
<span id="welcome-to-socket-protocol-s-documentation"></span><h1>Welcome to socket_protocol’s documentation!<a class="headerlink" href="#module-socket_protocol" title="Permalink to this headline"></a></h1>
<div class="section" id="socket-protocol-socket-protocol">
<h2>socket_protocol (Socket Protocol)<a class="headerlink" href="#socket-protocol-socket-protocol" title="Permalink to this headline"></a></h2>
<p><strong>Author:</strong></p>
<ul class="simple">
<li>Dirk Alders &lt;<a class="reference external" href="mailto:sudo-dirk&#37;&#52;&#48;mount-mockery&#46;de">sudo-dirk<span>&#64;</span>mount-mockery<span>&#46;</span>de</a>&gt;</li>
</ul>
<p><strong>Description:</strong></p>
<blockquote>
<div>This Module supports point to point communication for client-server issues.</div></blockquote>
<p><strong>Submodules:</strong></p>
<ul class="simple">
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<li><a class="reference internal" href="#socket_protocol.data_storage" title="socket_protocol.data_storage"><code class="xref py py-class docutils literal notranslate"><span class="pre">socket_protocol.data_storage</span></code></a></li>
Documentation update
2021-01-01 20:16:12 +01:00
<li><a class="reference internal" href="#socket_protocol.pure_json_protocol" title="socket_protocol.pure_json_protocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">socket_protocol.pure_json_protocol</span></code></a></li>
<li><a class="reference internal" href="#socket_protocol.struct_json_protocol" title="socket_protocol.struct_json_protocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">socket_protocol.struct_json_protocol</span></code></a></li>
</ul>
<p><strong>Unittest:</strong></p>
<blockquote>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<div>See also the <a class="reference download internal" download="" href="_downloads/37503cb17b21b2c78bb8b07730976f24/unittest.pdf"><code class="xref download docutils literal notranslate"><span class="pre">unittest</span></code></a> documentation.</div></blockquote>
Documentation update
2021-01-01 20:16:12 +01:00
<p><strong>Module Documentation:</strong></p>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<dl class="data">
<dt id="socket_protocol.AUTH_STATE_KEY_TRANSFERRED">
<code class="descclassname">socket_protocol.</code><code class="descname">AUTH_STATE_KEY_TRANSFERRED</code><em class="property"> = 3</em><a class="headerlink" href="#socket_protocol.AUTH_STATE_KEY_TRANSFERRED" title="Permalink to this definition"></a></dt>
<dd><p>Authentification Status for ‘Key has been sent’</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.AUTH_STATE_SEED_REQUESTED">
<code class="descclassname">socket_protocol.</code><code class="descname">AUTH_STATE_SEED_REQUESTED</code><em class="property"> = 1</em><a class="headerlink" href="#socket_protocol.AUTH_STATE_SEED_REQUESTED" title="Permalink to this definition"></a></dt>
<dd><p>Authentification Status for ‘Seed was requested’</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.AUTH_STATE_SEED_TRANSFERRED">
<code class="descclassname">socket_protocol.</code><code class="descname">AUTH_STATE_SEED_TRANSFERRED</code><em class="property"> = 2</em><a class="headerlink" href="#socket_protocol.AUTH_STATE_SEED_TRANSFERRED" title="Permalink to this definition"></a></dt>
<dd><p>Authentification Status for ‘Seed has been sent’</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.AUTH_STATE_TRUSTED_CONNECTION">
<code class="descclassname">socket_protocol.</code><code class="descname">AUTH_STATE_TRUSTED_CONNECTION</code><em class="property"> = 4</em><a class="headerlink" href="#socket_protocol.AUTH_STATE_TRUSTED_CONNECTION" title="Permalink to this definition"></a></dt>
<dd><p>Authentification Status for a ‘Trusted Connection’</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.AUTH_STATE_UNTRUSTED_CONNECTION">
<code class="descclassname">socket_protocol.</code><code class="descname">AUTH_STATE_UNTRUSTED_CONNECTION</code><em class="property"> = 0</em><a class="headerlink" href="#socket_protocol.AUTH_STATE_UNTRUSTED_CONNECTION" title="Permalink to this definition"></a></dt>
<dd><p>Authentification Status for an ‘Untrusted Connection’</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.AUTH_STATE__NAMES">
<code class="descclassname">socket_protocol.</code><code class="descname">AUTH_STATE__NAMES</code><em class="property"> = {0: 'Untrusted Connection', 1: 'Seed was requested', 2: 'Seed has been sent', 3: 'Key has been sent', 4: 'Trusted Connection'}</em><a class="headerlink" href="#socket_protocol.AUTH_STATE__NAMES" title="Permalink to this definition"></a></dt>
<dd><p>Authentification Status names for previous defined authentification states</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.DID_AUTH_KEY">
<code class="descclassname">socket_protocol.</code><code class="descname">DID_AUTH_KEY</code><em class="property"> = 1</em><a class="headerlink" href="#socket_protocol.DID_AUTH_KEY" title="Permalink to this definition"></a></dt>
<dd><p>DID for authentification (key)</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.DID_AUTH_SEED">
<code class="descclassname">socket_protocol.</code><code class="descname">DID_AUTH_SEED</code><em class="property"> = 0</em><a class="headerlink" href="#socket_protocol.DID_AUTH_SEED" title="Permalink to this definition"></a></dt>
<dd><p>DID for authentification (seed)</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.DID_CHANNEL_NAME">
<code class="descclassname">socket_protocol.</code><code class="descname">DID_CHANNEL_NAME</code><em class="property"> = 0</em><a class="headerlink" href="#socket_protocol.DID_CHANNEL_NAME" title="Permalink to this definition"></a></dt>
<dd><p>DID for channel name</p>
</dd></dl>
<dl class="exception">
<dt id="socket_protocol.RequestSidExistsError">
<em class="property">exception </em><code class="descclassname">socket_protocol.</code><code class="descname">RequestSidExistsError</code><a class="headerlink" href="#socket_protocol.RequestSidExistsError" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="exception">
<dt id="socket_protocol.ResponseSidExistsError">
<em class="property">exception </em><code class="descclassname">socket_protocol.</code><code class="descname">ResponseSidExistsError</code><a class="headerlink" href="#socket_protocol.ResponseSidExistsError" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="socket_protocol.SID_AUTH_REQUEST">
<code class="descclassname">socket_protocol.</code><code class="descname">SID_AUTH_REQUEST</code><em class="property"> = 0</em><a class="headerlink" href="#socket_protocol.SID_AUTH_REQUEST" title="Permalink to this definition"></a></dt>
<dd><p>SID for authentification request</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.SID_AUTH_RESPONSE">
<code class="descclassname">socket_protocol.</code><code class="descname">SID_AUTH_RESPONSE</code><em class="property"> = 1</em><a class="headerlink" href="#socket_protocol.SID_AUTH_RESPONSE" title="Permalink to this definition"></a></dt>
<dd><p>SID for authentification response</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.SID_CHANNEL_NAME_REQUEST">
<code class="descclassname">socket_protocol.</code><code class="descname">SID_CHANNEL_NAME_REQUEST</code><em class="property"> = 8</em><a class="headerlink" href="#socket_protocol.SID_CHANNEL_NAME_REQUEST" title="Permalink to this definition"></a></dt>
<dd><p>SID for channel name exchange request</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.SID_CHANNEL_NAME_RESPONSE">
<code class="descclassname">socket_protocol.</code><code class="descname">SID_CHANNEL_NAME_RESPONSE</code><em class="property"> = 9</em><a class="headerlink" href="#socket_protocol.SID_CHANNEL_NAME_RESPONSE" title="Permalink to this definition"></a></dt>
<dd><p>SID for channel name exchange response</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.SID_EXECUTE_REQUEST">
<code class="descclassname">socket_protocol.</code><code class="descname">SID_EXECUTE_REQUEST</code><em class="property"> = 30</em><a class="headerlink" href="#socket_protocol.SID_EXECUTE_REQUEST" title="Permalink to this definition"></a></dt>
<dd><p>SID for a execute request</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.SID_EXECUTE_RESPONSE">
<code class="descclassname">socket_protocol.</code><code class="descname">SID_EXECUTE_RESPONSE</code><em class="property"> = 31</em><a class="headerlink" href="#socket_protocol.SID_EXECUTE_RESPONSE" title="Permalink to this definition"></a></dt>
<dd><p>SID for a execute response</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.SID_READ_REQUEST">
<code class="descclassname">socket_protocol.</code><code class="descname">SID_READ_REQUEST</code><em class="property"> = 10</em><a class="headerlink" href="#socket_protocol.SID_READ_REQUEST" title="Permalink to this definition"></a></dt>
<dd><p>SID for a read data request</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.SID_READ_RESPONSE">
<code class="descclassname">socket_protocol.</code><code class="descname">SID_READ_RESPONSE</code><em class="property"> = 11</em><a class="headerlink" href="#socket_protocol.SID_READ_RESPONSE" title="Permalink to this definition"></a></dt>
<dd><p>SID for read data response</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.SID_WRITE_REQUEST">
<code class="descclassname">socket_protocol.</code><code class="descname">SID_WRITE_REQUEST</code><em class="property"> = 20</em><a class="headerlink" href="#socket_protocol.SID_WRITE_REQUEST" title="Permalink to this definition"></a></dt>
<dd><p>SID for a write data request</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.SID_WRITE_RESPONSE">
<code class="descclassname">socket_protocol.</code><code class="descname">SID_WRITE_RESPONSE</code><em class="property"> = 21</em><a class="headerlink" href="#socket_protocol.SID_WRITE_RESPONSE" title="Permalink to this definition"></a></dt>
<dd><p>SID for a write data response</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.STATUS_AUTH_REQUIRED">
<code class="descclassname">socket_protocol.</code><code class="descname">STATUS_AUTH_REQUIRED</code><em class="property"> = 3</em><a class="headerlink" href="#socket_protocol.STATUS_AUTH_REQUIRED" title="Permalink to this definition"></a></dt>
<dd><p>Status for ‘authentification is required’</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.STATUS_BUFFERING_UNHANDLED_REQUEST">
<code class="descclassname">socket_protocol.</code><code class="descname">STATUS_BUFFERING_UNHANDLED_REQUEST</code><em class="property"> = 1</em><a class="headerlink" href="#socket_protocol.STATUS_BUFFERING_UNHANDLED_REQUEST" title="Permalink to this definition"></a></dt>
<dd><p>Status for ‘unhandled request’</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.STATUS_CALLBACK_ERROR">
<code class="descclassname">socket_protocol.</code><code class="descname">STATUS_CALLBACK_ERROR</code><em class="property"> = 2</em><a class="headerlink" href="#socket_protocol.STATUS_CALLBACK_ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Status for ‘callback errors’</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.STATUS_CHECKSUM_ERROR">
<code class="descclassname">socket_protocol.</code><code class="descname">STATUS_CHECKSUM_ERROR</code><em class="property"> = 5</em><a class="headerlink" href="#socket_protocol.STATUS_CHECKSUM_ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Status for ‘checksum error’</p>
</dd></dl>
Release b2cd74413a21bced599aa52431777de0; Logging + Restructuring
2021-01-11 07:36:18 +01:00
<dl class="data">
<dt id="socket_protocol.STATUS_LOG_LVL">
<code class="descclassname">socket_protocol.</code><code class="descname">STATUS_LOG_LVL</code><em class="property"> = {0: 20, 1: 30, 2: 40, 3: 30, 4: 40, 5: 40, 6: 30}</em><a class="headerlink" href="#socket_protocol.STATUS_LOG_LVL" title="Permalink to this definition"></a></dt>
<dd><p>Status depending log level for messages</p>
</dd></dl>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<dl class="data">
<dt id="socket_protocol.STATUS_OKAY">
<code class="descclassname">socket_protocol.</code><code class="descname">STATUS_OKAY</code><em class="property"> = 0</em><a class="headerlink" href="#socket_protocol.STATUS_OKAY" title="Permalink to this definition"></a></dt>
<dd><p>Status for ‘okay’</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.STATUS_OPERATION_NOT_PERMITTED">
<code class="descclassname">socket_protocol.</code><code class="descname">STATUS_OPERATION_NOT_PERMITTED</code><em class="property"> = 6</em><a class="headerlink" href="#socket_protocol.STATUS_OPERATION_NOT_PERMITTED" title="Permalink to this definition"></a></dt>
<dd><p>Status for ‘operation not permitted’</p>
</dd></dl>
<dl class="data">
<dt id="socket_protocol.STATUS_SERVICE_OR_DATA_UNKNOWN">
<code class="descclassname">socket_protocol.</code><code class="descname">STATUS_SERVICE_OR_DATA_UNKNOWN</code><em class="property"> = 4</em><a class="headerlink" href="#socket_protocol.STATUS_SERVICE_OR_DATA_UNKNOWN" title="Permalink to this definition"></a></dt>
<dd><p>Status for ‘service or data unknown’</p>
</dd></dl>
Documentation update
2021-01-01 20:16:12 +01:00
<dl class="class">
<dt id="socket_protocol.data_storage">
<em class="property">class </em><code class="descclassname">socket_protocol.</code><code class="descname">data_storage</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#socket_protocol.data_storage" title="Permalink to this definition"></a></dt>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<dd><p>This is a storage object for socket_protocol messages.</p>
<table class="docutils field-list" frame="void" rules="none">
Documentation update
2021-01-01 20:16:12 +01:00
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>status</strong> (<em>int</em>) – The message status.</li>
<li><strong>service_id</strong> (<em>int</em>) – The Service-ID.</li>
<li><strong>data_id</strong> (<em>int</em>) – The Data-ID.</li>
<li><strong>data</strong> (<em>any</em>) – The transfered data.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="socket_protocol.data_storage.get_data">
<code class="descname">get_data</code><span class="sig-paren">(</span><em>default=None</em><span class="sig-paren">)</span><a class="headerlink" href="#socket_protocol.data_storage.get_data" title="Permalink to this definition"></a></dt>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<dd><p>This Method returns the message data.</p>
<table class="docutils field-list" frame="void" rules="none">
Documentation update
2021-01-01 20:16:12 +01:00
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>default</strong> – The default value, if no data is available.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="socket_protocol.data_storage.get_data_id">
<code class="descname">get_data_id</code><span class="sig-paren">(</span><em>default=None</em><span class="sig-paren">)</span><a class="headerlink" href="#socket_protocol.data_storage.get_data_id" title="Permalink to this definition"></a></dt>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<dd><p>This Method returns the message Data-ID.</p>
<table class="docutils field-list" frame="void" rules="none">
Documentation update
2021-01-01 20:16:12 +01:00
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>default</strong> – The default value, if no data is available.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="socket_protocol.data_storage.get_service_id">
<code class="descname">get_service_id</code><span class="sig-paren">(</span><em>default=None</em><span class="sig-paren">)</span><a class="headerlink" href="#socket_protocol.data_storage.get_service_id" title="Permalink to this definition"></a></dt>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<dd><p>This Method returns the message Service-ID.</p>
<table class="docutils field-list" frame="void" rules="none">
Documentation update
2021-01-01 20:16:12 +01:00
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>default</strong> – The default value, if no data is available.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="socket_protocol.data_storage.get_status">
<code class="descname">get_status</code><span class="sig-paren">(</span><em>default=None</em><span class="sig-paren">)</span><a class="headerlink" href="#socket_protocol.data_storage.get_status" title="Permalink to this definition"></a></dt>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<dd><p>This Method returns the message status.</p>
<table class="docutils field-list" frame="void" rules="none">
Documentation update
2021-01-01 20:16:12 +01:00
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>default</strong> – The default value, if no data is available.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="socket_protocol.pure_json_protocol">
<em class="property">class </em><code class="descclassname">socket_protocol.</code><code class="descname">pure_json_protocol</code><span class="sig-paren">(</span><em>comm_instance</em>, <em>secret=None</em>, <em>auto_auth=False</em>, <em>channel_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#socket_protocol.pure_json_protocol" title="Permalink to this definition"></a></dt>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<dd><p>This <cite>class</cite> supports to transfer a message and it’s data.</p>
<table class="docutils field-list" frame="void" rules="none">
Documentation update
2021-01-01 20:16:12 +01:00
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>comm_instance</strong> (<em>instance</em>) – A communication instance.</li>
<li><strong>secret</strong> (<em>str</em>) – An optinal secret (e.g. created by <code class="docutils literal notranslate"><span class="pre">binascii.hexlify(os.urandom(24))</span></code>).</li>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<li><strong>auto_auth</strong> (<em>bool</em>) – An optional parameter to enable (True) automatic authentification, otherwise you need to do it manually, if needed.</li>
Documentation update
2021-01-01 20:16:12 +01:00
<li><strong>channel_name</strong> (<em>str</em>) – An optional parameter to set a channel name for logging of the communication.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="admonition hint">
<p class="first admonition-title">Hint</p>
<ul class="last simple">
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<li>The Service-ID is designed to identify the type of the communication (e.g. <code class="xref py py-const docutils literal notranslate"><span class="pre">READ_REQUEST</span></code>, <code class="xref py py-const docutils literal notranslate"><span class="pre">WRITE_REQUEST</span></code>, <code class="xref py py-const docutils literal notranslate"><span class="pre">READ_RESPONSE</span></code>, <code class="xref py py-const docutils literal notranslate"><span class="pre">WRITE_RESPONSE</span></code>, …)</li>
Documentation update
2021-01-01 20:16:12 +01:00
<li>The Data-ID is designed to identify the requests / responses using the same Service_ID.</li>
</ul>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>The <code class="xref py py-class docutils literal notranslate"><span class="pre">comm_instance</span></code> needs to have at least the following interface:</p>
<ul class="last simple">
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<li>A Method <code class="xref py py-func docutils literal notranslate"><span class="pre">comm_instance.init_channel_name()</span></code> to set the channel name.</li>
Documentation update
2021-01-01 20:16:12 +01:00
<li>A Constant <code class="xref py py-const docutils literal notranslate"><span class="pre">comm_instance.IS_CLIENT</span></code> to identify that the <code class="xref py py-class docutils literal notranslate"><span class="pre">comm_instance</span></code> is a client (True) or a server (False).</li>
<li>A Method <code class="xref py py-func docutils literal notranslate"><span class="pre">comm_instance.is_connected()</span></code> to identify if the instance is connected (True) or not (False).</li>
<li>A Method <code class="xref py py-func docutils literal notranslate"><span class="pre">comm_instance.reconnect()</span></code> to initiate a reconnect.</li>
<li>A Method <code class="xref py py-func docutils literal notranslate"><span class="pre">comm_instance.register_callback()</span></code> to register a data available callback.</li>
<li>A Method <code class="xref py py-func docutils literal notranslate"><span class="pre">comm_instance.register_connect_callback()</span></code> to register a connect callback.</li>
<li>A Method <code class="xref py py-func docutils literal notranslate"><span class="pre">comm_instance.register_disconnect_callback()</span></code> to register a disconnect callback.</li>
<li>A Method <code class="xref py py-func docutils literal notranslate"><span class="pre">comm_instance.send()</span></code> to send data via the <code class="xref py py-class docutils literal notranslate"><span class="pre">comm_instance</span></code>.</li>
</ul>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The parameter <code class="xref py py-const docutils literal notranslate"><span class="pre">auto_auth</span></code> is only relevant, if a secret is given and the <code class="xref py py-class docutils literal notranslate"><span class="pre">comm_instance</span></code> is a client. The authentification is initiated directly after the connection is established.</p>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>The <code class="xref py py-const docutils literal notranslate"><span class="pre">channel_name</span></code>-exchange will be initiated by the client directly after the the connection is established.</p>
<ul class="last simple">
<li>If a channel_name is given at both communication sides and they are different, the client name is taken over and the server will log a warning message.</li>
</ul>
</div>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<dl class="method">
<dt id="socket_protocol.pure_json_protocol.add_data">
<code class="descname">add_data</code><span class="sig-paren">(</span><em>service_id</em>, <em>data_id</em>, <em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#socket_protocol.pure_json_protocol.add_data" title="Permalink to this definition"></a></dt>
<dd><p>Method to add a name for a specific message.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>service_id</strong> (<em>int</em><em> or </em><em>list of ints</em>) – The Service-ID of the message. See class definitions starting with <code class="docutils literal notranslate"><span class="pre">SID_</span></code>.</li>
<li><strong>data_id</strong> (<em>int</em>) – The Data-ID of the message.</li>
<li><strong>name</strong> (<em>str</em>) – The Name for the transfered message.</li>
</ul>
</td>
</tr>
</tbody>
</table>
Documentation update
2021-01-01 20:16:12 +01:00
</dd></dl>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<dl class="method">
<dt id="socket_protocol.pure_json_protocol.add_msg_to_auth_whitelist_">
<code class="descname">add_msg_to_auth_whitelist_</code><span class="sig-paren">(</span><em>service_id</em>, <em>data_id</em><span class="sig-paren">)</span><a class="headerlink" href="#socket_protocol.pure_json_protocol.add_msg_to_auth_whitelist_" title="Permalink to this definition"></a></dt>
<dd><p>Method to add a specific message to the list, where no authentification is required.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>service_id</strong> (<em>int</em>) – The Service-ID of the message. See class definitions starting with <code class="docutils literal notranslate"><span class="pre">SID_</span></code>.</li>
<li><strong>data_id</strong> (<em>int</em>) – The Data-ID of the message.</li>
</ul>
</td>
</tr>
</tbody>
</table>
Documentation update
2021-01-01 20:16:12 +01:00
</dd></dl>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<dl class="method">
<dt id="socket_protocol.pure_json_protocol.add_service">
<code class="descname">add_service</code><span class="sig-paren">(</span><em>req_sid</em>, <em>resp_sid</em>, <em>req_name=None</em>, <em>resp_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#socket_protocol.pure_json_protocol.add_service" title="Permalink to this definition"></a></dt>
<dd><p>Method to add a Service defined by Request- and Response Serivce-ID.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>req_sid</strong> (<em>int</em>) – The Request Service-ID.</li>
<li><strong>resp_sid</strong> (<em>int</em>) – The Response Service-ID.</li>
</ul>
</td>
</tr>
</tbody>
</table>
Documentation update
2021-01-01 20:16:12 +01:00
</dd></dl>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<dl class="method">
<dt id="socket_protocol.pure_json_protocol.add_status">
<code class="descname">add_status</code><span class="sig-paren">(</span><em>status</em>, <em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#socket_protocol.pure_json_protocol.add_status" title="Permalink to this definition"></a></dt>
<dd><p>Method to add a name for a status.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>status</strong> (<em>int</em>) – The Status. See class definitions starting with <code class="docutils literal notranslate"><span class="pre">STATUS_</span></code>.</li>
<li><strong>name</strong> (<em>str</em>) – The Name for the Status.</li>
</ul>
</td>
</tr>
</tbody>
</table>
Documentation update
2021-01-01 20:16:12 +01:00
</dd></dl>
<dl class="method">
<dt id="socket_protocol.pure_json_protocol.authentificate">
<code class="descname">authentificate</code><span class="sig-paren">(</span><em>timeout=2</em><span class="sig-paren">)</span><a class="headerlink" href="#socket_protocol.pure_json_protocol.authentificate" title="Permalink to this definition"></a></dt>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<dd><p>This method authetificates the client at the server.</p>
<table class="docutils field-list" frame="void" rules="none">
Documentation update
2021-01-01 20:16:12 +01:00
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>timeout</strong> (<em>float</em>) – The timeout for the authentification (requesting seed, sending key and getting authentification_feedback).</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True, if authentification was successfull; False, if not.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">An authentification will only processed, if a secret had been given on initialisation.</p>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Client and Server needs to use the same secret.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="socket_protocol.pure_json_protocol.check_authentification_state">
<code class="descname">check_authentification_state</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#socket_protocol.pure_json_protocol.check_authentification_state" title="Permalink to this definition"></a></dt>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<dd><p>This Method return the Authitification State as boolean value.</p>
<table class="docutils field-list" frame="void" rules="none">
Documentation update
2021-01-01 20:16:12 +01:00
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True, if authentification state is okay, otherwise False</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="socket_protocol.pure_json_protocol.connection_established">
<code class="descname">connection_established</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#socket_protocol.pure_json_protocol.connection_established" title="Permalink to this definition"></a></dt>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<dd><p>This Method returns the Connection state including authentification as a boolean value.</p>
<table class="docutils field-list" frame="void" rules="none">
Documentation update
2021-01-01 20:16:12 +01:00
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True, if the connection is established (incl. authentification, if a secret has been given)</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="socket_protocol.pure_json_protocol.is_connected">
<code class="descname">is_connected</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#socket_protocol.pure_json_protocol.is_connected" title="Permalink to this definition"></a></dt>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<dd><p>This Methods returns Connection state of the Communication Instance <code class="xref py py-func docutils literal notranslate"><span class="pre">comm_instance.is_connected()</span></code>.</p>
<table class="docutils field-list" frame="void" rules="none">
Documentation update
2021-01-01 20:16:12 +01:00
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the <code class="xref py py-class docutils literal notranslate"><span class="pre">comm_instance</span></code> is connected, otherwise False..</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="socket_protocol.pure_json_protocol.receive">
<code class="descname">receive</code><span class="sig-paren">(</span><em>service_id</em>, <em>data_id</em>, <em>timeout=1</em><span class="sig-paren">)</span><a class="headerlink" href="#socket_protocol.pure_json_protocol.receive" title="Permalink to this definition"></a></dt>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<dd><p>This Method returns a message object for a defined message or None, if this message is not available after the given timout.</p>
<table class="docutils field-list" frame="void" rules="none">
Documentation update
2021-01-01 20:16:12 +01:00
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>service_id</strong> (<em>int</em>) – The Service-ID for the message. See class definitions starting with <code class="docutils literal notranslate"><span class="pre">SID_</span></code>.</li>
<li><strong>data_id</strong> (<em>int</em>) – The Data-ID for the message.</li>
<li><strong>timeout</strong> (<em>float</em>) – The timeout for receiving.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The received data storage object or None, if no data was received.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#socket_protocol.data_storage" title="socket_protocol.data_storage">data_storage</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="socket_protocol.pure_json_protocol.reconnect">
<code class="descname">reconnect</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#socket_protocol.pure_json_protocol.reconnect" title="Permalink to this definition"></a></dt>
<dd><p>This methods initiates a reconnect by calling <code class="xref py py-func docutils literal notranslate"><span class="pre">comm_instance.reconnect()</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="socket_protocol.pure_json_protocol.register_callback">
<code class="descname">register_callback</code><span class="sig-paren">(</span><em>service_id</em>, <em>data_id</em>, <em>callback</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#socket_protocol.pure_json_protocol.register_callback" title="Permalink to this definition"></a></dt>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<dd><p>This method registers a callback for the given parameters. Giving <code class="docutils literal notranslate"><span class="pre">None</span></code> means, that all Service-IDs or all Data-IDs are used.
If a message hitting these parameters has been received, the callback will be executed.</p>
<table class="docutils field-list" frame="void" rules="none">
Documentation update
2021-01-01 20:16:12 +01:00
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
Documentation update
2021-01-01 20:16:12 +01:00
<li><strong>service_id</strong> (<em>int</em>) – The Service-ID for the message. See class definitions starting with <code class="docutils literal notranslate"><span class="pre">SID_</span></code>.</li>
<li><strong>data_id</strong> (<em>int</em>) – The Data-ID for the message.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>The <code class="xref py py-func docutils literal notranslate"><span class="pre">callback()</span></code> is priorised in the following order:</p>
<ul class="last simple">
<li>Callbacks with defined Service-ID and Data-ID.</li>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<li>Callbacks with a defined Service-ID and all Data-IDs.</li>
<li>Callbacks with a defined Data-ID and all Service-IDs.</li>
<li>Unspecific Callbacks.</li>
Documentation update
2021-01-01 20:16:12 +01:00
</ul>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>The <code class="xref py py-func docutils literal notranslate"><span class="pre">callback()</span></code> is executed with these arguments:</p>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<p><strong>Parameters given at the callback call:</strong></p>
<ul class="simple">
<li>The first Arguments is the received message as <a class="reference internal" href="#socket_protocol.data_storage" title="socket_protocol.data_storage"><code class="xref py py-class docutils literal notranslate"><span class="pre">data_storage</span></code></a> object.</li>
<li>Further arguments given at registration.</li>
<li>Further keyword arguments given at registration.</li>
</ul>
<p><strong>Return value of the callback:</strong></p>
<p>If the Callback is a Request Callback for a registered Service, the return value has to be a tuple or list with</p>
Documentation update
2021-01-01 20:16:12 +01:00
<ul class="last simple">
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<li><code class="xref py py-const docutils literal notranslate"><span class="pre">response_status</span></code>: The response status (see class definitions starting with <code class="xref py py-const docutils literal notranslate"><span class="pre">STA_*</span></code>.</li>
Documentation update
2021-01-01 20:16:12 +01:00
<li><code class="xref py py-const docutils literal notranslate"><span class="pre">response_data</span></code>: A JSON iterable object to be used as data for the response.</li>
</ul>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<p class="last">Only registered services will respond via the callbacks return values with the same data_id.</p>
Documentation update
2021-01-01 20:16:12 +01:00
</div>
</dd></dl>
<dl class="method">
<dt id="socket_protocol.pure_json_protocol.send">
Release fdca73452afabd6d5a54327817639dce; Documentation and Restructuration
2021-01-06 22:54:21 +01:00
<code class="descname">send</code><span class="sig-paren">(</span><em>service_id</em>, <em>data_id</em>, <em>data</em>, <em>status=0</em>, <em>timeout=2</em><span class="sig-paren">)</span><a class="headerlink" href="#socket_protocol.pure_json_protocol.send" title="Permalink to this definition"></a></dt>
<dd><p>This methods sends out a message with the given content.</p>
<table class="docutils field-list" frame="void" rules="none">
Documentation update
2021-01-01 20:16:12 +01:00
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>service_id</strong> (<em>int</em>) – The Service-ID for the message. See class definitions starting with <code class="docutils literal notranslate"><span class="pre">SERVICE_</span></code>.</li>
<li><strong>data_id</strong> (<em>int</em>) – The Data-ID for the message.</li>
<li><strong>data</strong> (<em>str</em>) – The data to be transfered. The data needs to be json compatible.</li>
<li><strong>status</strong> (<em>int</em>) – The Status for the message. All requests should have <code class="docutils literal notranslate"><span class="pre">STATUS_OKAY</span></code>.</li>
<li><strong>timeout</strong> (<em>float</em>) – The timeout for sending data (e.g. time to establish new connection).</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if data had been sent, otherwise False.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="socket_protocol.struct_json_protocol">
<em class="property">class </em><code class="descclassname">socket_protocol.</code><code class="descname">struct_json_protocol</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#socket_protocol.struct_json_protocol" title="Permalink to this definition"></a></dt>
Release b2cd74413a21bced599aa52431777de0; Logging + Restructuring
2021-01-11 07:36:18 +01:00
<dd><p>This Class has the same functionality like <a class="reference internal" href="#socket_protocol.pure_json_protocol" title="socket_protocol.pure_json_protocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">pure_json_protocol</span></code></a>. The message length is less than for <a class="reference internal" href="#socket_protocol.pure_json_protocol" title="socket_protocol.pure_json_protocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">pure_json_protocol</span></code></a>, but the functionality and compatibility is reduced.
See also parent <a class="reference internal" href="#socket_protocol.pure_json_protocol" title="socket_protocol.pure_json_protocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">pure_json_protocol</span></code></a>.</p>
Documentation update
2021-01-01 20:16:12 +01:00
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This class is depreceated and here for compatibility reasons (to support old clients or servers). Usage of <a class="reference internal" href="#socket_protocol.pure_json_protocol" title="socket_protocol.pure_json_protocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">pure_json_protocol</span></code></a> is recommended.</p>
</div>
</dd></dl>
</div>
<div class="toctree-wrapper compound">
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2021, Dirk Alders
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Reference in New Issue Copy Permalink