Python Library Socket Protocol
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

genindex.html 12KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353
  1. <!DOCTYPE html>
  2. <html class="writer-html4" lang="en" >
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <title>Index &mdash; socket_protocol documentation</title>
  7. <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  8. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  9. <!--[if lt IE 9]>
  10. <script src="_static/js/html5shiv.min.js"></script>
  11. <![endif]-->
  12. <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
  13. <script type="text/javascript" src="_static/jquery.js"></script>
  14. <script type="text/javascript" src="_static/underscore.js"></script>
  15. <script type="text/javascript" src="_static/doctools.js"></script>
  16. <script type="text/javascript" src="_static/language_data.js"></script>
  17. <script type="text/javascript" src="_static/js/theme.js"></script>
  18. <link rel="index" title="Index" href="#" />
  19. <link rel="search" title="Search" href="search.html" />
  20. </head>
  21. <body class="wy-body-for-nav">
  22. <div class="wy-grid-for-nav">
  23. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  24. <div class="wy-side-scroll">
  25. <div class="wy-side-nav-search" >
  26. <a href="index.html" class="icon icon-home" alt="Documentation Home"> socket_protocol
  27. </a>
  28. <div role="search">
  29. <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  30. <input type="text" name="q" placeholder="Search docs" />
  31. <input type="hidden" name="check_keywords" value="yes" />
  32. <input type="hidden" name="area" value="default" />
  33. </form>
  34. </div>
  35. </div>
  36. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  37. <!-- Local TOC -->
  38. <div class="local-toc"></div>
  39. </div>
  40. </div>
  41. </nav>
  42. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  43. <nav class="wy-nav-top" aria-label="top navigation">
  44. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  45. <a href="index.html">socket_protocol</a>
  46. </nav>
  47. <div class="wy-nav-content">
  48. <div class="rst-content">
  49. <div role="navigation" aria-label="breadcrumbs navigation">
  50. <ul class="wy-breadcrumbs">
  51. <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
  52. <li>Index</li>
  53. <li class="wy-breadcrumbs-aside">
  54. </li>
  55. </ul>
  56. <hr/>
  57. </div>
  58. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  59. <div itemprop="articleBody">
  60. <h1 id="index">Index</h1>
  61. <div class="genindex-jumpbox">
  62. <a href="#A"><strong>A</strong></a>
  63. | <a href="#C"><strong>C</strong></a>
  64. | <a href="#D"><strong>D</strong></a>
  65. | <a href="#G"><strong>G</strong></a>
  66. | <a href="#I"><strong>I</strong></a>
  67. | <a href="#P"><strong>P</strong></a>
  68. | <a href="#R"><strong>R</strong></a>
  69. | <a href="#S"><strong>S</strong></a>
  70. </div>
  71. <h2 id="A">A</h2>
  72. <table style="width: 100%" class="indextable genindextable"><tr>
  73. <td style="width: 33%; vertical-align: top;"><ul>
  74. <li><a href="index.html#socket_protocol.pure_json_protocol.AUTH_STATE__NAMES">AUTH_STATE__NAMES (socket_protocol.pure_json_protocol attribute)</a>
  75. </li>
  76. <li><a href="index.html#socket_protocol.pure_json_protocol.AUTH_STATE_KEY_TRANSFERRED">AUTH_STATE_KEY_TRANSFERRED (socket_protocol.pure_json_protocol attribute)</a>
  77. </li>
  78. <li><a href="index.html#socket_protocol.pure_json_protocol.AUTH_STATE_SEED_REQUESTED">AUTH_STATE_SEED_REQUESTED (socket_protocol.pure_json_protocol attribute)</a>
  79. </li>
  80. </ul></td>
  81. <td style="width: 33%; vertical-align: top;"><ul>
  82. <li><a href="index.html#socket_protocol.pure_json_protocol.AUTH_STATE_SEED_TRANSFERRED">AUTH_STATE_SEED_TRANSFERRED (socket_protocol.pure_json_protocol attribute)</a>
  83. </li>
  84. <li><a href="index.html#socket_protocol.pure_json_protocol.AUTH_STATE_TRUSTED_CLIENT">AUTH_STATE_TRUSTED_CLIENT (socket_protocol.pure_json_protocol attribute)</a>
  85. </li>
  86. <li><a href="index.html#socket_protocol.pure_json_protocol.AUTH_STATE_UNKNOWN_CLIENT">AUTH_STATE_UNKNOWN_CLIENT (socket_protocol.pure_json_protocol attribute)</a>
  87. </li>
  88. <li><a href="index.html#socket_protocol.pure_json_protocol.authentificate">authentificate() (socket_protocol.pure_json_protocol method)</a>
  89. </li>
  90. </ul></td>
  91. </tr></table>
  92. <h2 id="C">C</h2>
  93. <table style="width: 100%" class="indextable genindextable"><tr>
  94. <td style="width: 33%; vertical-align: top;"><ul>
  95. <li><a href="index.html#socket_protocol.pure_json_protocol.check_authentification_state">check_authentification_state() (socket_protocol.pure_json_protocol method)</a>
  96. </li>
  97. </ul></td>
  98. <td style="width: 33%; vertical-align: top;"><ul>
  99. <li><a href="index.html#socket_protocol.pure_json_protocol.connection_established">connection_established() (socket_protocol.pure_json_protocol method)</a>
  100. </li>
  101. </ul></td>
  102. </tr></table>
  103. <h2 id="D">D</h2>
  104. <table style="width: 100%" class="indextable genindextable"><tr>
  105. <td style="width: 33%; vertical-align: top;"><ul>
  106. <li><a href="index.html#socket_protocol.data_storage">data_storage (class in socket_protocol)</a>
  107. </li>
  108. </ul></td>
  109. </tr></table>
  110. <h2 id="G">G</h2>
  111. <table style="width: 100%" class="indextable genindextable"><tr>
  112. <td style="width: 33%; vertical-align: top;"><ul>
  113. <li><a href="index.html#socket_protocol.data_storage.get_data">get_data() (socket_protocol.data_storage method)</a>
  114. </li>
  115. <li><a href="index.html#socket_protocol.data_storage.get_data_id">get_data_id() (socket_protocol.data_storage method)</a>
  116. </li>
  117. </ul></td>
  118. <td style="width: 33%; vertical-align: top;"><ul>
  119. <li><a href="index.html#socket_protocol.data_storage.get_service_id">get_service_id() (socket_protocol.data_storage method)</a>
  120. </li>
  121. <li><a href="index.html#socket_protocol.data_storage.get_status">get_status() (socket_protocol.data_storage method)</a>
  122. </li>
  123. </ul></td>
  124. </tr></table>
  125. <h2 id="I">I</h2>
  126. <table style="width: 100%" class="indextable genindextable"><tr>
  127. <td style="width: 33%; vertical-align: top;"><ul>
  128. <li><a href="index.html#socket_protocol.pure_json_protocol.is_connected">is_connected() (socket_protocol.pure_json_protocol method)</a>
  129. </li>
  130. </ul></td>
  131. </tr></table>
  132. <h2 id="P">P</h2>
  133. <table style="width: 100%" class="indextable genindextable"><tr>
  134. <td style="width: 33%; vertical-align: top;"><ul>
  135. <li><a href="index.html#socket_protocol.pure_json_protocol">pure_json_protocol (class in socket_protocol)</a>
  136. </li>
  137. </ul></td>
  138. </tr></table>
  139. <h2 id="R">R</h2>
  140. <table style="width: 100%" class="indextable genindextable"><tr>
  141. <td style="width: 33%; vertical-align: top;"><ul>
  142. <li><a href="index.html#socket_protocol.pure_json_protocol.receive">receive() (socket_protocol.pure_json_protocol method)</a>
  143. </li>
  144. </ul></td>
  145. <td style="width: 33%; vertical-align: top;"><ul>
  146. <li><a href="index.html#socket_protocol.pure_json_protocol.reconnect">reconnect() (socket_protocol.pure_json_protocol method)</a>
  147. </li>
  148. <li><a href="index.html#socket_protocol.pure_json_protocol.register_callback">register_callback() (socket_protocol.pure_json_protocol method)</a>
  149. </li>
  150. </ul></td>
  151. </tr></table>
  152. <h2 id="S">S</h2>
  153. <table style="width: 100%" class="indextable genindextable"><tr>
  154. <td style="width: 33%; vertical-align: top;"><ul>
  155. <li><a href="index.html#socket_protocol.pure_json_protocol.send">send() (socket_protocol.pure_json_protocol method)</a>
  156. </li>
  157. <li><a href="index.html#socket_protocol.pure_json_protocol.SID__NO_AUTH_LIST">SID__NO_AUTH_LIST (socket_protocol.pure_json_protocol attribute)</a>
  158. </li>
  159. <li><a href="index.html#socket_protocol.pure_json_protocol.SID__RESPONSE_DICT">SID__RESPONSE_DICT (socket_protocol.pure_json_protocol attribute)</a>
  160. </li>
  161. <li><a href="index.html#socket_protocol.pure_json_protocol.SID_AUTH_KEY_CHECK_REQUEST">SID_AUTH_KEY_CHECK_REQUEST (socket_protocol.pure_json_protocol attribute)</a>
  162. </li>
  163. <li><a href="index.html#socket_protocol.pure_json_protocol.SID_AUTH_KEY_CHECK_RESPONSE">SID_AUTH_KEY_CHECK_RESPONSE (socket_protocol.pure_json_protocol attribute)</a>
  164. </li>
  165. <li><a href="index.html#socket_protocol.pure_json_protocol.SID_AUTH_KEY_REQUEST">SID_AUTH_KEY_REQUEST (socket_protocol.pure_json_protocol attribute)</a>
  166. </li>
  167. <li><a href="index.html#socket_protocol.pure_json_protocol.SID_AUTH_SEED_REQUEST">SID_AUTH_SEED_REQUEST (socket_protocol.pure_json_protocol attribute)</a>
  168. </li>
  169. <li><a href="index.html#socket_protocol.pure_json_protocol.SID_CHANNEL_NAME_REQUEST">SID_CHANNEL_NAME_REQUEST (socket_protocol.pure_json_protocol attribute)</a>
  170. </li>
  171. <li><a href="index.html#socket_protocol.pure_json_protocol.SID_CHANNEL_NAME_RESPONSE">SID_CHANNEL_NAME_RESPONSE (socket_protocol.pure_json_protocol attribute)</a>
  172. </li>
  173. <li><a href="index.html#socket_protocol.pure_json_protocol.SID_EXECUTE_REQUEST">SID_EXECUTE_REQUEST (socket_protocol.pure_json_protocol attribute)</a>
  174. </li>
  175. <li><a href="index.html#socket_protocol.pure_json_protocol.SID_EXECUTE_RESPONSE">SID_EXECUTE_RESPONSE (socket_protocol.pure_json_protocol attribute)</a>
  176. </li>
  177. <li><a href="index.html#socket_protocol.pure_json_protocol.SID_READ_REQUEST">SID_READ_REQUEST (socket_protocol.pure_json_protocol attribute)</a>
  178. </li>
  179. </ul></td>
  180. <td style="width: 33%; vertical-align: top;"><ul>
  181. <li><a href="index.html#socket_protocol.pure_json_protocol.SID_READ_RESPONSE">SID_READ_RESPONSE (socket_protocol.pure_json_protocol attribute)</a>
  182. </li>
  183. <li><a href="index.html#socket_protocol.pure_json_protocol.SID_WRITE_REQUEST">SID_WRITE_REQUEST (socket_protocol.pure_json_protocol attribute)</a>
  184. </li>
  185. <li><a href="index.html#socket_protocol.pure_json_protocol.SID_WRITE_RESPONSE">SID_WRITE_RESPONSE (socket_protocol.pure_json_protocol attribute)</a>
  186. </li>
  187. <li><a href="index.html#module-socket_protocol">socket_protocol (module)</a>
  188. </li>
  189. <li><a href="index.html#socket_protocol.pure_json_protocol.STATUS__NAMES">STATUS__NAMES (socket_protocol.pure_json_protocol attribute)</a>
  190. </li>
  191. <li><a href="index.html#socket_protocol.pure_json_protocol.STATUS_AUTH_REQUIRED">STATUS_AUTH_REQUIRED (socket_protocol.pure_json_protocol attribute)</a>
  192. </li>
  193. <li><a href="index.html#socket_protocol.pure_json_protocol.STATUS_BUFFERING_UNHANDLED_REQUEST">STATUS_BUFFERING_UNHANDLED_REQUEST (socket_protocol.pure_json_protocol attribute)</a>
  194. </li>
  195. <li><a href="index.html#socket_protocol.pure_json_protocol.STATUS_CHECKSUM_ERROR">STATUS_CHECKSUM_ERROR (socket_protocol.pure_json_protocol attribute)</a>
  196. </li>
  197. <li><a href="index.html#socket_protocol.pure_json_protocol.STATUS_OKAY">STATUS_OKAY (socket_protocol.pure_json_protocol attribute)</a>
  198. </li>
  199. <li><a href="index.html#socket_protocol.pure_json_protocol.STATUS_OPERATION_NOT_PERMITTED">STATUS_OPERATION_NOT_PERMITTED (socket_protocol.pure_json_protocol attribute)</a>
  200. </li>
  201. <li><a href="index.html#socket_protocol.pure_json_protocol.STATUS_SERVICE_OR_DATA_UNKNOWN">STATUS_SERVICE_OR_DATA_UNKNOWN (socket_protocol.pure_json_protocol attribute)</a>
  202. </li>
  203. <li><a href="index.html#socket_protocol.struct_json_protocol">struct_json_protocol (class in socket_protocol)</a>
  204. </li>
  205. </ul></td>
  206. </tr></table>
  207. </div>
  208. </div>
  209. <footer>
  210. <hr/>
  211. <div role="contentinfo">
  212. <p>
  213. &copy; Copyright 2021, Dirk Alders
  214. </p>
  215. </div>
  216. Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
  217. <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
  218. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  219. </footer>
  220. </div>
  221. </div>
  222. </section>
  223. </div>
  224. <script type="text/javascript">
  225. jQuery(function () {
  226. SphinxRtdTheme.Navigation.enable(true);
  227. });
  228. </script>
  229. </body>
  230. </html>