aboutsummaryrefslogtreecommitdiffstats
path: root/utils/classes.html
diff options
context:
space:
mode:
Diffstat (limited to 'utils/classes.html')
-rw-r--r--utils/classes.html320
1 files changed, 315 insertions, 5 deletions
diff --git a/utils/classes.html b/utils/classes.html
index 3c681f4..7a43ac8 100644
--- a/utils/classes.html
+++ b/utils/classes.html
@@ -31,9 +31,9 @@
31 31
32 32
33 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> 33 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/>
34 <link rel="up" title="utils – Utilities" href="../utils.html"/> 34 <link rel="up" title="utils - Utilities" href="index.html"/>
35 <link rel="next" title="messages – Message Utilities" href="messages.html"/> 35 <link rel="next" title="messages – Message Utilities" href="messages.html"/>
36 <link rel="prev" title="utils – Utilities" href="../utils.html"/> 36 <link rel="prev" title="utils - Utilities" href="index.html"/>
37 37
38 38
39 <script src="../_static/js/modernizr.min.js"></script> 39 <script src="../_static/js/modernizr.min.js"></script>
@@ -91,10 +91,11 @@
91<li class="toctree-l2"><a class="reference internal" href="../receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li> 91<li class="toctree-l2"><a class="reference internal" href="../receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li>
92<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> 92<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="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li> 93<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 current"><a class="reference internal" href="../utils.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a><ul class="current"> 94<li class="toctree-l2 current"><a class="reference internal" href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> - Utilities</a><ul class="current">
95<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> 95<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"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Message Utilities</a></li> 96<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>
97<li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> &#8211; Time Utilites</a></li> 97<li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> &#8211; Time Utilites</a></li>
98<li class="toctree-l3"><a class="reference internal" href="index.html#id1"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li>
98</ul> 99</ul>
99</li> 100</li>
100</ul> 101</ul>
@@ -132,7 +133,7 @@
132 133
133 <li><a href="../api.html">API Documentation</a> &raquo;</li> 134 <li><a href="../api.html">API Documentation</a> &raquo;</li>
134 135
135 <li><a href="../utils.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a> &raquo;</li> 136 <li><a href="index.html"><code class="docutils literal"><span class="pre">utils</span></code> - Utilities</a> &raquo;</li>
136 137
137 <li><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</li> 138 <li><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</li>
138 <li class="wy-breadcrumbs-aside"> 139 <li class="wy-breadcrumbs-aside">
@@ -152,6 +153,315 @@
152<h1><code class="xref py py-mod docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes<a class="headerlink" href="#classes-utility-classes" title="Permalink to this headline">¶</a></h1> 153<h1><code class="xref py py-mod docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes<a class="headerlink" href="#classes-utility-classes" title="Permalink to this headline">¶</a></h1>
153<p>Defines some classes to use when implementing ZMQ devices</p> 154<p>Defines some classes to use when implementing ZMQ devices</p>
154<dl class="class"> 155<dl class="class">
156<dt id="eventmq.utils.classes.EMQPService">
157<em class="property">class </em><code class="descclassname">eventmq.utils.classes.</code><code class="descname">EMQPService</code><a class="headerlink" href="#eventmq.utils.classes.EMQPService" title="Permalink to this definition">¶</a></dt>
158<dd><p>Helper for devices that connect to brokers.</p>
159<p>Implements utility methods for sending EMQP messages for the following
160EMQP commands.</p>
161<blockquote>
162<div><ul class="simple">
163<li>INFORM</li>
164</ul>
165</div></blockquote>
166<p>Also implements utlitiy methods for managing long-running processes.</p>
167<dl class="docutils">
168<dt>To use you must define:</dt>
169<dd><ul class="first last simple">
170<li><cite>self.outgoing</cite> - socket where messages can be sent to the Router</li>
171<li><cite>self.SERVICE_TYPE</cite> - defines the service type for INFORM. See
172<a class="reference internal" href="#eventmq.utils.classes.EMQPService.send_inform" title="eventmq.utils.classes.EMQPService.send_inform"><code class="xref py py-meth docutils literal"><span class="pre">send_inform()</span></code></a> for more information.</li>
173<li><cite>self.poller</cite> - the poller that <cite>self.outgoing</cite> will be using.
174Usually: <cite>self.poller = eventmq.poller.Poller()</cite></li>
175</ul>
176</dd>
177</dl>
178<p>When messages are received from the router, they are processed in
179<a class="reference internal" href="#eventmq.utils.classes.EMQPService.process_message" title="eventmq.utils.classes.EMQPService.process_message"><code class="xref py py-meth docutils literal"><span class="pre">process_message()</span></code></a> which then calls <cite>on_COMMAND</cite>. This should be used
180in the event loop so if you want to respond to the SCHEDULE command, you
181would define the method <cite>on_schedule</cite> in your service class.</p>
182<p>See the code for <code class="xref py py-class docutils literal"><span class="pre">Scheduler</span></code> and <code class="xref py py-class docutils literal"><span class="pre">JobManager</span></code> for examples.</p>
183<dl class="attribute">
184<dt id="eventmq.utils.classes.EMQPService.__weakref__">
185<code class="descname">__weakref__</code><a class="headerlink" href="#eventmq.utils.classes.EMQPService.__weakref__" title="Permalink to this definition">¶</a></dt>
186<dd><p>list of weak references to the object (if defined)</p>
187</dd></dl>
188
189<dl class="attribute">
190<dt id="eventmq.utils.classes.EMQPService.is_heartbeat_enabled">
191<code class="descname">is_heartbeat_enabled</code><a class="headerlink" href="#eventmq.utils.classes.EMQPService.is_heartbeat_enabled" title="Permalink to this definition">¶</a></dt>
192<dd><p>Property to check if heartbeating is enabled. Useful when certain
193properties must be updated for heartbeating
194:returns: bool - True if heartbeating is enabled, False if it isn&#8217;t</p>
195</dd></dl>
196
197<dl class="method">
198<dt id="eventmq.utils.classes.EMQPService.on_ack">
199<code class="descname">on_ack</code><span class="sig-paren">(</span><em>msgid</em>, <em>ackd_msgid</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQPService.on_ack" title="Permalink to this definition">¶</a></dt>
200<dd><p>Sets <code class="xref py py-attr docutils literal"><span class="pre">awaiting_ack</span></code> to False</p>
201</dd></dl>
202
203<dl class="method">
204<dt id="eventmq.utils.classes.EMQPService.process_message">
205<code class="descname">process_message</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQPService.process_message" title="Permalink to this definition">¶</a></dt>
206<dd><p>Processes a message. Processing takes form of calling an
207<cite>on_EMQP_COMMAND</cite> method. The method must accept <cite>msgid</cite> and <cite>message</cite>
208as the first arguments.</p>
209<table class="docutils field-list" frame="void" rules="none">
210<col class="field-name" />
211<col class="field-body" />
212<tbody valign="top">
213<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>msg</strong> &#8211; The message received from the socket to parse and process.</td>
214</tr>
215</tbody>
216</table>
217</dd></dl>
218
219<dl class="method">
220<dt id="eventmq.utils.classes.EMQPService.reset">
221<code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQPService.reset" title="Permalink to this definition">¶</a></dt>
222<dd><p>Resets the current connection by closing and reopening the socket</p>
223</dd></dl>
224
225<dl class="method">
226<dt id="eventmq.utils.classes.EMQPService.send_inform">
227<code class="descname">send_inform</code><span class="sig-paren">(</span><em>queue=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQPService.send_inform" title="Permalink to this definition">¶</a></dt>
228<dd><p>Queues an INFORM command to <cite>self.outgoing</cite>.</p>
229<table class="docutils field-list" frame="void" rules="none">
230<col class="field-name" />
231<col class="field-body" />
232<tbody valign="top">
233<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
234<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>
235<li><strong>queue</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>
236<li>For &#8216;worker&#8217; type, the queues the worker is listening on</li>
237<li>Ignored for &#8216;scheduler&#8217; type</li>
238</ul>
239</li>
240</ul>
241</td>
242</tr>
243<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><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>
244</td>
245</tr>
246</tbody>
247</table>
248</dd></dl>
249
250<dl class="method">
251<dt id="eventmq.utils.classes.EMQPService.start">
252<code class="descname">start</code><span class="sig-paren">(</span><em>addr</em>, <em>queues='default'</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQPService.start" title="Permalink to this definition">¶</a></dt>
253<dd><p>Connect to <cite>addr</cite> and begin listening for job requests</p>
254<table class="docutils field-list" frame="void" rules="none">
255<col class="field-name" />
256<col class="field-body" />
257<tbody valign="top">
258<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>
259</tr>
260</tbody>
261</table>
262</dd></dl>
263
264</dd></dl>
265
266<dl class="class">
267<dt id="eventmq.utils.classes.EMQdeque">
268<em class="property">class </em><code class="descclassname">eventmq.utils.classes.</code><code class="descname">EMQdeque</code><span class="sig-paren">(</span><em>full=None</em>, <em>pfull=None</em>, <em>on_full=None</em>, <em>initial=()</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQdeque" title="Permalink to this definition">¶</a></dt>
269<dd><p>EventMQ deque based on python&#8217;s collections.deque with full and
270programmable full.</p>
271<div class="admonition note">
272<p class="first admonition-title">Note</p>
273<p class="last">Because of the programmable full, some of the methods that would
274normally return None return a boolean value that should be captured and
275checked to ensure proper error handling.</p>
276</div>
277<dl class="method">
278<dt id="eventmq.utils.classes.EMQdeque.__init__">
279<code class="descname">__init__</code><span class="sig-paren">(</span><em>full=None</em>, <em>pfull=None</em>, <em>on_full=None</em>, <em>initial=()</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQdeque.__init__" title="Permalink to this definition">¶</a></dt>
280<dd><table class="docutils field-list" frame="void" rules="none">
281<col class="field-name" />
282<col class="field-body" />
283<tbody valign="top">
284<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
285<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.
286Default: 0 - no limit</li>
287<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
288to <code class="docutils literal"><span class="pre">full</span></code> length</li>
289<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>
290<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>
291</ul>
292</td>
293</tr>
294</tbody>
295</table>
296</dd></dl>
297
298<dl class="attribute">
299<dt id="eventmq.utils.classes.EMQdeque.__weakref__">
300<code class="descname">__weakref__</code><a class="headerlink" href="#eventmq.utils.classes.EMQdeque.__weakref__" title="Permalink to this definition">¶</a></dt>
301<dd><p>list of weak references to the object (if defined)</p>
302</dd></dl>
303
304<dl class="method">
305<dt id="eventmq.utils.classes.EMQdeque.append">
306<code class="descname">append</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQdeque.append" title="Permalink to this definition">¶</a></dt>
307<dd><p>Append item to the right this deque if the deque isn&#8217;t full.</p>
308<div class="admonition note">
309<p class="first admonition-title">Note</p>
310<p class="last">You should check the return value of this call and handle the cases
311where False is returned.</p>
312</div>
313<table class="docutils field-list" frame="void" rules="none">
314<col class="field-name" />
315<col class="field-body" />
316<tbody valign="top">
317<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
318is 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
319called.</td>
320</tr>
321<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>
322</tr>
323</tbody>
324</table>
325</dd></dl>
326
327<dl class="method">
328<dt id="eventmq.utils.classes.EMQdeque.appendleft">
329<code class="descname">appendleft</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQdeque.appendleft" title="Permalink to this definition">¶</a></dt>
330<dd><p>Append item to the left this deque if the deque isn&#8217;t full.</p>
331<div class="admonition note">
332<p class="first admonition-title">Note</p>
333<p class="last">You should check the return value of this call and handle the cases
334where False is returned.</p>
335</div>
336<table class="docutils field-list" frame="void" rules="none">
337<col class="field-name" />
338<col class="field-body" />
339<tbody valign="top">
340<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
341is 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
342called.</td>
343</tr>
344<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>
345</tr>
346</tbody>
347</table>
348</dd></dl>
349
350<dl class="method">
351<dt id="eventmq.utils.classes.EMQdeque.extend">
352<code class="descname">extend</code><span class="sig-paren">(</span><em>iterable</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQdeque.extend" title="Permalink to this definition">¶</a></dt>
353<dd><p>append <code class="docutils literal"><span class="pre">iterable</span></code> to the right (end) of the deque</p>
354<table class="docutils field-list" frame="void" rules="none">
355<col class="field-name" />
356<col class="field-body" />
357<tbody valign="top">
358<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
359is 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
360called.</td>
361</tr>
362<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>
363</tr>
364</tbody>
365</table>
366</dd></dl>
367
368<dl class="method">
369<dt id="eventmq.utils.classes.EMQdeque.is_empty">
370<code class="descname">is_empty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQdeque.is_empty" title="Permalink to this definition">¶</a></dt>
371<dd><p>Check to see if the deque contains no items.</p>
372<table class="docutils field-list" frame="void" rules="none">
373<col class="field-name" />
374<col class="field-body" />
375<tbody valign="top">
376<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>
377</tr>
378<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>
379</tr>
380</tbody>
381</table>
382</dd></dl>
383
384<dl class="method">
385<dt id="eventmq.utils.classes.EMQdeque.is_full">
386<code class="descname">is_full</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQdeque.is_full" title="Permalink to this definition">¶</a></dt>
387<dd><p>Check to see if the deque contains <code class="docutils literal"><span class="pre">self.full</span></code> items.</p>
388<table class="docutils field-list" frame="void" rules="none">
389<col class="field-name" />
390<col class="field-body" />
391<tbody valign="top">
392<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
393otherwise</td>
394</tr>
395<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>
396</tr>
397</tbody>
398</table>
399</dd></dl>
400
401<dl class="method">
402<dt id="eventmq.utils.classes.EMQdeque.is_pfull">
403<code class="descname">is_pfull</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQdeque.is_pfull" title="Permalink to this definition">¶</a></dt>
404<dd><p>Check to see if the deque contains <code class="docutils literal"><span class="pre">self.pfull</span></code> items.</p>
405<table class="docutils field-list" frame="void" rules="none">
406<col class="field-name" />
407<col class="field-body" />
408<tbody valign="top">
409<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.
410False otherwise</td>
411</tr>
412<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>
413</tr>
414</tbody>
415</table>
416</dd></dl>
417
418<dl class="method">
419<dt id="eventmq.utils.classes.EMQdeque.pop">
420<code class="descname">pop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQdeque.pop" title="Permalink to this definition">¶</a></dt>
421<dd><table class="docutils field-list" frame="void" rules="none">
422<col class="field-name" />
423<col class="field-body" />
424<tbody valign="top">
425<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the last (right-most) element of the deque</td>
426</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/library/functions.html#object" title="(in Python v2.7)">object</a></td>
428</tr>
429</tbody>
430</table>
431</dd></dl>
432
433<dl class="method">
434<dt id="eventmq.utils.classes.EMQdeque.popleft">
435<code class="descname">popleft</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQdeque.popleft" title="Permalink to this definition">¶</a></dt>
436<dd><table class="docutils field-list" frame="void" rules="none">
437<col class="field-name" />
438<col class="field-body" />
439<tbody valign="top">
440<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the first (left-most) element of the deque</td>
441</tr>
442<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>
443</tr>
444</tbody>
445</table>
446</dd></dl>
447
448<dl class="method">
449<dt id="eventmq.utils.classes.EMQdeque.remove">
450<code class="descname">remove</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.EMQdeque.remove" title="Permalink to this definition">¶</a></dt>
451<dd><p>Remove <code class="docutils literal"><span class="pre">item</span></code> from the deque.</p>
452<table class="docutils field-list" frame="void" rules="none">
453<col class="field-name" />
454<col class="field-body" />
455<tbody valign="top">
456<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>
457</tr>
458</tbody>
459</table>
460</dd></dl>
461
462</dd></dl>
463
464<dl class="class">
155<dt id="eventmq.utils.classes.HeartbeatMixin"> 465<dt id="eventmq.utils.classes.HeartbeatMixin">
156<em class="property">class </em><code class="descclassname">eventmq.utils.classes.</code><code class="descname">HeartbeatMixin</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.HeartbeatMixin" title="Permalink to this definition">¶</a></dt> 466<em class="property">class </em><code class="descclassname">eventmq.utils.classes.</code><code class="descname">HeartbeatMixin</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.HeartbeatMixin" title="Permalink to this definition">¶</a></dt>
157<dd><p>Provides methods for implementing heartbeats</p> 467<dd><p>Provides methods for implementing heartbeats</p>
@@ -305,7 +615,7 @@ specify the the recipient id of the remote socket</li>
305 <a href="messages.html" class="btn btn-neutral float-right" title="messages – Message Utilities" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> 615 <a href="messages.html" class="btn btn-neutral float-right" title="messages – Message Utilities" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
306 616
307 617
308 <a href="../utils.html" class="btn btn-neutral" title="utils – Utilities" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> 618 <a href="index.html" class="btn btn-neutral" title="utils - Utilities" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
309 619
310 </div> 620 </div>
311 621
generated by cgit v1.2.1 (git 2.18.0) at 2026-01-12 04:52:59 +0000