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>Index — 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="#" />
|
|
|
|
|
<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="index.html" 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"></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="index.html">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="index.html" class="icon icon-home"></a> »</li>
|
|
|
|
|
|
|
|
|
|
<li>Index</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr/>
|
|
|
|
|
</div>
|
|
|
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
|
|
|
<div itemprop="articleBody">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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="#G"><strong>G</strong></a>
|
|
|
|
|
| <a href="#I"><strong>I</strong></a>
|
|
|
|
|
| <a href="#P"><strong>P</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>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.pure_json_protocol.add_data">add_data() (socket_protocol.pure_json_protocol method)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.pure_json_protocol.add_msg_to_auth_whitelist_">add_msg_to_auth_whitelist_() (socket_protocol.pure_json_protocol method)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.pure_json_protocol.add_service">add_service() (socket_protocol.pure_json_protocol method)</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li><a href="index.html#socket_protocol.pure_json_protocol.add_status">add_status() (socket_protocol.pure_json_protocol method)</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li><a href="index.html#socket_protocol.AUTH_STATE__NAMES">AUTH_STATE__NAMES (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
|
|
|
|
</ul></td>
|
|
|
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.AUTH_STATE_KEY_TRANSFERRED">AUTH_STATE_KEY_TRANSFERRED (in module socket_protocol)</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li><a href="index.html#socket_protocol.AUTH_STATE_SEED_REQUESTED">AUTH_STATE_SEED_REQUESTED (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.AUTH_STATE_SEED_TRANSFERRED">AUTH_STATE_SEED_TRANSFERRED (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.AUTH_STATE_TRUSTED_CONNECTION">AUTH_STATE_TRUSTED_CONNECTION (in module socket_protocol)</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li><a href="index.html#socket_protocol.AUTH_STATE_UNTRUSTED_CONNECTION">AUTH_STATE_UNTRUSTED_CONNECTION (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
|
|
|
|
<li><a href="index.html#socket_protocol.pure_json_protocol.authentificate">authentificate() (socket_protocol.pure_json_protocol 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="index.html#socket_protocol.pure_json_protocol.check_authentification_state">check_authentification_state() (socket_protocol.pure_json_protocol method)</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul></td>
|
|
|
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
|
|
|
<li><a href="index.html#socket_protocol.pure_json_protocol.connection_established">connection_established() (socket_protocol.pure_json_protocol method)</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="index.html#socket_protocol.data_storage">data_storage (class in socket_protocol)</a>
|
2021-01-06 22:54:21 +01:00
|
|
|
</li>
|
|
|
|
|
<li><a href="index.html#socket_protocol.DID_AUTH_KEY">DID_AUTH_KEY (in module socket_protocol)</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul></td>
|
|
|
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
|
|
|
<li><a href="index.html#socket_protocol.DID_AUTH_SEED">DID_AUTH_SEED (in module socket_protocol)</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li><a href="index.html#socket_protocol.DID_CHANNEL_NAME">DID_CHANNEL_NAME (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
|
|
|
|
</ul></td>
|
|
|
|
|
</tr></table>
|
|
|
|
|
|
|
|
|
|
<h2 id="G">G</h2>
|
|
|
|
|
<table style="width: 100%" class="indextable genindextable"><tr>
|
|
|
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
|
|
|
<li><a href="index.html#socket_protocol.data_storage.get_data">get_data() (socket_protocol.data_storage method)</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li><a href="index.html#socket_protocol.data_storage.get_data_id">get_data_id() (socket_protocol.data_storage method)</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul></td>
|
|
|
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
|
|
|
|
<li><a href="index.html#socket_protocol.data_storage.get_service_id">get_service_id() (socket_protocol.data_storage method)</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li><a href="index.html#socket_protocol.data_storage.get_status">get_status() (socket_protocol.data_storage method)</a>
|
|
|
|
|
</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="index.html#socket_protocol.pure_json_protocol.is_connected">is_connected() (socket_protocol.pure_json_protocol method)</a>
|
|
|
|
|
</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="index.html#socket_protocol.pure_json_protocol">pure_json_protocol (class in socket_protocol)</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="index.html#socket_protocol.pure_json_protocol.receive">receive() (socket_protocol.pure_json_protocol method)</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li><a href="index.html#socket_protocol.pure_json_protocol.reconnect">reconnect() (socket_protocol.pure_json_protocol method)</a>
|
|
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
</ul></td>
|
|
|
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
2021-01-01 20:16:12 +01:00
|
|
|
<li><a href="index.html#socket_protocol.pure_json_protocol.register_callback">register_callback() (socket_protocol.pure_json_protocol method)</a>
|
2021-01-06 22:54:21 +01:00
|
|
|
</li>
|
|
|
|
|
<li><a href="index.html#socket_protocol.RequestSidExistsError">RequestSidExistsError</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li><a href="index.html#socket_protocol.ResponseSidExistsError">ResponseSidExistsError</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</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="index.html#socket_protocol.pure_json_protocol.send">send() (socket_protocol.pure_json_protocol method)</a>
|
|
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.SID_AUTH_REQUEST">SID_AUTH_REQUEST (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.SID_AUTH_RESPONSE">SID_AUTH_RESPONSE (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.SID_CHANNEL_NAME_REQUEST">SID_CHANNEL_NAME_REQUEST (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.SID_CHANNEL_NAME_RESPONSE">SID_CHANNEL_NAME_RESPONSE (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.SID_EXECUTE_REQUEST">SID_EXECUTE_REQUEST (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.SID_EXECUTE_RESPONSE">SID_EXECUTE_RESPONSE (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.SID_READ_REQUEST">SID_READ_REQUEST (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.SID_READ_RESPONSE">SID_READ_RESPONSE (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.SID_WRITE_REQUEST">SID_WRITE_REQUEST (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
|
|
|
|
</ul></td>
|
|
|
|
|
<td style="width: 33%; vertical-align: top;"><ul>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.SID_WRITE_RESPONSE">SID_WRITE_RESPONSE (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
|
|
|
|
<li><a href="index.html#module-socket_protocol">socket_protocol (module)</a>
|
|
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.STATUS_AUTH_REQUIRED">STATUS_AUTH_REQUIRED (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.STATUS_BUFFERING_UNHANDLED_REQUEST">STATUS_BUFFERING_UNHANDLED_REQUEST (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.STATUS_CALLBACK_ERROR">STATUS_CALLBACK_ERROR (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.STATUS_CHECKSUM_ERROR">STATUS_CHECKSUM_ERROR (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.STATUS_OKAY">STATUS_OKAY (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.STATUS_OPERATION_NOT_PERMITTED">STATUS_OPERATION_NOT_PERMITTED (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
2021-01-06 22:54:21 +01:00
|
|
|
<li><a href="index.html#socket_protocol.STATUS_SERVICE_OR_DATA_UNKNOWN">STATUS_SERVICE_OR_DATA_UNKNOWN (in module socket_protocol)</a>
|
2021-01-01 20:16:12 +01:00
|
|
|
</li>
|
|
|
|
|
<li><a href="index.html#socket_protocol.struct_json_protocol">struct_json_protocol (class in socket_protocol)</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul></td>
|
|
|
|
|
</tr></table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
<footer>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr/>
|
|
|
|
|
|
|
|
|
|
<div role="contentinfo">
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
© 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>
|
