aboutsummaryrefslogtreecommitdiffstats
path: root/utils/classes.html
diff options
context:
space:
mode:
authorjason2016-11-03 12:32:14 -0600
committerjason2016-11-03 12:32:14 -0600
commit9efcd5a66dc49854841da317fd89c49ed778a669 (patch)
tree7811139e9e0f31ce63531aa3a911331ce4436a5d /utils/classes.html
parent02002cd2f9b3521f803e992dd4b6cabc9f0aea5d (diff)
downloadeventmq-9efcd5a66dc49854841da317fd89c49ed778a669.tar.gz
eventmq-9efcd5a66dc49854841da317fd89c49ed778a669.zip
update docs
Diffstat (limited to 'utils/classes.html')
-rw-r--r--utils/classes.html124
1 files changed, 70 insertions, 54 deletions
diff --git a/utils/classes.html b/utils/classes.html
index 9f055f2..4e1ae6d 100644
--- a/utils/classes.html
+++ b/utils/classes.html
@@ -30,9 +30,6 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="../genindex.html"/>
35 <link rel="search" title="Search" href="../search.html"/>
36 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/>
37 <link rel="up" title="utils – Utilities" href="index.html"/> 34 <link rel="up" title="utils – Utilities" href="index.html"/>
38 <link rel="next" title="devices – Device Utilities" href="devices.html"/> 35 <link rel="next" title="devices – Device Utilities" href="devices.html"/>
@@ -64,7 +61,7 @@
64 61
65 62
66 <div class="version"> 63 <div class="version">
67 0.2.6.3 64 0.2.6.5
68 </div> 65 </div>
69 66
70 67
@@ -96,7 +93,7 @@
96<li class="toctree-l2"><a class="reference internal" href="../router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li> 93<li class="toctree-l2"><a class="reference internal" href="../router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li>
97<li class="toctree-l2"><a class="reference internal" href="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li> 94<li class="toctree-l2"><a class="reference internal" href="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li>
98<li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a><ul class="current"> 95<li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a><ul class="current">
99<li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</a></li> 96<li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</a></li>
100<li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device Utilities</a></li> 97<li class="toctree-l3"><a class="reference internal" href="devices.html"><code class="docutils literal"><span class="pre">devices</span></code> &#8211; Device Utilities</a></li>
101<li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li> 98<li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li>
102<li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal"><span class="pre">settings</span></code> &#8211; Settings Utilities</a></li> 99<li class="toctree-l3"><a class="reference internal" href="settings.html"><code class="docutils literal"><span class="pre">settings</span></code> &#8211; Settings Utilities</a></li>
@@ -128,7 +125,7 @@
128 <div class="rst-content"> 125 <div class="rst-content">
129 126
130 127
131 128
132 129
133 130
134 131
@@ -238,8 +235,8 @@ for.</p>
238<col class="field-body" /> 235<col class="field-body" />
239<tbody valign="top"> 236<tbody valign="top">
240<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 237<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
241<li><strong>type</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Either &#8216;worker&#8217; or &#8216;scheduler&#8217;</li> 238<li><strong>type</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Either &#8216;worker&#8217; or &#8216;scheduler&#8217;</li>
242<li><strong>queues</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; <ul> 239<li><strong>queues</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; <ul>
243<li>For &#8216;worker&#8217; type, the queues the worker is listening on and 240<li>For &#8216;worker&#8217; type, the queues the worker is listening on and
244their weights.<dl class="docutils"> 241their weights.<dl class="docutils">
245<dt>Example:</dt> 242<dt>Example:</dt>
@@ -252,13 +249,14 @@ their weights.<dl class="docutils">
252</ul> 249</ul>
253</td> 250</td>
254</tr> 251</tr>
255<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><code class="xref py py-exc docutils literal"><span class="pre">ValueError</span></code> &#8211; When <cite>type_</cite> does not match a specified type</p> 252<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><code class="xref py py-exc docutils literal"><span class="pre">ValueError</span></code> &#8211;
253When <cite>type_</cite> does not match a specified type</p>
256</td> 254</td>
257</tr> 255</tr>
258<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p> 256<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p>
259</td> 257</td>
260</tr> 258</tr>
261<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p> 259<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a></p>
262</td> 260</td>
263</tr> 261</tr>
264</tbody> 262</tbody>
@@ -278,7 +276,7 @@ compatibility and not recommended for new apps.</p>
278<col class="field-name" /> 276<col class="field-name" />
279<col class="field-body" /> 277<col class="field-body" />
280<tbody valign="top"> 278<tbody valign="top">
281<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; connection string to connect to</td> 279<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; connection string to connect to</td>
282</tr> 280</tr>
283</tbody> 281</tbody>
284</table> 282</table>
@@ -305,12 +303,12 @@ checked to ensure proper error handling.</p>
305<col class="field-body" /> 303<col class="field-body" />
306<tbody valign="top"> 304<tbody valign="top">
307<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 305<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
308<li><strong>full</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Hard limit on deque size. Rejects adding elements. 306<li><strong>full</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Hard limit on deque size. Rejects adding elements.
309Default: 0 - no limit</li> 307Default: 0 - no limit</li>
310<li><strong>pfull</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Programmable limit on deque size, defaults 308<li><strong>pfull</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Programmable limit on deque size, defaults
311to <code class="docutils literal"><span class="pre">full</span></code> length</li> 309to <code class="docutils literal"><span class="pre">full</span></code> length</li>
312<li><strong>on_full</strong> (<em>func</em>) &#8211; callback to call when <code class="docutils literal"><span class="pre">full</span></code> limit is hit</li> 310<li><strong>on_full</strong> (<em>func</em>) &#8211; callback to call when <code class="docutils literal"><span class="pre">full</span></code> limit is hit</li>
313<li><strong>initial</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#iter" title="(in Python v2.7)"><em>iter</em></a>) &#8211; The initial iteratable used to contruct the deque</li> 311<li><strong>initial</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#iter" title="(in Python v2.7)"><em>iter</em></a>) &#8211; The initial iteratable used to contruct the deque</li>
314</ul> 312</ul>
315</td> 313</td>
316</tr> 314</tr>
@@ -337,14 +335,11 @@ where False is returned.</p>
337<col class="field-name" /> 335<col class="field-name" />
338<col class="field-body" /> 336<col class="field-body" />
339<tbody valign="top"> 337<tbody valign="top">
340<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> 338<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque
341<dt>True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque</dt> 339is at the <code class="docutils literal"><span class="pre">self.full</span></code> limit. If it is, <code class="docutils literal"><span class="pre">self.on_full</span></code> is
342<dd>is at the <code class="docutils literal"><span class="pre">self.full</span></code> limit. If it is, <code class="docutils literal"><span class="pre">self.on_full</span></code> is 340called.</td>
343called.</dd>
344</dl>
345</td>
346</tr> 341</tr>
347<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td> 342<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
348</tr> 343</tr>
349</tbody> 344</tbody>
350</table> 345</table>
@@ -363,14 +358,11 @@ where False is returned.</p>
363<col class="field-name" /> 358<col class="field-name" />
364<col class="field-body" /> 359<col class="field-body" />
365<tbody valign="top"> 360<tbody valign="top">
366<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> 361<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque
367<dt>True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque</dt> 362is at the <code class="docutils literal"><span class="pre">self.full</span></code> limit. If it is, <code class="docutils literal"><span class="pre">self.on_full</span></code> is
368<dd>is at the <code class="docutils literal"><span class="pre">self.full</span></code> limit. If it is, <code class="docutils literal"><span class="pre">self.on_full</span></code> is 363called.</td>
369called.</dd>
370</dl>
371</td>
372</tr> 364</tr>
373<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td> 365<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
374</tr> 366</tr>
375</tbody> 367</tbody>
376</table> 368</table>
@@ -384,14 +376,11 @@ called.</dd>
384<col class="field-name" /> 376<col class="field-name" />
385<col class="field-body" /> 377<col class="field-body" />
386<tbody valign="top"> 378<tbody valign="top">
387<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> 379<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque
388<dt>True if <code class="docutils literal"><span class="pre">item</span></code> was successfully added, False if the deque</dt> 380is at the <code class="docutils literal"><span class="pre">self.full</span></code> limit. If it is, <code class="docutils literal"><span class="pre">self.on_full</span></code> is
389<dd>is at the <code class="docutils literal"><span class="pre">self.full</span></code> limit. If it is, <code class="docutils literal"><span class="pre">self.on_full</span></code> is 381called.</td>
390called.</dd>
391</dl>
392</td>
393</tr> 382</tr>
394<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td> 383<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
395</tr> 384</tr>
396</tbody> 385</tbody>
397</table> 386</table>
@@ -407,7 +396,7 @@ called.</dd>
407<tbody valign="top"> 396<tbody valign="top">
408<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the deque contains 0 items. False otherwise</td> 397<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the deque contains 0 items. False otherwise</td>
409</tr> 398</tr>
410<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td> 399<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
411</tr> 400</tr>
412</tbody> 401</tbody>
413</table> 402</table>
@@ -424,7 +413,7 @@ called.</dd>
424<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the deque contains at least <code class="docutils literal"><span class="pre">full</span></code> items. False 413<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the deque contains at least <code class="docutils literal"><span class="pre">full</span></code> items. False
425otherwise</td> 414otherwise</td>
426</tr> 415</tr>
427<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td> 416<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
428</tr> 417</tr>
429</tbody> 418</tbody>
430</table> 419</table>
@@ -441,7 +430,37 @@ otherwise</td>
441<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the deque contains at least <code class="docutils literal"><span class="pre">pfull</span></code> items. 430<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the deque contains at least <code class="docutils literal"><span class="pre">pfull</span></code> items.
442False otherwise</td> 431False otherwise</td>
443</tr> 432</tr>
444<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td> 433<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
434</tr>
435</tbody>
436</table>
437</dd></dl>
438
439<dl class="method">
440<dt id="eventmq.utils.classes.EMQdeque.peek">
441<code class="descname">peek</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQdeque.peek" title="Permalink to this definition">¶</a></dt>
442<dd><table class="docutils field-list" frame="void" rules="none">
443<col class="field-name" />
444<col class="field-body" />
445<tbody valign="top">
446<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the last (right-most) element of the deque</td>
447</tr>
448<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#object" title="(in Python v2.7)">object</a></td>
449</tr>
450</tbody>
451</table>
452</dd></dl>
453
454<dl class="method">
455<dt id="eventmq.utils.classes.EMQdeque.peekleft">
456<code class="descname">peekleft</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQdeque.peekleft" title="Permalink to this definition">¶</a></dt>
457<dd><table class="docutils field-list" frame="void" rules="none">
458<col class="field-name" />
459<col class="field-body" />
460<tbody valign="top">
461<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the first (left-most) element of the deque</td>
462</tr>
463<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#object" title="(in Python v2.7)">object</a></td>
445</tr> 464</tr>
446</tbody> 465</tbody>
447</table> 466</table>
@@ -456,7 +475,7 @@ False otherwise</td>
456<tbody valign="top"> 475<tbody valign="top">
457<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the last (right-most) element of the deque</td> 476<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the last (right-most) element of the deque</td>
458</tr> 477</tr>
459<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)">object</a></td> 478<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#object" title="(in Python v2.7)">object</a></td>
460</tr> 479</tr>
461</tbody> 480</tbody>
462</table> 481</table>
@@ -471,7 +490,7 @@ False otherwise</td>
471<tbody valign="top"> 490<tbody valign="top">
472<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the first (left-most) element of the deque</td> 491<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the first (left-most) element of the deque</td>
473</tr> 492</tr>
474<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)">object</a></td> 493<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#object" title="(in Python v2.7)">object</a></td>
475</tr> 494</tr>
476</tbody> 495</tbody>
477</table> 496</table>
@@ -485,7 +504,7 @@ False otherwise</td>
485<col class="field-name" /> 504<col class="field-name" />
486<col class="field-body" /> 505<col class="field-body" />
487<tbody valign="top"> 506<tbody valign="top">
488<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>item</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><em>object</em></a>) &#8211; The item to remove from the deque</td> 507<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>item</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><em>object</em></a>) &#8211; The item to remove from the deque</td>
489</tr> 508</tr>
490</tbody> 509</tbody>
491</table> 510</table>
@@ -518,17 +537,14 @@ met.</p>
518<col class="field-name" /> 537<col class="field-name" />
519<col class="field-body" /> 538<col class="field-body" />
520<tbody valign="top"> 539<tbody valign="top">
521<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>now</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#float" title="(in Python v2.7)"><em>float</em></a>) &#8211; The time to use to check if death has occurred. If 540<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>now</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#float" title="(in Python v2.7)"><em>float</em></a>) &#8211; The time to use to check if death has occurred. If
522this value is None, then <code class="xref py py-func docutils literal"><span class="pre">utils.timeutils.monotonic()</span></code> 541this value is None, then <code class="xref py py-func docutils literal"><span class="pre">utils.timeutils.monotonic()</span></code>
523is used.</td> 542is used.</td>
524</tr> 543</tr>
525<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> 544<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the connection to the peer has died, otherwise
526<dt>True if the connection to the peer has died, otherwise</dt> 545False</td>
527<dd>False</dd>
528</dl>
529</td>
530</tr> 546</tr>
531<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td> 547<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
532</tr> 548</tr>
533</tbody> 549</tbody>
534</table> 550</table>
@@ -548,11 +564,11 @@ is used.</td>
548<col class="field-name" /> 564<col class="field-name" />
549<col class="field-body" /> 565<col class="field-body" />
550<tbody valign="top"> 566<tbody valign="top">
551<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/2/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; The eMQP socket to send the message to</td> 567<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; The eMQP socket to send the message to</td>
552</tr> 568</tr>
553<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ID of the message</td> 569<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ID of the message</td>
554</tr> 570</tr>
555<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></td> 571<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a></td>
556</tr> 572</tr>
557</tbody> 573</tbody>
558</table> 574</table>
@@ -606,7 +622,7 @@ on it&#8217;s own</p>
606<tbody valign="top"> 622<tbody valign="top">
607<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 623<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
608<li><strong>message</strong> &#8211; message to send to something</li> 624<li><strong>message</strong> &#8211; message to send to something</li>
609<li><strong>protocol_version</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; protocol version. it&#8217;s good practice, but 625<li><strong>protocol_version</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; protocol version. it&#8217;s good practice, but
610you may explicitly specify None to skip adding the version</li> 626you may explicitly specify None to skip adding the version</li>
611</ul> 627</ul>
612</td> 628</td>
@@ -628,10 +644,10 @@ like this</p>
628<col class="field-body" /> 644<col class="field-body" />
629<tbody valign="top"> 645<tbody valign="top">
630<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 646<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
631<li><strong>message</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#tuple" title="(in Python v2.7)"><em>tuple</em></a>) &#8211; Raw message to send.</li> 647<li><strong>message</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#tuple" title="(in Python v2.7)"><em>tuple</em></a>) &#8211; Raw message to send.</li>
632<li><strong>protocol_version</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; protocol version. it&#8217;s good practice but 648<li><strong>protocol_version</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; protocol version. it&#8217;s good practice but
633you may explicitly specify None to skip adding the version</li> 649you may explicitly specify None to skip adding the version</li>
634<li><strong>_recipient_id</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><em>object</em></a>) &#8211; When using a <code class="xref py py-attr docutils literal"><span class="pre">zmq.ROUTER</span></code> you must 650<li><strong>_recipient_id</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><em>object</em></a>) &#8211; When using a <code class="xref py py-attr docutils literal"><span class="pre">zmq.ROUTER</span></code> you must
635specify the the recipient id of the remote socket</li> 651specify the the recipient id of the remote socket</li>
636</ul> 652</ul>
637</td> 653</td>
generated by cgit v1.2.1 (git 2.18.0) at 2026-01-13 04:00:46 +0000