aboutsummaryrefslogtreecommitdiffstats
path: root/utils/classes.html
diff options
context:
space:
mode:
authorjason2015-11-23 20:30:11 -0700
committerjason2015-11-23 20:30:11 -0700
commitd04b9708d570bb227aeff7725af8ebbf15dac3e1 (patch)
treead5630f35d6c5d29072b738009d0acee6edc9453 /utils/classes.html
parent24e99bd13b6d10301484556107841de8ba8ac9e0 (diff)
downloadeventmq-d04b9708d570bb227aeff7725af8ebbf15dac3e1.tar.gz
eventmq-d04b9708d570bb227aeff7725af8ebbf15dac3e1.zip
updates
Diffstat (limited to 'utils/classes.html')
-rw-r--r--utils/classes.html304
1 files changed, 304 insertions, 0 deletions
diff --git a/utils/classes.html b/utils/classes.html
new file mode 100644
index 0000000..59b9512
--- /dev/null
+++ b/utils/classes.html
@@ -0,0 +1,304 @@
1
2
3<!DOCTYPE html>
4<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6<head>
7 <meta charset="utf-8">
8
9 <meta name="viewport" content="width=device-width, initial-scale=1.0">
10
11 <title>classes – Utility Classes &mdash; EventMQ 0 documentation</title>
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27 <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
28
29
30
31
32
33 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/>
34 <link rel="up" title="utils – Utilities" href="../utils.html"/>
35 <link rel="next" title="utils.messages – Message Utilities" href="messages.html"/>
36 <link rel="prev" title="utils – Utilities" href="../utils.html"/>
37
38
39 <script src="../_static/js/modernizr.min.js"></script>
40
41</head>
42
43<body class="wy-body-for-nav" role="document">
44
45 <div class="wy-grid-for-nav">
46
47
48 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
49 <div class="wy-side-scroll">
50 <div class="wy-side-nav-search">
51
52
53
54 <a href="../index.html" class="icon icon-home"> EventMQ
55
56
57
58 </a>
59
60
61
62
63 <div class="version">
64 0
65 </div>
66
67
68
69
70<div role="search">
71 <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
72 <input type="text" name="q" placeholder="Search docs" />
73 <input type="hidden" name="check_keywords" value="yes" />
74 <input type="hidden" name="area" value="default" />
75 </form>
76</div>
77
78
79 </div>
80
81 <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
82
83
84
85 <ul class="current">
86<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</a><ul class="current">
87<li class="toctree-l2"><a class="reference internal" href="../exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> &#8211; Exceptions</a></li>
88<li class="toctree-l2"><a class="reference internal" href="../jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li>
89<li class="toctree-l2"><a class="reference internal" href="../poller.html"><code class="docutils literal"><span class="pre">poller</span></code> &#8211; Poller</a></li>
90<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="../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="../sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li>
93<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-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"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">utils.messages</span></code> &#8211; Message Utilities</a></li>
96</ul>
97</li>
98</ul>
99</li>
100<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing to EventMQ</a></li>
101</ul>
102
103
104
105 </div>
106 </div>
107 </nav>
108
109 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
110
111
112 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
113 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
114 <a href="../index.html">EventMQ</a>
115 </nav>
116
117
118
119 <div class="wy-nav-content">
120 <div class="rst-content">
121
122
123
124
125
126
127<div role="navigation" aria-label="breadcrumbs navigation">
128 <ul class="wy-breadcrumbs">
129 <li><a href="../index.html">Docs</a> &raquo;</li>
130
131 <li><a href="../api.html">API Documentation</a> &raquo;</li>
132
133 <li><a href="../utils.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a> &raquo;</li>
134
135 <li><code class="docutils literal"><span class="pre">classes</span></code> &#8211; Utility Classes</li>
136 <li class="wy-breadcrumbs-aside">
137
138
139 <a href="../_sources/utils/classes.txt" rel="nofollow"> View page source</a>
140
141
142 </li>
143 </ul>
144 <hr/>
145</div>
146 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
147 <div itemprop="articleBody">
148
149 <span class="target" id="module-eventmq.utils.classes"></span><div class="section" id="classes-utility-classes">
150<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>
151<p>Defines some classes to use when implementing ZMQ devices</p>
152<dl class="class">
153<dt id="eventmq.utils.classes.ZMQReceiveMixin">
154<em class="property">class </em><code class="descclassname">eventmq.utils.classes.</code><code class="descname">ZMQReceiveMixin</code><a class="headerlink" href="#eventmq.utils.classes.ZMQReceiveMixin" title="Permalink to this definition">¶</a></dt>
155<dd><p>Defines some methods for receiving messages. This class will not work if
156used on it&#8217;s own</p>
157<dl class="attribute">
158<dt id="eventmq.utils.classes.ZMQReceiveMixin.__weakref__">
159<code class="descname">__weakref__</code><a class="headerlink" href="#eventmq.utils.classes.ZMQReceiveMixin.__weakref__" title="Permalink to this definition">¶</a></dt>
160<dd><p>list of weak references to the object (if defined)</p>
161</dd></dl>
162
163<dl class="method">
164<dt id="eventmq.utils.classes.ZMQReceiveMixin.recv">
165<code class="descname">recv</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.ZMQReceiveMixin.recv" title="Permalink to this definition">¶</a></dt>
166<dd><p>Receive a message</p>
167</dd></dl>
168
169<dl class="method">
170<dt id="eventmq.utils.classes.ZMQReceiveMixin.recv_multipart">
171<code class="descname">recv_multipart</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.ZMQReceiveMixin.recv_multipart" title="Permalink to this definition">¶</a></dt>
172<dd><p>Receive a multipart message</p>
173</dd></dl>
174
175</dd></dl>
176
177<dl class="class">
178<dt id="eventmq.utils.classes.ZMQSendMixin">
179<em class="property">class </em><code class="descclassname">eventmq.utils.classes.</code><code class="descname">ZMQSendMixin</code><a class="headerlink" href="#eventmq.utils.classes.ZMQSendMixin" title="Permalink to this definition">¶</a></dt>
180<dd><p>Defines some methods for sending messages. This class will not work if used
181on it&#8217;s own</p>
182<dl class="attribute">
183<dt id="eventmq.utils.classes.ZMQSendMixin.__weakref__">
184<code class="descname">__weakref__</code><a class="headerlink" href="#eventmq.utils.classes.ZMQSendMixin.__weakref__" title="Permalink to this definition">¶</a></dt>
185<dd><p>list of weak references to the object (if defined)</p>
186</dd></dl>
187
188<dl class="method">
189<dt id="eventmq.utils.classes.ZMQSendMixin.send">
190<code class="descname">send</code><span class="sig-paren">(</span><em>message</em>, <em>protocol_version</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.ZMQSendMixin.send" title="Permalink to this definition">¶</a></dt>
191<dd><p>Sends a message</p>
192<table class="docutils field-list" frame="void" rules="none">
193<col class="field-name" />
194<col class="field-body" />
195<tbody valign="top">
196<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
197<li><strong>message</strong> &#8211; message to send to something</li>
198<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
199you may explicitly specify None to skip adding the version</li>
200</ul>
201</td>
202</tr>
203</tbody>
204</table>
205</dd></dl>
206
207<dl class="method">
208<dt id="eventmq.utils.classes.ZMQSendMixin.send_multipart">
209<code class="descname">send_multipart</code><span class="sig-paren">(</span><em>message</em>, <em>protocol_version</em>, <em>_recipient_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.ZMQSendMixin.send_multipart" title="Permalink to this definition">¶</a></dt>
210<dd><p>Send a message directly to the 0mq socket. Automatically inserts some
211frames for your convience. The sent frame ends up looking something
212like identity</p>
213<blockquote>
214<div>(this, &#8216;&#8217;, protocol_version) + (your, tuple)</div></blockquote>
215<table class="docutils field-list" frame="void" rules="none">
216<col class="field-name" />
217<col class="field-body" />
218<tbody valign="top">
219<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
220<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>
221<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
222you may explicitly specify None to skip adding the version</li>
223<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
224specify the the recipient id of the</li>
225</ul>
226</td>
227</tr>
228</tbody>
229</table>
230</dd></dl>
231
232</dd></dl>
233
234</div>
235
236
237 </div>
238 </div>
239 <footer>
240
241 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
242
243 <a href="messages.html" class="btn btn-neutral float-right" title="utils.messages – Message Utilities" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
244
245
246 <a href="../utils.html" class="btn btn-neutral" title="utils – Utilities" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
247
248 </div>
249
250
251 <hr/>
252
253 <div role="contentinfo">
254 <p>
255 &copy; Copyright 2015, eventboard.io.
256
257 </p>
258 </div>
259 Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
260
261</footer>
262
263 </div>
264 </div>
265
266 </section>
267
268 </div>
269
270
271
272
273
274 <script type="text/javascript">
275 var DOCUMENTATION_OPTIONS = {
276 URL_ROOT:'../',
277 VERSION:'0',
278 COLLAPSE_INDEX:false,
279 FILE_SUFFIX:'.html',
280 HAS_SOURCE: true
281 };
282 </script>
283 <script type="text/javascript" src="../_static/jquery.js"></script>
284 <script type="text/javascript" src="../_static/underscore.js"></script>
285 <script type="text/javascript" src="../_static/doctools.js"></script>
286
287
288
289
290
291 <script type="text/javascript" src="../_static/js/theme.js"></script>
292
293
294
295
296 <script type="text/javascript">
297 jQuery(function () {
298 SphinxRtdTheme.StickyNav.enable();
299 });
300 </script>
301
302
303</body>
304</html> \ No newline at end of file
generated by cgit v1.2.1 (git 2.18.0) at 2026-01-16 13:19:01 +0000