pylib
/
socket_protocol
Vērot 1
Pievienot zvaigznīti 0
Atdalīts 0
Kods Problēmas 0 Izmaiņu pieprasījumi 0 Laidieni 0 Vikivietne Aktivitāte
Python Library Socket Protocol
Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.
22 Revīzijas
1 Atzars
Koks: 945d728341
Atzari Tagi
${ item.name }
Izveidot atzaru ${ searchTerm }
no '945d728341'
${ noResults }
socket_protocol/_docs_/index.html

index.html 67KB
Vēsture Neapstrādāts

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868 
  1. 

  2. 

  3. <!DOCTYPE html>

  4. <html class="writer-html4" lang="en" >

  5. <head>

  6.   <meta charset="utf-8">

  7.   

  8.   <meta name="viewport" content="width=device-width, initial-scale=1.0">

  9.   

  10.   <title>Welcome to socket_protocol’s documentation! &mdash; socket_protocol  documentation</title>

  11.   

  12. 

  13.   

  14.   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />

  15.   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />

  16. 

  17.   

  18.   

  19.   

  20.   

  21. 

  22.   

  23.   <!--[if lt IE 9]>

  24.     <script src="_static/js/html5shiv.min.js"></script>

  25.   <![endif]-->

  26.   

  27.     

  28.       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

  29.         <script type="text/javascript" src="_static/jquery.js"></script>

  30.         <script type="text/javascript" src="_static/underscore.js"></script>

  31.         <script type="text/javascript" src="_static/doctools.js"></script>

  32.         <script type="text/javascript" src="_static/language_data.js"></script>

  33.     

  34.     <script type="text/javascript" src="_static/js/theme.js"></script>

  35. 

  36.     

  37.     <link rel="index" title="Index" href="genindex.html" />

  38.     <link rel="search" title="Search" href="search.html" /> 

  39. </head>

  40. 

  41. <body class="wy-body-for-nav">

  42. 

  43.    

  44.   <div class="wy-grid-for-nav">

  45.     

  46.     <nav data-toggle="wy-nav-shift" class="wy-nav-side">

  47.       <div class="wy-side-scroll">

  48.         <div class="wy-side-nav-search" >

  49.           

  50. 

  51.           

  52.             <a href="#" class="icon icon-home" alt="Documentation Home"> socket_protocol

  53.           

  54. 

  55.           

  56.           </a>

  57. 

  58.           

  59.             

  60.             

  61.           

  62. 

  63.           

  64. <div role="search">

  65.   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

  66.     <input type="text" name="q" placeholder="Search docs" />

  67.     <input type="hidden" name="check_keywords" value="yes" />

  68.     <input type="hidden" name="area" value="default" />

  69.   </form>

  70. </div>

  71. 

  72.           

  73.         </div>

  74. 

  75.         

  76.         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">

  77.           

  78.             

  79.             

  80.               

  81.             

  82.             

  83.               <!-- Local TOC -->

  84.               <div class="local-toc"><ul>

  85. <li><a class="reference internal" href="#">Welcome to socket_protocol’s documentation!</a><ul>

  86. <li><a class="reference internal" href="#socket-protocol-socket-protocol">socket_protocol (Socket Protocol)</a></li>

  87. </ul>

  88. </li>

  89. <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>

  90. </ul>

  91. </div>

  92.             

  93.           

  94.         </div>

  95.         

  96.       </div>

  97.     </nav>

  98. 

  99.     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

  100. 

  101.       

  102.       <nav class="wy-nav-top" aria-label="top navigation">

  103.         

  104.           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>

  105.           <a href="#">socket_protocol</a>

  106.         

  107.       </nav>

  108. 

  109. 

  110.       <div class="wy-nav-content">

  111.         

  112.         <div class="rst-content">

  113.         

  114.           

  115. 

  116. 

  117. 

  118. 

  119. 

  120. 

  121. 

  122. 

  123. 

  124. 

  125. 

  126. 

  127. 

  128. 

  129. 

  130. <div role="navigation" aria-label="breadcrumbs navigation">

  131. 

  132.   <ul class="wy-breadcrumbs">

  133.     

  134.       <li><a href="#" class="icon icon-home"></a> &raquo;</li>

  135.         

  136.       <li>Welcome to socket_protocol’s documentation!</li>

  137.     

  138.     

  139.       <li class="wy-breadcrumbs-aside">

  140.         

  141.             

  142.             <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>

  143.           

  144.         

  145.       </li>

  146.     

  147.   </ul>

  148. 

  149.   

  150.   <hr/>

  151. </div>

  152.           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">

  153.            <div itemprop="articleBody">

  154.             

  155.   <div class="section" id="module-socket_protocol">

  156. <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>

  157. <div class="section" id="socket-protocol-socket-protocol">

  158. <h2>socket_protocol (Socket Protocol)<a class="headerlink" href="#socket-protocol-socket-protocol" title="Permalink to this headline">¶</a></h2>

  159. <p><strong>Author:</strong></p>

  160. <ul class="simple">

  161. <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>

  162. </ul>

  163. <p><strong>Description:</strong></p>

  164. <blockquote>

  165. <div>This Module supports point to point communication for client-server issues.</div></blockquote>

  166. <p><strong>Submodules:</strong></p>

  167. <ul class="simple">

  168. <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>

  169. <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>

  170. <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>

  171. </ul>

  172. <p><strong>Unittest:</strong></p>

  173. <blockquote>

  174. <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>

  175. <p><strong>Module Documentation:</strong></p>

  176. <dl class="data">

  177. <dt id="socket_protocol.AUTH_STATE_KEY_TRANSFERRED">

  178. <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>

  179. <dd><p>Authentification Status for ‘Key has been sent’</p>

  180. </dd></dl>

  181. 

  182. <dl class="data">

  183. <dt id="socket_protocol.AUTH_STATE_SEED_REQUESTED">

  184. <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>

  185. <dd><p>Authentification Status for ‘Seed was requested’</p>

  186. </dd></dl>

  187. 

  188. <dl class="data">

  189. <dt id="socket_protocol.AUTH_STATE_SEED_TRANSFERRED">

  190. <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>

  191. <dd><p>Authentification Status for ‘Seed has been sent’</p>

  192. </dd></dl>

  193. 

  194. <dl class="data">

  195. <dt id="socket_protocol.AUTH_STATE_TRUSTED_CONNECTION">

  196. <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>

  197. <dd><p>Authentification Status for a ‘Trusted Connection’</p>

  198. </dd></dl>

  199. 

  200. <dl class="data">

  201. <dt id="socket_protocol.AUTH_STATE_UNTRUSTED_CONNECTION">

  202. <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>

  203. <dd><p>Authentification Status for an ‘Untrusted Connection’</p>

  204. </dd></dl>

  205. 

  206. <dl class="data">

  207. <dt id="socket_protocol.AUTH_STATE__NAMES">

  208. <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>

  209. <dd><p>Authentification Status names for previous defined authentification states</p>

  210. </dd></dl>

  211. 

  212. <dl class="data">

  213. <dt id="socket_protocol.DID_AUTH_KEY">

  214. <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>

  215. <dd><p>DID for authentification (key)</p>

  216. </dd></dl>

  217. 

  218. <dl class="data">

  219. <dt id="socket_protocol.DID_AUTH_SEED">

  220. <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>

  221. <dd><p>DID for authentification (seed)</p>

  222. </dd></dl>

  223. 

  224. <dl class="data">

  225. <dt id="socket_protocol.DID_CHANNEL_NAME">

  226. <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>

  227. <dd><p>DID for channel name</p>

  228. </dd></dl>

  229. 

  230. <dl class="exception">

  231. <dt id="socket_protocol.RequestSidExistsError">

  232. <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>

  233. <dd></dd></dl>

  234. 

  235. <dl class="exception">

  236. <dt id="socket_protocol.ResponseSidExistsError">

  237. <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>

  238. <dd></dd></dl>

  239. 

  240. <dl class="data">

  241. <dt id="socket_protocol.SID_AUTH_REQUEST">

  242. <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>

  243. <dd><p>SID for authentification request</p>

  244. </dd></dl>

  245. 

  246. <dl class="data">

  247. <dt id="socket_protocol.SID_AUTH_RESPONSE">

  248. <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>

  249. <dd><p>SID for authentification response</p>

  250. </dd></dl>

  251. 

  252. <dl class="data">

  253. <dt id="socket_protocol.SID_CHANNEL_NAME_REQUEST">

  254. <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>

  255. <dd><p>SID for channel name exchange request</p>

  256. </dd></dl>

  257. 

  258. <dl class="data">

  259. <dt id="socket_protocol.SID_CHANNEL_NAME_RESPONSE">

  260. <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>

  261. <dd><p>SID for channel name exchange response</p>

  262. </dd></dl>

  263. 

  264. <dl class="data">

  265. <dt id="socket_protocol.SID_EXECUTE_REQUEST">

  266. <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>

  267. <dd><p>SID for a execute request</p>

  268. </dd></dl>

  269. 

  270. <dl class="data">

  271. <dt id="socket_protocol.SID_EXECUTE_RESPONSE">

  272. <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>

  273. <dd><p>SID for a execute response</p>

  274. </dd></dl>

  275. 

  276. <dl class="data">

  277. <dt id="socket_protocol.SID_READ_REQUEST">

  278. <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>

  279. <dd><p>SID for a read data request</p>

  280. </dd></dl>

  281. 

  282. <dl class="data">

  283. <dt id="socket_protocol.SID_READ_RESPONSE">

  284. <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>

  285. <dd><p>SID for read data response</p>

  286. </dd></dl>

  287. 

  288. <dl class="data">

  289. <dt id="socket_protocol.SID_WRITE_REQUEST">

  290. <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>

  291. <dd><p>SID for a write data request</p>

  292. </dd></dl>

  293. 

  294. <dl class="data">

  295. <dt id="socket_protocol.SID_WRITE_RESPONSE">

  296. <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>

  297. <dd><p>SID for a write data response</p>

  298. </dd></dl>

  299. 

  300. <dl class="data">

  301. <dt id="socket_protocol.STATUS_AUTH_REQUIRED">

  302. <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>

  303. <dd><p>Status for ‘authentification is required’</p>

  304. </dd></dl>

  305. 

  306. <dl class="data">

  307. <dt id="socket_protocol.STATUS_BUFFERING_UNHANDLED_REQUEST">

  308. <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>

  309. <dd><p>Status for ‘unhandled request’</p>

  310. </dd></dl>

  311. 

  312. <dl class="data">

  313. <dt id="socket_protocol.STATUS_CALLBACK_ERROR">

  314. <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>

  315. <dd><p>Status for ‘callback errors’</p>

  316. </dd></dl>

  317. 

  318. <dl class="data">

  319. <dt id="socket_protocol.STATUS_CHECKSUM_ERROR">

  320. <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>

  321. <dd><p>Status for ‘checksum error’</p>

  322. </dd></dl>

  323. 

  324. <dl class="data">

  325. <dt id="socket_protocol.STATUS_LOG_LVL">

  326. <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>

  327. <dd><p>Status depending log level for messages</p>

  328. </dd></dl>

  329. 

  330. <dl class="data">

  331. <dt id="socket_protocol.STATUS_OKAY">

  332. <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>

  333. <dd><p>Status for ‘okay’</p>

  334. </dd></dl>

  335. 

  336. <dl class="data">

  337. <dt id="socket_protocol.STATUS_OPERATION_NOT_PERMITTED">

  338. <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>

  339. <dd><p>Status for ‘operation not permitted’</p>

  340. </dd></dl>

  341. 

  342. <dl class="data">

  343. <dt id="socket_protocol.STATUS_SERVICE_OR_DATA_UNKNOWN">

  344. <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>

  345. <dd><p>Status for ‘service or data unknown’</p>

  346. </dd></dl>

  347. 

  348. <dl class="class">

  349. <dt id="socket_protocol.data_storage">

  350. <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>

  351. <dd><p>This is a storage object for socket_protocol messages.</p>

  352. <table class="docutils field-list" frame="void" rules="none">

  353. <col class="field-name" />

  354. <col class="field-body" />

  355. <tbody valign="top">

  356. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

  357. <li><strong>status</strong> (<em>int</em>) – The message status.</li>

  358. <li><strong>service_id</strong> (<em>int</em>) – The Service-ID.</li>

  359. <li><strong>data_id</strong> (<em>int</em>) – The Data-ID.</li>

  360. <li><strong>data</strong> (<em>any</em>) – The transfered data.</li>

  361. </ul>

  362. </td>

  363. </tr>

  364. </tbody>

  365. </table>

  366. <dl class="method">

  367. <dt id="socket_protocol.data_storage.get_data">

  368. <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>

  369. <dd><p>This Method returns the message data.</p>

  370. <table class="docutils field-list" frame="void" rules="none">

  371. <col class="field-name" />

  372. <col class="field-body" />

  373. <tbody valign="top">

  374. <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>

  375. </tr>

  376. </tbody>

  377. </table>

  378. </dd></dl>

  379. 

  380. <dl class="method">

  381. <dt id="socket_protocol.data_storage.get_data_id">

  382. <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>

  383. <dd><p>This Method returns the message Data-ID.</p>

  384. <table class="docutils field-list" frame="void" rules="none">

  385. <col class="field-name" />

  386. <col class="field-body" />

  387. <tbody valign="top">

  388. <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>

  389. </tr>

  390. </tbody>

  391. </table>

  392. </dd></dl>

  393. 

  394. <dl class="method">

  395. <dt id="socket_protocol.data_storage.get_service_id">

  396. <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>

  397. <dd><p>This Method returns the message Service-ID.</p>

  398. <table class="docutils field-list" frame="void" rules="none">

  399. <col class="field-name" />

  400. <col class="field-body" />

  401. <tbody valign="top">

  402. <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>

  403. </tr>

  404. </tbody>

  405. </table>

  406. </dd></dl>

  407. 

  408. <dl class="method">

  409. <dt id="socket_protocol.data_storage.get_status">

  410. <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>

  411. <dd><p>This Method returns the message status.</p>

  412. <table class="docutils field-list" frame="void" rules="none">

  413. <col class="field-name" />

  414. <col class="field-body" />

  415. <tbody valign="top">

  416. <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>

  417. </tr>

  418. </tbody>

  419. </table>

  420. </dd></dl>

  421. 

  422. </dd></dl>

  423. 

  424. <dl class="class">

  425. <dt id="socket_protocol.pure_json_protocol">

  426. <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>

  427. <dd><p>This <cite>class</cite> supports to transfer a message and it’s data.</p>

  428. <table class="docutils field-list" frame="void" rules="none">

  429. <col class="field-name" />

  430. <col class="field-body" />

  431. <tbody valign="top">

  432. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

  433. <li><strong>comm_instance</strong> (<em>instance</em>) – A communication instance.</li>

  434. <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>

  435. <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>

  436. <li><strong>channel_name</strong> (<em>str</em>) – An optional parameter to set a channel name for logging of the communication.</li>

  437. </ul>

  438. </td>

  439. </tr>

  440. </tbody>

  441. </table>

  442. <div class="admonition hint">

  443. <p class="first admonition-title">Hint</p>

  444. <ul class="last simple">

  445. <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>

  446. <li>The Data-ID is designed to identify the requests / responses using the same Service_ID.</li>

  447. </ul>

  448. </div>

  449. <div class="admonition note">

  450. <p class="first admonition-title">Note</p>

  451. <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>

  452. <ul class="last simple">

  453. <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>

  454. <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>

  455. <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>

  456. <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>

  457. <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>

  458. <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>

  459. <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>

  460. <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>

  461. </ul>

  462. </div>

  463. <div class="admonition note">

  464. <p class="first admonition-title">Note</p>

  465. <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>

  466. </div>

  467. <div class="admonition note">

  468. <p class="first admonition-title">Note</p>

  469. <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>

  470. <ul class="last simple">

  471. <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>

  472. </ul>

  473. </div>

  474. <p><strong>Example:</strong></p>

  475. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">sys</span>

  476. <span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;../..&#39;</span><span class="p">)</span>

  477. 

  478. <span class="kn">import</span> <span class="nn">report</span>

  479. <span class="kn">import</span> <span class="nn">socket_protocol</span>

  480. <span class="kn">import</span> <span class="nn">tcp_socket</span>

  481. <span class="kn">import</span> <span class="nn">time</span>

  482. 

  483. 

  484. <span class="n">report</span><span class="o">.</span><span class="n">stdoutLoggingConfigure</span><span class="p">(</span><span class="n">log_name_lvl</span><span class="o">=</span><span class="p">[(</span><span class="s1">&#39;root&#39;</span><span class="p">,</span> <span class="s1">&#39;INFO&#39;</span><span class="p">),</span> <span class="p">])</span>

  485. <span class="n">c</span> <span class="o">=</span> <span class="n">tcp_socket</span><span class="o">.</span><span class="n">tcp_client_stp</span><span class="p">(</span><span class="s1">&#39;127.0.0.1&#39;</span><span class="p">,</span> <span class="mi">17017</span><span class="p">)</span>

  486. <span class="n">sp</span> <span class="o">=</span> <span class="n">socket_protocol</span><span class="o">.</span><span class="n">pure_json_protocol</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="n">channel_name</span><span class="o">=</span><span class="s1">&#39;example_client&#39;</span><span class="p">)</span>

  487. <span class="n">sp</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="n">socket_protocol</span><span class="o">.</span><span class="n">SID_READ_REQUEST</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>

  488. <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;The Client received: </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="nb">repr</span><span class="p">(</span><span class="n">sp</span><span class="o">.</span><span class="n">receive</span><span class="p">(</span><span class="n">socket_protocol</span><span class="o">.</span><span class="n">SID_READ_RESPONSE</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span><span class="o">.</span><span class="n">get_data</span><span class="p">()))</span>

  489. </pre></div>

  490. </div>

  491. <p>and</p>

  492. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">sys</span>

  493. <span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;../..&#39;</span><span class="p">)</span>

  494. 

  495. <span class="kn">import</span> <span class="nn">report</span>

  496. <span class="kn">import</span> <span class="nn">socket_protocol</span>

  497. <span class="kn">import</span> <span class="nn">tcp_socket</span>

  498. <span class="kn">import</span> <span class="nn">time</span>

  499. 

  500. 

  501. <span class="k">def</span> <span class="nf">time_callback</span><span class="p">(</span><span class="n">msg</span><span class="p">):</span>

  502.     <span class="k">if</span> <span class="n">msg</span><span class="o">.</span><span class="n">get_status</span><span class="p">()</span> <span class="o">==</span> <span class="n">socket_protocol</span><span class="o">.</span><span class="n">STATUS_OKAY</span><span class="p">:</span>

  503.         <span class="k">return</span> <span class="n">socket_protocol</span><span class="o">.</span><span class="n">STATUS_OKAY</span><span class="p">,</span> <span class="n">time</span><span class="o">.</span><span class="n">asctime</span><span class="p">()</span>

  504.     <span class="k">else</span><span class="p">:</span>

  505.         <span class="k">return</span> <span class="n">socket_protocol</span><span class="o">.</span><span class="n">STATUS_OPERATION_NOT_PERMITTED</span><span class="p">,</span> <span class="kc">None</span>

  506. 

  507. 

  508. <span class="n">report</span><span class="o">.</span><span class="n">stdoutLoggingConfigure</span><span class="p">(</span><span class="n">log_name_lvl</span><span class="o">=</span><span class="p">[(</span><span class="s1">&#39;root&#39;</span><span class="p">,</span> <span class="s1">&#39;INFO&#39;</span><span class="p">),</span> <span class="p">])</span>

  509. <span class="n">s</span> <span class="o">=</span> <span class="n">tcp_socket</span><span class="o">.</span><span class="n">tcp_server_stp</span><span class="p">(</span><span class="s1">&#39;127.0.0.1&#39;</span><span class="p">,</span> <span class="mi">17017</span><span class="p">)</span>

  510. <span class="n">sp</span> <span class="o">=</span> <span class="n">socket_protocol</span><span class="o">.</span><span class="n">pure_json_protocol</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">channel_name</span><span class="o">=</span><span class="s1">&#39;example_server&#39;</span><span class="p">)</span>

  511. <span class="n">sp</span><span class="o">.</span><span class="n">register_callback</span><span class="p">(</span><span class="n">socket_protocol</span><span class="o">.</span><span class="n">SID_READ_REQUEST</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">time_callback</span><span class="p">)</span>

  512. 

  513. <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span>

  514. <span class="k">while</span> <span class="ow">not</span> <span class="n">s</span><span class="o">.</span><span class="n">is_connected</span><span class="p">()</span> <span class="ow">and</span> <span class="n">i</span> <span class="o">&lt;=</span> <span class="mi">20</span><span class="p">:</span>

  515.     <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span>

  516.     <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="o">.</span><span class="mi">1</span><span class="p">)</span>  <span class="c1"># wait for a connection</span>

  517. 

  518. <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span>

  519. <span class="k">while</span> <span class="n">s</span><span class="o">.</span><span class="n">is_connected</span><span class="p">()</span> <span class="ow">and</span> <span class="n">i</span> <span class="o">&lt;=</span> <span class="mi">20</span><span class="p">:</span>

  520.     <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span>

  521.     <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="o">.</span><span class="mi">1</span><span class="p">)</span>  <span class="c1"># wait for disconnect</span>

  522. </pre></div>

  523. </div>

  524. <p>Will result to the following output:</p>

  525. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">2021</span><span class="o">-</span><span class="mi">01</span><span class="o">-</span><span class="mi">11</span> <span class="mi">17</span><span class="p">:</span><span class="mi">40</span><span class="p">:</span><span class="mi">12</span><span class="p">,</span><span class="mi">803</span><span class="p">:</span> <span class="n">root</span><span class="o">.</span><span class="n">socket_protocol</span><span class="o">.</span><span class="n">example_client</span> <span class="o">-</span> <span class="n">INFO</span> <span class="o">-</span> <span class="n">prot</span><span class="o">-</span><span class="n">client</span><span class="p">:</span> <span class="n">Resetting</span> <span class="n">authentification</span> <span class="n">state</span> <span class="n">to</span> <span class="n">AUTH_STATE_UNTRUSTED_CONNECTION</span>

  526. <span class="mi">2021</span><span class="o">-</span><span class="mi">01</span><span class="o">-</span><span class="mi">11</span> <span class="mi">17</span><span class="p">:</span><span class="mi">40</span><span class="p">:</span><span class="mi">12</span><span class="p">,</span><span class="mi">803</span><span class="p">:</span> <span class="n">root</span><span class="o">.</span><span class="n">socket_protocol</span> <span class="o">-</span> <span class="n">INFO</span> <span class="o">-</span> <span class="n">prot</span><span class="o">-</span><span class="n">client</span><span class="p">:</span> <span class="n">Initialisation</span> <span class="n">finished</span><span class="o">.</span>

  527. <span class="mi">2021</span><span class="o">-</span><span class="mi">01</span><span class="o">-</span><span class="mi">11</span> <span class="mi">17</span><span class="p">:</span><span class="mi">40</span><span class="p">:</span><span class="mi">12</span><span class="p">,</span><span class="mi">803</span><span class="p">:</span> <span class="n">root</span><span class="o">.</span><span class="n">socket_protocol</span><span class="o">.</span><span class="n">example_client</span> <span class="o">-</span> <span class="n">INFO</span> <span class="o">-</span> <span class="n">prot</span><span class="o">-</span><span class="n">client</span><span class="p">:</span> <span class="n">TX</span> <span class="o">-&gt;</span> <span class="n">service</span><span class="p">:</span> <span class="n">read</span> <span class="n">data</span> <span class="n">request</span><span class="p">,</span> <span class="n">data_id</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="n">status</span><span class="p">:</span> <span class="n">okay</span><span class="p">,</span> <span class="n">data</span><span class="p">:</span> <span class="s2">&quot;None&quot;</span>

  528. <span class="mi">2021</span><span class="o">-</span><span class="mi">01</span><span class="o">-</span><span class="mi">11</span> <span class="mi">17</span><span class="p">:</span><span class="mi">40</span><span class="p">:</span><span class="mi">12</span><span class="p">,</span><span class="mi">954</span><span class="p">:</span> <span class="n">root</span><span class="o">.</span><span class="n">tcp_socket</span><span class="o">.</span><span class="n">example_client</span> <span class="o">-</span> <span class="n">INFO</span> <span class="o">-</span> <span class="n">comm</span><span class="o">-</span><span class="n">client</span><span class="p">:</span> <span class="n">Connection</span> <span class="n">established</span><span class="o">...</span> <span class="p">(</span><span class="n">to</span> <span class="mf">127.0</span><span class="o">.</span><span class="mf">0.1</span><span class="p">:</span><span class="mi">17017</span><span class="p">)</span>

  529. <span class="mi">2021</span><span class="o">-</span><span class="mi">01</span><span class="o">-</span><span class="mi">11</span> <span class="mi">17</span><span class="p">:</span><span class="mi">40</span><span class="p">:</span><span class="mi">12</span><span class="p">,</span><span class="mi">955</span><span class="p">:</span> <span class="n">root</span><span class="o">.</span><span class="n">socket_protocol</span><span class="o">.</span><span class="n">example_client</span> <span class="o">-</span> <span class="n">INFO</span> <span class="o">-</span> <span class="n">prot</span><span class="o">-</span><span class="n">client</span><span class="p">:</span> <span class="n">TX</span> <span class="o">-&gt;</span> <span class="n">service</span><span class="p">:</span> <span class="n">channel</span> <span class="n">name</span> <span class="n">request</span><span class="p">,</span> <span class="n">data_id</span><span class="p">:</span> <span class="n">name</span><span class="p">,</span> <span class="n">status</span><span class="p">:</span> <span class="n">okay</span><span class="p">,</span> <span class="n">data</span><span class="p">:</span> <span class="s2">&quot;&#39;example_client&#39;&quot;</span>

  530. <span class="mi">2021</span><span class="o">-</span><span class="mi">01</span><span class="o">-</span><span class="mi">11</span> <span class="mi">17</span><span class="p">:</span><span class="mi">40</span><span class="p">:</span><span class="mi">12</span><span class="p">,</span><span class="mi">956</span><span class="p">:</span> <span class="n">root</span><span class="o">.</span><span class="n">tcp_socket</span><span class="o">.</span><span class="n">example_client</span> <span class="o">-</span> <span class="n">INFO</span> <span class="o">-</span> <span class="n">comm</span><span class="o">-</span><span class="n">client</span><span class="p">:</span> <span class="n">TX</span> <span class="o">-&gt;</span> <span class="s2">&quot;(74): 7b 22 64 61 74 61 5f 69 64 22 3a 20 30 2c 20 22 73 65 72 76 69 63 65 5f 69 64 22 3a 20 38 2c 20 22 73 74 61 74 75 73 22 3a 20 30 2c 20 22 64 61 74 61 22 3a 20 22 65 78 61 6d 70 6c 65 5f 63 6c 69 65 6e 74 22 7d f5 cd dd e7&quot;</span>

  531. <span class="mi">2021</span><span class="o">-</span><span class="mi">01</span><span class="o">-</span><span class="mi">11</span> <span class="mi">17</span><span class="p">:</span><span class="mi">40</span><span class="p">:</span><span class="mi">13</span><span class="p">,</span><span class="mi">004</span><span class="p">:</span> <span class="n">root</span><span class="o">.</span><span class="n">tcp_socket</span><span class="o">.</span><span class="n">example_client</span> <span class="o">-</span> <span class="n">INFO</span> <span class="o">-</span> <span class="n">comm</span><span class="o">-</span><span class="n">client</span><span class="p">:</span> <span class="n">TX</span> <span class="o">-&gt;</span> <span class="s2">&quot;(63): 7b 22 64 61 74 61 5f 69 64 22 3a 20 30 2c 20 22 73 65 72 76 69 63 65 5f 69 64 22 3a 20 31 30 2c 20 22 73 74 61 74 75 73 22 3a 20 30 2c 20 22 64 61 74 61 22 3a 20 6e 75 6c 6c 7d 45 05 7b b4&quot;</span>

  532. <span class="mi">2021</span><span class="o">-</span><span class="mi">01</span><span class="o">-</span><span class="mi">11</span> <span class="mi">17</span><span class="p">:</span><span class="mi">40</span><span class="p">:</span><span class="mi">13</span><span class="p">,</span><span class="mi">057</span><span class="p">:</span> <span class="n">root</span><span class="o">.</span><span class="n">stringtools</span><span class="o">.</span><span class="n">stp</span> <span class="o">-</span> <span class="n">INFO</span> <span class="o">-</span> <span class="n">STP</span><span class="p">:</span> <span class="n">message</span> <span class="n">identified</span> <span class="o">-</span> <span class="p">(</span><span class="mi">62</span><span class="p">):</span> <span class="mi">7</span><span class="n">b</span> <span class="mi">22</span> <span class="mi">64</span> <span class="mi">61</span> <span class="mi">74</span> <span class="mi">61</span> <span class="mi">5</span><span class="n">f</span> <span class="mi">69</span> <span class="mi">64</span> <span class="mi">22</span> <span class="mi">3</span><span class="n">a</span> <span class="mi">20</span> <span class="mi">30</span> <span class="mi">2</span><span class="n">c</span> <span class="mi">20</span> <span class="mi">22</span> <span class="mi">73</span> <span class="mi">65</span> <span class="mi">72</span> <span class="mi">76</span> <span class="mi">69</span> <span class="mi">63</span> <span class="mi">65</span> <span class="mi">5</span><span class="n">f</span> <span class="mi">69</span> <span class="mi">64</span> <span class="mi">22</span> <span class="mi">3</span><span class="n">a</span> <span class="mi">20</span> <span class="mi">39</span> <span class="mi">2</span><span class="n">c</span> <span class="mi">20</span> <span class="mi">22</span> <span class="mi">73</span> <span class="mi">74</span> <span class="mi">61</span> <span class="mi">74</span> <span class="mi">75</span> <span class="mi">73</span> <span class="mi">22</span> <span class="mi">3</span><span class="n">a</span> <span class="mi">20</span> <span class="mi">30</span> <span class="mi">2</span><span class="n">c</span> <span class="mi">20</span> <span class="mi">22</span> <span class="mi">64</span> <span class="mi">61</span> <span class="mi">74</span> <span class="mi">61</span> <span class="mi">22</span> <span class="mi">3</span><span class="n">a</span> <span class="mi">20</span> <span class="mi">6</span><span class="n">e</span> <span class="mi">75</span> <span class="mi">6</span><span class="n">c</span> <span class="mi">6</span><span class="n">c</span> <span class="mi">7</span><span class="n">d</span> <span class="mi">30</span> <span class="mi">59</span> <span class="n">be</span> <span class="mi">2</span><span class="n">f</span>

  533. <span class="mi">2021</span><span class="o">-</span><span class="mi">01</span><span class="o">-</span><span class="mi">11</span> <span class="mi">17</span><span class="p">:</span><span class="mi">40</span><span class="p">:</span><span class="mi">13</span><span class="p">,</span><span class="mi">058</span><span class="p">:</span> <span class="n">root</span><span class="o">.</span><span class="n">tcp_socket</span><span class="o">.</span><span class="n">example_client</span> <span class="o">-</span> <span class="n">INFO</span> <span class="o">-</span> <span class="n">comm</span><span class="o">-</span><span class="n">client</span><span class="p">:</span> <span class="n">RX</span>  <span class="o">&lt;-</span> <span class="s2">&quot;(62): 7b 22 64 61 74 61 5f 69 64 22 3a 20 30 2c 20 22 73 65 72 76 69 63 65 5f 69 64 22 3a 20 39 2c 20 22 73 74 61 74 75 73 22 3a 20 30 2c 20 22 64 61 74 61 22 3a 20 6e 75 6c 6c 7d 30 59 be 2f&quot;</span>

  534. <span class="mi">2021</span><span class="o">-</span><span class="mi">01</span><span class="o">-</span><span class="mi">11</span> <span class="mi">17</span><span class="p">:</span><span class="mi">40</span><span class="p">:</span><span class="mi">13</span><span class="p">,</span><span class="mi">058</span><span class="p">:</span> <span class="n">root</span><span class="o">.</span><span class="n">socket_protocol</span><span class="o">.</span><span class="n">example_client</span> <span class="o">-</span> <span class="n">INFO</span> <span class="o">-</span> <span class="n">prot</span><span class="o">-</span><span class="n">client</span><span class="p">:</span> <span class="n">RX</span> <span class="o">&lt;-</span> <span class="n">service</span><span class="p">:</span> <span class="n">channel</span> <span class="n">name</span> <span class="n">response</span><span class="p">,</span> <span class="n">data_id</span><span class="p">:</span> <span class="n">name</span><span class="p">,</span> <span class="n">status</span><span class="p">:</span> <span class="n">okay</span><span class="p">,</span> <span class="n">data</span><span class="p">:</span> <span class="s2">&quot;None&quot;</span>

  535. <span class="mi">2021</span><span class="o">-</span><span class="mi">01</span><span class="o">-</span><span class="mi">11</span> <span class="mi">17</span><span class="p">:</span><span class="mi">40</span><span class="p">:</span><span class="mi">13</span><span class="p">,</span><span class="mi">109</span><span class="p">:</span> <span class="n">root</span><span class="o">.</span><span class="n">stringtools</span><span class="o">.</span><span class="n">stp</span> <span class="o">-</span> <span class="n">INFO</span> <span class="o">-</span> <span class="n">STP</span><span class="p">:</span> <span class="n">message</span> <span class="n">identified</span> <span class="o">-</span> <span class="p">(</span><span class="mi">85</span><span class="p">):</span> <span class="mi">7</span><span class="n">b</span> <span class="mi">22</span> <span class="mi">64</span> <span class="mi">61</span> <span class="mi">74</span> <span class="mi">61</span> <span class="mi">5</span><span class="n">f</span> <span class="mi">69</span> <span class="mi">64</span> <span class="mi">22</span> <span class="mi">3</span><span class="n">a</span> <span class="mi">20</span> <span class="mi">30</span> <span class="mi">2</span><span class="n">c</span> <span class="mi">20</span> <span class="mi">22</span> <span class="mi">73</span> <span class="mi">65</span> <span class="mi">72</span> <span class="mi">76</span> <span class="mi">69</span> <span class="mi">63</span> <span class="mi">65</span> <span class="mi">5</span><span class="n">f</span> <span class="mi">69</span> <span class="mi">64</span> <span class="mi">22</span> <span class="mi">3</span><span class="n">a</span> <span class="mi">20</span> <span class="mi">31</span> <span class="mi">31</span> <span class="mi">2</span><span class="n">c</span> <span class="mi">20</span> <span class="mi">22</span> <span class="mi">73</span> <span class="mi">74</span> <span class="mi">61</span> <span class="mi">74</span> <span class="mi">75</span> <span class="mi">73</span> <span class="mi">22</span> <span class="mi">3</span><span class="n">a</span> <span class="mi">20</span> <span class="mi">30</span> <span class="mi">2</span><span class="n">c</span> <span class="mi">20</span> <span class="mi">22</span> <span class="mi">64</span> <span class="mi">61</span> <span class="mi">74</span> <span class="mi">61</span> <span class="mi">22</span> <span class="mi">3</span><span class="n">a</span> <span class="mi">20</span> <span class="mi">22</span> <span class="mi">4</span><span class="n">d</span> <span class="mi">6</span><span class="n">f</span> <span class="mi">6</span><span class="n">e</span> <span class="mi">20</span> <span class="mi">4</span><span class="n">a</span> <span class="mi">61</span> <span class="mi">6</span><span class="n">e</span> <span class="mi">20</span> <span class="mi">31</span> <span class="mi">31</span> <span class="mi">20</span> <span class="mi">31</span> <span class="mi">37</span> <span class="mi">3</span><span class="n">a</span> <span class="mi">34</span> <span class="mi">30</span> <span class="mi">3</span><span class="n">a</span> <span class="mi">31</span> <span class="mi">33</span> <span class="mi">20</span> <span class="mi">32</span> <span class="mi">30</span> <span class="mi">32</span> <span class="mi">31</span> <span class="mi">22</span> <span class="mi">7</span><span class="n">d</span> <span class="n">dd</span> <span class="mi">78</span> <span class="mi">8</span><span class="n">e</span> <span class="n">ae</span>

  536. <span class="mi">2021</span><span class="o">-</span><span class="mi">01</span><span class="o">-</span><span class="mi">11</span> <span class="mi">17</span><span class="p">:</span><span class="mi">40</span><span class="p">:</span><span class="mi">13</span><span class="p">,</span><span class="mi">109</span><span class="p">:</span> <span class="n">root</span><span class="o">.</span><span class="n">tcp_socket</span><span class="o">.</span><span class="n">example_client</span> <span class="o">-</span> <span class="n">INFO</span> <span class="o">-</span> <span class="n">comm</span><span class="o">-</span><span class="n">client</span><span class="p">:</span> <span class="n">RX</span>  <span class="o">&lt;-</span> <span class="s2">&quot;(85): 7b 22 64 61 74 61 5f 69 64 22 3a 20 30 2c 20 22 73 65 72 76 69 63 65 5f 69 64 22 3a 20 31 31 2c 20 22 73 74 61 74 75 73 22 3a 20 30 2c 20 22 64 61 74 61 22 3a 20 22 4d 6f 6e 20 4a 61 6e 20 31 31 20 31 37 3a 34 30 3a 31 33 20 32 30 32 31 22 7d dd 78 8e ae&quot;</span>

  537. <span class="mi">2021</span><span class="o">-</span><span class="mi">01</span><span class="o">-</span><span class="mi">11</span> <span class="mi">17</span><span class="p">:</span><span class="mi">40</span><span class="p">:</span><span class="mi">13</span><span class="p">,</span><span class="mi">110</span><span class="p">:</span> <span class="n">root</span><span class="o">.</span><span class="n">socket_protocol</span><span class="o">.</span><span class="n">example_client</span> <span class="o">-</span> <span class="n">INFO</span> <span class="o">-</span> <span class="n">prot</span><span class="o">-</span><span class="n">client</span><span class="p">:</span> <span class="n">RX</span> <span class="o">&lt;-</span> <span class="n">service</span><span class="p">:</span> <span class="n">read</span> <span class="n">data</span> <span class="n">response</span><span class="p">,</span> <span class="n">data_id</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="n">status</span><span class="p">:</span> <span class="n">okay</span><span class="p">,</span> <span class="n">data</span><span class="p">:</span> <span class="s2">&quot;&#39;Mon Jan 11 17:40:13 2021&#39;&quot;</span>

  538. <span class="n">The</span> <span class="n">Client</span> <span class="n">received</span><span class="p">:</span> <span class="s1">&#39;Mon Jan 11 17:40:13 2021&#39;</span>

  539. </pre></div>

  540. </div>

  541. <dl class="method">

  542. <dt id="socket_protocol.pure_json_protocol.add_data">

  543. <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>

  544. <dd><p>Method to add a name for a specific message.</p>

  545. <table class="docutils field-list" frame="void" rules="none">

  546. <col class="field-name" />

  547. <col class="field-body" />

  548. <tbody valign="top">

  549. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

  550. <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>

  551. <li><strong>data_id</strong> (<em>int</em>) – The Data-ID of the message.</li>

  552. <li><strong>name</strong> (<em>str</em>) – The Name for the transfered message.</li>

  553. </ul>

  554. </td>

  555. </tr>

  556. </tbody>

  557. </table>

  558. </dd></dl>

  559. 

  560. <dl class="method">

  561. <dt id="socket_protocol.pure_json_protocol.add_msg_to_auth_whitelist_">

  562. <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>

  563. <dd><p>Method to add a specific message to the list, where no authentification is required.</p>

  564. <table class="docutils field-list" frame="void" rules="none">

  565. <col class="field-name" />

  566. <col class="field-body" />

  567. <tbody valign="top">

  568. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

  569. <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>

  570. <li><strong>data_id</strong> (<em>int</em>) – The Data-ID of the message.</li>

  571. </ul>

  572. </td>

  573. </tr>

  574. </tbody>

  575. </table>

  576. </dd></dl>

  577. 

  578. <dl class="method">

  579. <dt id="socket_protocol.pure_json_protocol.add_service">

  580. <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>

  581. <dd><p>Method to add a Service defined by Request- and Response Serivce-ID.</p>

  582. <table class="docutils field-list" frame="void" rules="none">

  583. <col class="field-name" />

  584. <col class="field-body" />

  585. <tbody valign="top">

  586. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

  587. <li><strong>req_sid</strong> (<em>int</em>) – The Request Service-ID.</li>

  588. <li><strong>resp_sid</strong> (<em>int</em>) – The Response Service-ID.</li>

  589. </ul>

  590. </td>

  591. </tr>

  592. </tbody>

  593. </table>

  594. </dd></dl>

  595. 

  596. <dl class="method">

  597. <dt id="socket_protocol.pure_json_protocol.add_status">

  598. <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>

  599. <dd><p>Method to add a name for a status.</p>

  600. <table class="docutils field-list" frame="void" rules="none">

  601. <col class="field-name" />

  602. <col class="field-body" />

  603. <tbody valign="top">

  604. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

  605. <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>

  606. <li><strong>name</strong> (<em>str</em>) – The Name for the Status.</li>

  607. </ul>

  608. </td>

  609. </tr>

  610. </tbody>

  611. </table>

  612. </dd></dl>

  613. 

  614. <dl class="method">

  615. <dt id="socket_protocol.pure_json_protocol.authentificate">

  616. <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>

  617. <dd><p>This method authetificates the client at the server.</p>

  618. <table class="docutils field-list" frame="void" rules="none">

  619. <col class="field-name" />

  620. <col class="field-body" />

  621. <tbody valign="top">

  622. <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>

  623. </tr>

  624. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True, if authentification was successfull; False, if not.</td>

  625. </tr>

  626. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>

  627. </tr>

  628. </tbody>

  629. </table>

  630. <div class="admonition note">

  631. <p class="first admonition-title">Note</p>

  632. <p class="last">An authentification will only processed, if a secret had been given on initialisation.</p>

  633. </div>

  634. <div class="admonition note">

  635. <p class="first admonition-title">Note</p>

  636. <p class="last">Client and Server needs to use the same secret.</p>

  637. </div>

  638. </dd></dl>

  639. 

  640. <dl class="method">

  641. <dt id="socket_protocol.pure_json_protocol.check_authentification_state">

  642. <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>

  643. <dd><p>This Method return the Authitification State as boolean value.</p>

  644. <table class="docutils field-list" frame="void" rules="none">

  645. <col class="field-name" />

  646. <col class="field-body" />

  647. <tbody valign="top">

  648. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True, if authentification state is okay, otherwise False</td>

  649. </tr>

  650. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>

  651. </tr>

  652. </tbody>

  653. </table>

  654. </dd></dl>

  655. 

  656. <dl class="method">

  657. <dt id="socket_protocol.pure_json_protocol.connection_established">

  658. <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>

  659. <dd><p>This Method returns the Connection state including authentification as a boolean value.</p>

  660. <table class="docutils field-list" frame="void" rules="none">

  661. <col class="field-name" />

  662. <col class="field-body" />

  663. <tbody valign="top">

  664. <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>

  665. </tr>

  666. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>

  667. </tr>

  668. </tbody>

  669. </table>

  670. </dd></dl>

  671. 

  672. <dl class="method">

  673. <dt id="socket_protocol.pure_json_protocol.is_connected">

  674. <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>

  675. <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>

  676. <table class="docutils field-list" frame="void" rules="none">

  677. <col class="field-name" />

  678. <col class="field-body" />

  679. <tbody valign="top">

  680. <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>

  681. </tr>

  682. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>

  683. </tr>

  684. </tbody>

  685. </table>

  686. </dd></dl>

  687. 

  688. <dl class="method">

  689. <dt id="socket_protocol.pure_json_protocol.receive">

  690. <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>

  691. <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>

  692. <table class="docutils field-list" frame="void" rules="none">

  693. <col class="field-name" />

  694. <col class="field-body" />

  695. <tbody valign="top">

  696. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

  697. <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>

  698. <li><strong>data_id</strong> (<em>int</em>) – The Data-ID for the message.</li>

  699. <li><strong>timeout</strong> (<em>float</em>) – The timeout for receiving.</li>

  700. </ul>

  701. </td>

  702. </tr>

  703. <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>

  704. </td>

  705. </tr>

  706. <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>

  707. </td>

  708. </tr>

  709. </tbody>

  710. </table>

  711. </dd></dl>

  712. 

  713. <dl class="method">

  714. <dt id="socket_protocol.pure_json_protocol.reconnect">

  715. <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>

  716. <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>

  717. </dd></dl>

  718. 

  719. <dl class="method">

  720. <dt id="socket_protocol.pure_json_protocol.register_callback">

  721. <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>

  722. <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.

  723. If a message hitting these parameters has been received, the callback will be executed.</p>

  724. <table class="docutils field-list" frame="void" rules="none">

  725. <col class="field-name" />

  726. <col class="field-body" />

  727. <tbody valign="top">

  728. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

  729. <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>

  730. <li><strong>data_id</strong> (<em>int</em>) – The Data-ID for the message.</li>

  731. </ul>

  732. </td>

  733. </tr>

  734. </tbody>

  735. </table>

  736. <div class="admonition note">

  737. <p class="first admonition-title">Note</p>

  738. <p>The <code class="xref py py-func docutils literal notranslate"><span class="pre">callback()</span></code> is priorised in the following order:</p>

  739. <ul class="last simple">

  740. <li>Callbacks with defined Service-ID and Data-ID.</li>

  741. <li>Callbacks with a defined Service-ID and all Data-IDs.</li>

  742. <li>Callbacks with a defined Data-ID and all Service-IDs.</li>

  743. <li>Unspecific Callbacks.</li>

  744. </ul>

  745. </div>

  746. <div class="admonition note">

  747. <p class="first admonition-title">Note</p>

  748. <p>The <code class="xref py py-func docutils literal notranslate"><span class="pre">callback()</span></code> is executed with these arguments:</p>

  749. <p><strong>Parameters given at the callback call:</strong></p>

  750. <ul class="simple">

  751. <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>

  752. <li>Further arguments given at registration.</li>

  753. <li>Further keyword arguments given at registration.</li>

  754. </ul>

  755. <p><strong>Return value of the callback:</strong></p>

  756. <p>If the Callback is a Request Callback for a registered Service, the return value has to be a tuple or list with</p>

  757. <ul class="last simple">

  758. <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>

  759. <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>

  760. </ul>

  761. </div>

  762. <div class="admonition note">

  763. <p class="first admonition-title">Note</p>

  764. <p class="last">Only registered services will respond via the callbacks return values with the same data_id.</p>

  765. </div>

  766. </dd></dl>

  767. 

  768. <dl class="method">

  769. <dt id="socket_protocol.pure_json_protocol.send">

  770. <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>

  771. <dd><p>This methods sends out a message with the given content.</p>

  772. <table class="docutils field-list" frame="void" rules="none">

  773. <col class="field-name" />

  774. <col class="field-body" />

  775. <tbody valign="top">

  776. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

  777. <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>

  778. <li><strong>data_id</strong> (<em>int</em>) – The Data-ID for the message.</li>

  779. <li><strong>data</strong> (<em>str</em>) – The data to be transfered. The data needs to be json compatible.</li>

  780. <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>

  781. <li><strong>timeout</strong> (<em>float</em>) – The timeout for sending data (e.g. time to establish new connection).</li>

  782. </ul>

  783. </td>

  784. </tr>

  785. <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>

  786. </td>

  787. </tr>

  788. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p>

  789. </td>

  790. </tr>

  791. </tbody>

  792. </table>

  793. </dd></dl>

  794. 

  795. </dd></dl>

  796. 

  797. <dl class="class">

  798. <dt id="socket_protocol.struct_json_protocol">

  799. <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>

  800. <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.

  801. 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>

  802. <div class="admonition note">

  803. <p class="first admonition-title">Note</p>

  804. <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>

  805. </div>

  806. </dd></dl>

  807. 

  808. </div>

  809. <div class="toctree-wrapper compound">

  810. </div>

  811. </div>

  812. <div class="section" id="indices-and-tables">

  813. <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>

  814. <ul class="simple">

  815. <li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>

  816. <li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>

  817. <li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>

  818. </ul>

  819. </div>

  820. 

  821. 

  822.            </div>

  823.            

  824.           </div>

  825.           <footer>

  826.   

  827. 

  828.   <hr/>

  829. 

  830.   <div role="contentinfo">

  831.     <p>

  832.         

  833.         &copy; Copyright 2021, Dirk Alders

  834. 

  835.     </p>

  836.   </div>

  837.     

  838.     

  839.     

  840.     Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a

  841.     

  842.     <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>

  843.     

  844.     provided by <a href="https://readthedocs.org">Read the Docs</a>. 

  845. 

  846. </footer>

  847. 

  848.         </div>

  849.       </div>

  850. 

  851.     </section>

  852. 

  853.   </div>

  854.   

  855. 

  856.   <script type="text/javascript">

  857.       jQuery(function () {

  858.           SphinxRtdTheme.Navigation.enable(true);

  859.       });

  860.   </script>

  861. 

  862.   

  863.   

  864.     

  865.    

  866. 

  867. </body>

  868. </html>