aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjason2015-11-19 17:42:59 -0700
committerjason2015-11-19 17:42:59 -0700
commitc972be300c5d182ad2a229cabb3150b365acad6b (patch)
tree7070da3c471ccb055e6c2d529804b89c4c31a09e
parentbf4d466c75c00f3f8d92e0a8973900374f29e901 (diff)
downloadeventmq-c972be300c5d182ad2a229cabb3150b365acad6b.tar.gz
eventmq-c972be300c5d182ad2a229cabb3150b365acad6b.zip
documentation update
Diffstat
-rw-r--r--_sources/api.txt3
-rw-r--r--_sources/exceptions.txt3
-rw-r--r--_sources/utils.txt3
-rw-r--r--api.html4
-rw-r--r--exceptions.html240
-rw-r--r--genindex.html109
-rw-r--r--index.html2
-rw-r--r--jobmanager.html52
-rw-r--r--objects.invbin449 -> 589 bytes
-rw-r--r--py-modindex.html10
-rw-r--r--receiver.html21
-rw-r--r--router.html35
-rw-r--r--searchindex.js2
-rw-r--r--sender.html53
-rw-r--r--utils.html236
15 files changed, 735 insertions, 38 deletions
diff --git a/_sources/api.txt b/_sources/api.txt
index 12ccbb2..b0ecf4e 100644
--- a/_sources/api.txt
+++ b/_sources/api.txt
@@ -9,4 +9,5 @@ API Documentation
9 receiver 9 receiver
10 router 10 router
11 sender 11 sender
12 12 utils
13 exceptions
diff --git a/_sources/exceptions.txt b/_sources/exceptions.txt
new file mode 100644
index 0000000..17a1cf9
--- /dev/null
+++ b/_sources/exceptions.txt
@@ -0,0 +1,3 @@
1.. automodule:: eventmq.exceptions
2 :members:
3 :special-members:
diff --git a/_sources/utils.txt b/_sources/utils.txt
new file mode 100644
index 0000000..02904ed
--- /dev/null
+++ b/_sources/utils.txt
@@ -0,0 +1,3 @@
1.. automodule:: eventmq.utils
2 :members:
3 :special-members:
diff --git a/api.html b/api.html
index e04493c..78c0f33 100644
--- a/api.html
+++ b/api.html
@@ -87,6 +87,8 @@
87<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> 87<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>
88<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> 88<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>
89<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> 89<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>
90<li class="toctree-l2"><a class="reference internal" href="utils.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li>
91<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>
90</ul> 92</ul>
91</li> 93</li>
92<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li> 94<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li>
@@ -142,6 +144,8 @@
142<li class="toctree-l1"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li> 144<li class="toctree-l1"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li>
143<li class="toctree-l1"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li> 145<li class="toctree-l1"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li>
144<li class="toctree-l1"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li> 146<li class="toctree-l1"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li>
147<li class="toctree-l1"><a class="reference internal" href="utils.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li>
148<li class="toctree-l1"><a class="reference internal" href="exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> &#8211; Exceptions</a></li>
145</ul> 149</ul>
146</div> 150</div>
147</div> 151</div>
diff --git a/exceptions.html b/exceptions.html
new file mode 100644
index 0000000..cd2c165
--- /dev/null
+++ b/exceptions.html
@@ -0,0 +1,240 @@
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>exceptions – Exceptions &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="API Documentation" href="api.html"/>
35 <link rel="next" title="Contributing to EventMQ" href="contributing.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="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li>
88<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>
89<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>
90<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>
91<li class="toctree-l2"><a class="reference internal" href="utils.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li>
92<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">exceptions</span></code> &#8211; Exceptions</a></li>
93</ul>
94</li>
95<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li>
96</ul>
97
98
99
100 </div>
101 </div>
102 </nav>
103
104 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
105
106
107 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
108 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
109 <a href="index.html">EventMQ</a>
110 </nav>
111
112
113
114 <div class="wy-nav-content">
115 <div class="rst-content">
116
117
118
119
120
121
122<div role="navigation" aria-label="breadcrumbs navigation">
123 <ul class="wy-breadcrumbs">
124 <li><a href="index.html">Docs</a> &raquo;</li>
125
126 <li><a href="api.html">API Documentation</a> &raquo;</li>
127
128 <li><code class="docutils literal"><span class="pre">exceptions</span></code> &#8211; Exceptions</li>
129 <li class="wy-breadcrumbs-aside">
130
131
132 <a href="_sources/exceptions.txt" rel="nofollow"> View page source</a>
133
134
135 </li>
136 </ul>
137 <hr/>
138</div>
139 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
140 <div itemprop="articleBody">
141
142 <span class="target" id="module-eventmq.exceptions"></span><div class="section" id="exceptions-exceptions">
143<h1><a class="reference external" href="https://docs.python.org/library/exceptions.html#module-exceptions" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">exceptions</span></code></a> &#8211; Exceptions<a class="headerlink" href="#exceptions-exceptions" title="Permalink to this headline">¶</a></h1>
144<p>These are the exceptions that are raised by EventMQ. All exceptions should
145be subclasses of <a class="reference internal" href="#eventmq.exceptions.EventMQError" title="eventmq.exceptions.EventMQError"><code class="xref py py-class docutils literal"><span class="pre">EventMQError</span></code></a></p>
146<dl class="exception">
147<dt id="eventmq.exceptions.EventMQError">
148<em class="property">exception </em><code class="descclassname">eventmq.exceptions.</code><code class="descname">EventMQError</code><a class="headerlink" href="#eventmq.exceptions.EventMQError" title="Permalink to this definition">¶</a></dt>
149<dd><p>All exceptions raised by EventMQ inherit from this base exception</p>
150<dl class="attribute">
151<dt id="eventmq.exceptions.EventMQError.__weakref__">
152<code class="descname">__weakref__</code><a class="headerlink" href="#eventmq.exceptions.EventMQError.__weakref__" title="Permalink to this definition">¶</a></dt>
153<dd><p>list of weak references to the object (if defined)</p>
154</dd></dl>
155
156</dd></dl>
157
158<dl class="exception">
159<dt id="eventmq.exceptions.InvalidMessageError">
160<em class="property">exception </em><code class="descclassname">eventmq.exceptions.</code><code class="descname">InvalidMessageError</code><a class="headerlink" href="#eventmq.exceptions.InvalidMessageError" title="Permalink to this definition">¶</a></dt>
161<dd><p>Raise when EventMQ encounters a malformed message is encountered.</p>
162</dd></dl>
163
164<dl class="exception">
165<dt id="eventmq.exceptions.MessageError">
166<em class="property">exception </em><code class="descclassname">eventmq.exceptions.</code><code class="descname">MessageError</code><a class="headerlink" href="#eventmq.exceptions.MessageError" title="Permalink to this definition">¶</a></dt>
167<dd><p>Raised when there is a problem with the structure of the message</p>
168</dd></dl>
169
170</div>
171
172
173 </div>
174 </div>
175 <footer>
176
177 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
178
179 <a href="contributing.html" class="btn btn-neutral float-right" title="Contributing to EventMQ" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
180
181
182 <a href="utils.html" class="btn btn-neutral" title="utils – Utilities" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
183
184 </div>
185
186
187 <hr/>
188
189 <div role="contentinfo">
190 <p>
191 &copy; Copyright 2015, eventboard.io.
192
193 </p>
194 </div>
195 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>.
196
197</footer>
198
199 </div>
200 </div>
201
202 </section>
203
204 </div>
205
206
207
208
209
210 <script type="text/javascript">
211 var DOCUMENTATION_OPTIONS = {
212 URL_ROOT:'./',
213 VERSION:'0',
214 COLLAPSE_INDEX:false,
215 FILE_SUFFIX:'.html',
216 HAS_SOURCE: true
217 };
218 </script>
219 <script type="text/javascript" src="_static/jquery.js"></script>
220 <script type="text/javascript" src="_static/underscore.js"></script>
221 <script type="text/javascript" src="_static/doctools.js"></script>
222
223
224
225
226
227 <script type="text/javascript" src="_static/js/theme.js"></script>
228
229
230
231
232 <script type="text/javascript">
233 jQuery(function () {
234 SphinxRtdTheme.StickyNav.enable();
235 });
236 </script>
237
238
239</body>
240</html> \ No newline at end of file
diff --git a/genindex.html b/genindex.html
index 13c01a8..6e742cf 100644
--- a/genindex.html
+++ b/genindex.html
@@ -132,9 +132,14 @@
132 <a href="#_"><strong>_</strong></a> 132 <a href="#_"><strong>_</strong></a>
133 | <a href="#C"><strong>C</strong></a> 133 | <a href="#C"><strong>C</strong></a>
134 | <a href="#E"><strong>E</strong></a> 134 | <a href="#E"><strong>E</strong></a>
135 | <a href="#G"><strong>G</strong></a>
136 | <a href="#I"><strong>I</strong></a>
135 | <a href="#J"><strong>J</strong></a> 137 | <a href="#J"><strong>J</strong></a>
136 | <a href="#L"><strong>L</strong></a> 138 | <a href="#L"><strong>L</strong></a>
139 | <a href="#M"><strong>M</strong></a>
137 | <a href="#N"><strong>N</strong></a> 140 | <a href="#N"><strong>N</strong></a>
141 | <a href="#O"><strong>O</strong></a>
142 | <a href="#P"><strong>P</strong></a>
138 | <a href="#R"><strong>R</strong></a> 143 | <a href="#R"><strong>R</strong></a>
139 | <a href="#S"><strong>S</strong></a> 144 | <a href="#S"><strong>S</strong></a>
140 | <a href="#Z"><strong>Z</strong></a> 145 | <a href="#Z"><strong>Z</strong></a>
@@ -160,11 +165,15 @@
160 </dl></td> 165 </dl></td>
161 <td style="width: 33%" valign="top"><dl> 166 <td style="width: 33%" valign="top"><dl>
162 167
163 <dt><a href="jobmanager.html#eventmq.jobmanager.JobManager.__weakref__">__weakref__ (eventmq.jobmanager.JobManager attribute)</a> 168 <dt><a href="exceptions.html#eventmq.exceptions.EventMQError.__weakref__">__weakref__ (eventmq.exceptions.EventMQError attribute)</a>
164 </dt> 169 </dt>
165 170
166 <dd><dl> 171 <dd><dl>
167 172
173 <dt><a href="jobmanager.html#eventmq.jobmanager.JobManager.__weakref__">(eventmq.jobmanager.JobManager attribute)</a>
174 </dt>
175
176
168 <dt><a href="receiver.html#eventmq.receiver.Receiver.__weakref__">(eventmq.receiver.Receiver attribute)</a> 177 <dt><a href="receiver.html#eventmq.receiver.Receiver.__weakref__">(eventmq.receiver.Receiver attribute)</a>
169 </dt> 178 </dt>
170 179
@@ -200,6 +209,10 @@
200<table style="width: 100%" class="indextable genindextable"><tr> 209<table style="width: 100%" class="indextable genindextable"><tr>
201 <td style="width: 33%" valign="top"><dl> 210 <td style="width: 33%" valign="top"><dl>
202 211
212 <dt><a href="exceptions.html#module-eventmq.exceptions">eventmq.exceptions (module)</a>
213 </dt>
214
215
203 <dt><a href="jobmanager.html#module-eventmq.jobmanager">eventmq.jobmanager (module)</a> 216 <dt><a href="jobmanager.html#module-eventmq.jobmanager">eventmq.jobmanager (module)</a>
204 </dt> 217 </dt>
205 218
@@ -207,16 +220,44 @@
207 <dt><a href="receiver.html#module-eventmq.receiver">eventmq.receiver (module)</a> 220 <dt><a href="receiver.html#module-eventmq.receiver">eventmq.receiver (module)</a>
208 </dt> 221 </dt>
209 222
210 </dl></td>
211 <td style="width: 33%" valign="top"><dl>
212 223
213 <dt><a href="router.html#module-eventmq.router">eventmq.router (module)</a> 224 <dt><a href="router.html#module-eventmq.router">eventmq.router (module)</a>
214 </dt> 225 </dt>
215 226
227 </dl></td>
228 <td style="width: 33%" valign="top"><dl>
216 229
217 <dt><a href="sender.html#module-eventmq.sender">eventmq.sender (module)</a> 230 <dt><a href="sender.html#module-eventmq.sender">eventmq.sender (module)</a>
218 </dt> 231 </dt>
219 232
233
234 <dt><a href="utils.html#module-eventmq.utils">eventmq.utils (module)</a>
235 </dt>
236
237
238 <dt><a href="exceptions.html#eventmq.exceptions.EventMQError">EventMQError</a>
239 </dt>
240
241 </dl></td>
242</tr></table>
243
244<h2 id="G">G</h2>
245<table style="width: 100%" class="indextable genindextable"><tr>
246 <td style="width: 33%" valign="top"><dl>
247
248 <dt><a href="utils.html#eventmq.utils.generate_msgid">generate_msgid() (in module eventmq.utils)</a>
249 </dt>
250
251 </dl></td>
252</tr></table>
253
254<h2 id="I">I</h2>
255<table style="width: 100%" class="indextable genindextable"><tr>
256 <td style="width: 33%" valign="top"><dl>
257
258 <dt><a href="exceptions.html#eventmq.exceptions.InvalidMessageError">InvalidMessageError</a>
259 </dt>
260
220 </dl></td> 261 </dl></td>
221</tr></table> 262</tr></table>
222 263
@@ -246,6 +287,16 @@
246 </dl></td> 287 </dl></td>
247</tr></table> 288</tr></table>
248 289
290<h2 id="M">M</h2>
291<table style="width: 100%" class="indextable genindextable"><tr>
292 <td style="width: 33%" valign="top"><dl>
293
294 <dt><a href="exceptions.html#eventmq.exceptions.MessageError">MessageError</a>
295 </dt>
296
297 </dl></td>
298</tr></table>
299
249<h2 id="N">N</h2> 300<h2 id="N">N</h2>
250<table style="width: 100%" class="indextable genindextable"><tr> 301<table style="width: 100%" class="indextable genindextable"><tr>
251 <td style="width: 33%" valign="top"><dl> 302 <td style="width: 33%" valign="top"><dl>
@@ -262,6 +313,32 @@
262 </dl></td> 313 </dl></td>
263</tr></table> 314</tr></table>
264 315
316<h2 id="O">O</h2>
317<table style="width: 100%" class="indextable genindextable"><tr>
318 <td style="width: 33%" valign="top"><dl>
319
320 <dt><a href="router.html#eventmq.router.Router.on_receive_reply">on_receive_reply() (eventmq.router.Router method)</a>
321 </dt>
322
323 </dl></td>
324 <td style="width: 33%" valign="top"><dl>
325
326 <dt><a href="router.html#eventmq.router.Router.on_receive_request">on_receive_request() (eventmq.router.Router method)</a>
327 </dt>
328
329 </dl></td>
330</tr></table>
331
332<h2 id="P">P</h2>
333<table style="width: 100%" class="indextable genindextable"><tr>
334 <td style="width: 33%" valign="top"><dl>
335
336 <dt><a href="utils.html#eventmq.utils.parse_message">parse_message() (in module eventmq.utils)</a>
337 </dt>
338
339 </dl></td>
340</tr></table>
341
265<h2 id="R">R</h2> 342<h2 id="R">R</h2>
266<table style="width: 100%" class="indextable genindextable"><tr> 343<table style="width: 100%" class="indextable genindextable"><tr>
267 <td style="width: 33%" valign="top"><dl> 344 <td style="width: 33%" valign="top"><dl>
@@ -279,9 +356,17 @@
279 <dt><a href="receiver.html#eventmq.receiver.Receiver">Receiver (class in eventmq.receiver)</a> 356 <dt><a href="receiver.html#eventmq.receiver.Receiver">Receiver (class in eventmq.receiver)</a>
280 </dt> 357 </dt>
281 358
359
360 <dt><a href="sender.html#eventmq.sender.Sender.recv">recv() (eventmq.sender.Sender method)</a>
361 </dt>
362
282 </dl></td> 363 </dl></td>
283 <td style="width: 33%" valign="top"><dl> 364 <td style="width: 33%" valign="top"><dl>
284 365
366 <dt><a href="sender.html#eventmq.sender.Sender.recv_multipart">recv_multipart() (eventmq.sender.Sender method)</a>
367 </dt>
368
369
285 <dt><a href="router.html#eventmq.router.Router">Router (class in eventmq.router)</a> 370 <dt><a href="router.html#eventmq.router.Router">Router (class in eventmq.router)</a>
286 </dt> 371 </dt>
287 372
@@ -296,19 +381,33 @@
296 </dt> 381 </dt>
297 382
298 383
299 <dt><a href="sender.html#eventmq.sender.Sender.send_raw">send_raw() (eventmq.sender.Sender method)</a> 384 <dt><a href="jobmanager.html#eventmq.jobmanager.JobManager.send_inform">send_inform() (eventmq.jobmanager.JobManager method)</a>
385 </dt>
386
387
388 <dt><a href="jobmanager.html#eventmq.jobmanager.JobManager.send_message">send_message() (eventmq.jobmanager.JobManager method)</a>
300 </dt> 389 </dt>
301 390
302 </dl></td> 391 </dl></td>
303 <td style="width: 33%" valign="top"><dl> 392 <td style="width: 33%" valign="top"><dl>
304 393
394 <dt><a href="sender.html#eventmq.sender.Sender.send_multipart">send_multipart() (eventmq.sender.Sender method)</a>
395 </dt>
396
397
305 <dt><a href="sender.html#eventmq.sender.Sender">Sender (class in eventmq.sender)</a> 398 <dt><a href="sender.html#eventmq.sender.Sender">Sender (class in eventmq.sender)</a>
306 </dt> 399 </dt>
307 400
308 401
309 <dt><a href="router.html#eventmq.router.Router.start">start() (eventmq.router.Router method)</a> 402 <dt><a href="jobmanager.html#eventmq.jobmanager.JobManager.start">start() (eventmq.jobmanager.JobManager method)</a>
310 </dt> 403 </dt>
311 404
405 <dd><dl>
406
407 <dt><a href="router.html#eventmq.router.Router.start">(eventmq.router.Router method)</a>
408 </dt>
409
410 </dl></dd>
312 </dl></td> 411 </dl></td>
313</tr></table> 412</tr></table>
314 413
diff --git a/index.html b/index.html
index 2e2f22c..d91081e 100644
--- a/index.html
+++ b/index.html
@@ -136,6 +136,8 @@
136<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> 136<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>
137<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> 137<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>
138<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> 138<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>
139<li class="toctree-l2"><a class="reference internal" href="utils.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li>
140<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>
139</ul> 141</ul>
140</li> 142</li>
141<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a><ul> 143<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a><ul>
diff --git a/jobmanager.html b/jobmanager.html
index 745c825..0b7e831 100644
--- a/jobmanager.html
+++ b/jobmanager.html
@@ -31,8 +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="API Documentation" href="api.html"/>
34 <link rel="next" title="receiver – Receiver" href="receiver.html"/> 35 <link rel="next" title="receiver – Receiver" href="receiver.html"/>
35 <link rel="prev" title="Welcome to EventMQ’s documentation!" href="index.html"/> 36 <link rel="prev" title="API Documentation" href="api.html"/>
36 37
37 38
38 <script src="_static/js/modernizr.min.js"></script> 39 <script src="_static/js/modernizr.min.js"></script>
@@ -82,10 +83,15 @@
82 83
83 84
84 <ul class="current"> 85 <ul class="current">
85<li class="toctree-l1 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li> 86<li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current">
86<li class="toctree-l1"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li> 87<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li>
87<li class="toctree-l1"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li> 88<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>
88<li class="toctree-l1"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li> 89<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>
90<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>
91<li class="toctree-l2"><a class="reference internal" href="utils.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li>
92</ul>
93</li>
94<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li>
89</ul> 95</ul>
90 96
91 97
@@ -116,6 +122,8 @@
116 <ul class="wy-breadcrumbs"> 122 <ul class="wy-breadcrumbs">
117 <li><a href="index.html">Docs</a> &raquo;</li> 123 <li><a href="index.html">Docs</a> &raquo;</li>
118 124
125 <li><a href="api.html">API Documentation</a> &raquo;</li>
126
119 <li><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</li> 127 <li><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</li>
120 <li class="wy-breadcrumbs-aside"> 128 <li class="wy-breadcrumbs-aside">
121 129
@@ -132,8 +140,7 @@
132 140
133 <span class="target" id="module-eventmq.jobmanager"></span><div class="section" id="jobmanager-job-manager"> 141 <span class="target" id="module-eventmq.jobmanager"></span><div class="section" id="jobmanager-job-manager">
134<h1><code class="xref py py-mod docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager<a class="headerlink" href="#jobmanager-job-manager" title="Permalink to this headline">¶</a></h1> 142<h1><code class="xref py py-mod docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager<a class="headerlink" href="#jobmanager-job-manager" title="Permalink to this headline">¶</a></h1>
135<p>Ensures things about jobs 143<p>Ensures things about jobs and spawns the actual tasks</p>
136Spawns and manages workers</p>
137<dl class="class"> 144<dl class="class">
138<dt id="eventmq.jobmanager.JobManager"> 145<dt id="eventmq.jobmanager.JobManager">
139<em class="property">class </em><code class="descclassname">eventmq.jobmanager.</code><code class="descname">JobManager</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager" title="Permalink to this definition">¶</a></dt> 146<em class="property">class </em><code class="descclassname">eventmq.jobmanager.</code><code class="descname">JobManager</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager" title="Permalink to this definition">¶</a></dt>
@@ -164,6 +171,35 @@ generated.</td>
164<dd><p>list of weak references to the object (if defined)</p> 171<dd><p>list of weak references to the object (if defined)</p>
165</dd></dl> 172</dd></dl>
166 173
174<dl class="method">
175<dt id="eventmq.jobmanager.JobManager.send_inform">
176<code class="descname">send_inform</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.send_inform" title="Permalink to this definition">¶</a></dt>
177<dd><p>Send an INFORM frame</p>
178</dd></dl>
179
180<dl class="method">
181<dt id="eventmq.jobmanager.JobManager.send_message">
182<code class="descname">send_message</code><span class="sig-paren">(</span><em>command</em>, <em>message</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.send_message" title="Permalink to this definition">¶</a></dt>
183<dd><p>send a message to <cite>self.incoming</cite>
184:param message: a msg tuple to send</p>
185<p>Raises:</p>
186<p>Returns</p>
187</dd></dl>
188
189<dl class="method">
190<dt id="eventmq.jobmanager.JobManager.start">
191<code class="descname">start</code><span class="sig-paren">(</span><em>addr='tcp://127.0.0.1:47291'</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.start" title="Permalink to this definition">¶</a></dt>
192<dd><p>Begin listening for job requests</p>
193<table class="docutils field-list" frame="void" rules="none">
194<col class="field-name" />
195<col class="field-body" />
196<tbody valign="top">
197<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>args</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>
198</tr>
199</tbody>
200</table>
201</dd></dl>
202
167</dd></dl> 203</dd></dl>
168 204
169</div> 205</div>
@@ -178,7 +214,7 @@ generated.</td>
178 <a href="receiver.html" class="btn btn-neutral float-right" title="receiver – Receiver" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> 214 <a href="receiver.html" class="btn btn-neutral float-right" title="receiver – Receiver" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
179 215
180 216
181 <a href="index.html" class="btn btn-neutral" title="Welcome to EventMQ’s documentation!" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> 217 <a href="api.html" class="btn btn-neutral" title="API Documentation" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
182 218
183 </div> 219 </div>
184 220
diff --git a/objects.inv b/objects.inv
index a13b23e..17ca09c 100644
--- a/objects.inv
+++ b/objects.inv
Binary files differ
diff --git a/py-modindex.html b/py-modindex.html
index f6bdf6c..3442ec3 100644
--- a/py-modindex.html
+++ b/py-modindex.html
@@ -147,6 +147,11 @@
147 <tr class="cg-1"> 147 <tr class="cg-1">
148 <td></td> 148 <td></td>
149 <td>&nbsp;&nbsp;&nbsp; 149 <td>&nbsp;&nbsp;&nbsp;
150 <a href="exceptions.html#module-eventmq.exceptions"><code class="xref">eventmq.exceptions</code></a></td><td>
151 <em></em></td></tr>
152 <tr class="cg-1">
153 <td></td>
154 <td>&nbsp;&nbsp;&nbsp;
150 <a href="jobmanager.html#module-eventmq.jobmanager"><code class="xref">eventmq.jobmanager</code></a></td><td> 155 <a href="jobmanager.html#module-eventmq.jobmanager"><code class="xref">eventmq.jobmanager</code></a></td><td>
151 <em></em></td></tr> 156 <em></em></td></tr>
152 <tr class="cg-1"> 157 <tr class="cg-1">
@@ -164,6 +169,11 @@
164 <td>&nbsp;&nbsp;&nbsp; 169 <td>&nbsp;&nbsp;&nbsp;
165 <a href="sender.html#module-eventmq.sender"><code class="xref">eventmq.sender</code></a></td><td> 170 <a href="sender.html#module-eventmq.sender"><code class="xref">eventmq.sender</code></a></td><td>
166 <em></em></td></tr> 171 <em></em></td></tr>
172 <tr class="cg-1">
173 <td></td>
174 <td>&nbsp;&nbsp;&nbsp;
175 <a href="utils.html#module-eventmq.utils"><code class="xref">eventmq.utils</code></a></td><td>
176 <em></em></td></tr>
167 </table> 177 </table>
168 178
169 179
diff --git a/receiver.html b/receiver.html
index 2147864..038c890 100644
--- a/receiver.html
+++ b/receiver.html
@@ -31,6 +31,7 @@
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="API Documentation" href="api.html"/>
34 <link rel="next" title="router – Router" href="router.html"/> 35 <link rel="next" title="router – Router" href="router.html"/>
35 <link rel="prev" title="jobmanager – Job Manager" href="jobmanager.html"/> 36 <link rel="prev" title="jobmanager – Job Manager" href="jobmanager.html"/>
36 37
@@ -82,10 +83,14 @@
82 83
83 84
84 <ul class="current"> 85 <ul class="current">
85<li class="toctree-l1"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li> 86<li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current">
86<li class="toctree-l1 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li> 87<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>
87<li class="toctree-l1"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li> 88<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li>
88<li class="toctree-l1"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li> 89<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>
90<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>
91</ul>
92</li>
93<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li>
89</ul> 94</ul>
90 95
91 96
@@ -116,6 +121,8 @@
116 <ul class="wy-breadcrumbs"> 121 <ul class="wy-breadcrumbs">
117 <li><a href="index.html">Docs</a> &raquo;</li> 122 <li><a href="index.html">Docs</a> &raquo;</li>
118 123
124 <li><a href="api.html">API Documentation</a> &raquo;</li>
125
119 <li><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</li> 126 <li><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</li>
120 <li class="wy-breadcrumbs-aside"> 127 <li class="wy-breadcrumbs-aside">
121 128
@@ -136,7 +143,7 @@
136<dl class="class"> 143<dl class="class">
137<dt id="eventmq.receiver.Receiver"> 144<dt id="eventmq.receiver.Receiver">
138<em class="property">class </em><code class="descclassname">eventmq.receiver.</code><code class="descname">Receiver</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.receiver.Receiver" title="Permalink to this definition">¶</a></dt> 145<em class="property">class </em><code class="descclassname">eventmq.receiver.</code><code class="descname">Receiver</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.receiver.Receiver" title="Permalink to this definition">¶</a></dt>
139<dd><p>Receives messages and pass them to a callable.</p> 146<dd><p>Receives messages and pass them to a on_recv.</p>
140<div class="admonition note"> 147<div class="admonition note">
141<p class="first admonition-title">Note</p> 148<p class="first admonition-title">Note</p>
142<p class="last">Polling with this reciever is currently only available via an eventloop 149<p class="last">Polling with this reciever is currently only available via an eventloop
@@ -173,8 +180,6 @@
173<col class="field-body" /> 180<col class="field-body" />
174<tbody valign="top"> 181<tbody valign="top">
175<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 182<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
176<li><strong>callable</strong> &#8211; REQUIRED A function or method to call when a message is
177received</li>
178<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; name of this socket. By default a uuid will be 183<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; name of this socket. By default a uuid will be
179generated</li> 184generated</li>
180<li><strong>context</strong> (<a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Context" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Context</span></code></a>) &#8211; Context to use when buliding the 185<li><strong>context</strong> (<a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Context" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Context</span></code></a>) &#8211; Context to use when buliding the
@@ -183,6 +188,8 @@ socket</li>
183<code class="xref py py-attr docutils literal"><span class="pre">zmq.ROUTER</span></code>. By default a <cite>ROUTER</cite> is used</li> 188<code class="xref py py-attr docutils literal"><span class="pre">zmq.ROUTER</span></code>. By default a <cite>ROUTER</cite> is used</li>
184<li><strong>skip_zmqstream</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) &#8211; If set to true, skip creating the zmqstream 189<li><strong>skip_zmqstream</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) &#8211; If set to true, skip creating the zmqstream
185socket. Callable is unused and optional when this is True</li> 190socket. Callable is unused and optional when this is True</li>
191<li><strong>on_recv</strong> &#8211; REQUIRED for zmqstream mode. A function or method to call
192when a message is received</li>
186</ul> 193</ul>
187</td> 194</td>
188</tr> 195</tr>
diff --git a/router.html b/router.html
index f9bec5f..d8c7fe1 100644
--- a/router.html
+++ b/router.html
@@ -31,6 +31,7 @@
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="API Documentation" href="api.html"/>
34 <link rel="next" title="sender – Sender" href="sender.html"/> 35 <link rel="next" title="sender – Sender" href="sender.html"/>
35 <link rel="prev" title="receiver – Receiver" href="receiver.html"/> 36 <link rel="prev" title="receiver – Receiver" href="receiver.html"/>
36 37
@@ -82,10 +83,14 @@
82 83
83 84
84 <ul class="current"> 85 <ul class="current">
85<li class="toctree-l1"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li> 86<li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current">
86<li class="toctree-l1"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li> 87<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>
87<li class="toctree-l1 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li> 88<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li>
88<li class="toctree-l1"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li> 89<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>
90<li class="toctree-l2"><a class="reference internal" href="utils.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li>
91</ul>
92</li>
93<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li>
89</ul> 94</ul>
90 95
91 96
@@ -116,6 +121,8 @@
116 <ul class="wy-breadcrumbs"> 121 <ul class="wy-breadcrumbs">
117 <li><a href="index.html">Docs</a> &raquo;</li> 122 <li><a href="index.html">Docs</a> &raquo;</li>
118 123
124 <li><a href="api.html">API Documentation</a> &raquo;</li>
125
119 <li><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</li> 126 <li><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</li>
120 <li class="wy-breadcrumbs-aside"> 127 <li class="wy-breadcrumbs-aside">
121 128
@@ -145,6 +152,22 @@
145</dd></dl> 152</dd></dl>
146 153
147<dl class="method"> 154<dl class="method">
155<dt id="eventmq.router.Router.on_receive_reply">
156<code class="descname">on_receive_reply</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.on_receive_reply" title="Permalink to this definition">¶</a></dt>
157<dd><p>This method is called when a message comes in from the worker socket.
158It then calls <cite>on_command</cite>. If <cite>on_command</cite> isn&#8217;t found, then a warning
159is created.</p>
160</dd></dl>
161
162<dl class="method">
163<dt id="eventmq.router.Router.on_receive_request">
164<code class="descname">on_receive_request</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.on_receive_request" title="Permalink to this definition">¶</a></dt>
165<dd><p>This function is called when a message comes in from the client socket.
166It then calls <cite>on_command</cite>. If <cite>on_command</cite> isn&#8217;t found, then a
167warning is created.</p>
168</dd></dl>
169
170<dl class="method">
148<dt id="eventmq.router.Router.start"> 171<dt id="eventmq.router.Router.start">
149<code class="descname">start</code><span class="sig-paren">(</span><em>frontend_addr='tcp://127.0.0.1:47290'</em>, <em>backend_addr='tcp://127.0.0.1:47291'</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.start" title="Permalink to this definition">¶</a></dt> 172<code class="descname">start</code><span class="sig-paren">(</span><em>frontend_addr='tcp://127.0.0.1:47290'</em>, <em>backend_addr='tcp://127.0.0.1:47291'</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.router.Router.start" title="Permalink to this definition">¶</a></dt>
150<dd><p>Begin listening for connections on the provided connection strings</p> 173<dd><p>Begin listening for connections on the provided connection strings</p>
@@ -153,8 +176,8 @@
153<col class="field-body" /> 176<col class="field-body" />
154<tbody valign="top"> 177<tbody valign="top">
155<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 178<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
156<li><strong>frontend_addr</strong> &#8211; connection string to listen for requests</li> 179<li><strong>frontend_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 listen for requests</li>
157<li><strong>backend_addr</strong> &#8211; connection string to listen for workers</li> 180<li><strong>backend_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 listen for workers</li>
158</ul> 181</ul>
159</td> 182</td>
160</tr> 183</tr>
diff --git a/searchindex.js b/searchindex.js
index 0e649cb..568632a 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
Search.setIndex({envversion:46,filenames:["api","contributing","index","jobmanager","protocol","receiver","router","sender"],objects:{"eventmq.jobmanager":{JobManager:[3,3,1,""]},"eventmq.jobmanager.JobManager":{"__init__":[3,2,1,""],"__weakref__":[3,1,1,""]},"eventmq.receiver":{Receiver:[5,3,1,""]},"eventmq.receiver.Receiver":{"__init__":[5,2,1,""],"__weakref__":[5,1,1,""],connect:[5,2,1,""],listen:[5,2,1,""],name:[5,1,1,""],ready:[5,1,1,""],zcontext:[5,1,1,""],zsocket:[5,1,1,""]},"eventmq.router":{Router:[6,3,1,""]},"eventmq.router.Router":{"__weakref__":[6,1,1,""],start:[6,2,1,""]},"eventmq.sender":{Sender:[7,3,1,""]},"eventmq.sender.Sender":{"__init__":[7,2,1,""],"__weakref__":[7,1,1,""],connect:[7,2,1,""],listen:[7,2,1,""],name:[7,1,1,""],ready:[7,1,1,""],send:[7,2,1,""],send_raw:[7,2,1,""],zsocket:[7,1,1,""]},eventmq:{jobmanager:[3,0,0,"-"],receiver:[5,0,0,"-"],router:[6,0,0,"-"],sender:[7,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","attribute","Python attribute"],"2":["py","method","Python method"],"3":["py","class","Python class"]},objtypes:{"0":"py:module","1":"py:attribute","2":"py:method","3":"py:class"},terms:{"0mq":[4,7],"__init__":[3,5,7],"__weakref__":[3,5,6,7],"_empty_":4,"_headers_":4,"_msg_":4,"_msgid_":4,"_queue_name_":4,"abstract":4,"case":4,"class":[3,5,6,7],"default":[3,5,7],"function":5,"public":4,"return":[5,7],"true":[5,7],"while":4,about:3,accept:4,act:4,addr:[5,7],address:[],after:4,agre:4,all:[3,4,5,7],allow:4,alpha:4,ani:4,api:[],applic:4,architectur:[],arg:[3,5,6,7],avail:[5,7],backend_addr:6,basi:4,befor:4,begin:6,belong:4,below:4,between:4,bool:[5,7],both:4,broker:4,build:7,built:4,bulid:5,call:5,callabl:5,can:4,chang:4,check:[5,7],client:[],command:4,compon:4,connction:[5,7],connect:[4,5,6,7],consist:4,contain:4,content:[],context:[5,7],convers:4,creat:[5,7],csv:4,current:[5,7],dealer:7,debug:4,defin:[3,4,5,6,7],deliv:4,describ:4,descript:4,detail:4,detect:4,determin:4,dialog:4,dictionari:4,directli:7,disconnect:4,distribut:4,either:4,empti:4,emqp:[],ensur:3,even:4,eventloop:[3,5,6,7],except:[4,5,7],execut:4,expos:3,extra:4,fair:4,fals:[5,7],first:4,fit:4,follow:4,format:4,foundat:4,frame:4,free:4,from:4,frontend_addr:6,gener:[3,4,5,7],gnu:4,goal:[],handl:4,header:4,heartbeat:[],heavi:4,here:4,hope:4,html:4,http:4,ident:4,ietf:4,implement:4,impli:4,includ:4,index:2,inform:4,insert:4,instanc:3,interpret:4,interv:4,issu:4,job:[],jobmanag:[],kei:4,kwarg:[3,5,6,7],languag:[],later:4,least:4,leav:4,licens:[],list:[3,5,6,7],listen:[5,6,7],mai:4,main:3,manag:[],manual:4,master:4,merchant:4,messag:[4,5,6,7],method:5,modifi:4,modul:2,more:4,msg:4,multipart:4,must:4,name:[3,4,5,6,7],none:[5,7],note:[3,5,7],object:[3,5,6,7],onli:[5,7],option:[3,4,5,7],org:4,orient:4,origin:4,other:4,otherwis:[3,5,7],page:2,paramet:[3,5,6,7],part:4,particular:[4,7],pass:[4,5],peer:4,pictur:4,poll:[5,7],pool:4,portion:3,prepend:4,pretti:4,process:4,properti:[5,7],protocol:[],provid:6,pub:4,publish:4,purpos:4,queue:[4,6,7],rais:[5,7],raw:7,raw_messag:7,readi:[4,5,7],receiv:[],recent:4,reciev:5,recommend:4,redistribut:4,refer:[3,5,6,7],regular:4,reliabl:4,remov:4,rep:5,repli:4,req:7,request:[4,6],requir:[4,5],resourc:[3,4],respond:4,respons:[3,5,7],restart:4,rfc2119:4,rfc:4,robin:4,round:4,rout:[4,6],router:[],run:3,search:2,see:4,send:[4,7],send_raw:7,sender:[],seper:4,serv:4,server:[3,4],servic:4,set:[4,5,7],shall:4,should:[4,5,7],shown:4,simpl:6,singl:4,skip:[5,7],skip_zmqstream:[5,7],socket:[4,5,7],softwar:4,someth:7,spawn:3,specif:[],specifi:4,start:[5,6,7],statu:4,stop:4,str:[3,5,7],string:[5,6,7],sub:4,subject:4,subset:4,tcp:6,term:4,them:5,thi:[3,4,5,6,7],thing:3,through:4,time:4,tool:4,topic:7,topolog:[],tornado:[3,6],trace:4,tupl:7,type:[4,5,7],typeerror:5,under:4,uniqu:[3,4],unless:[3,5,7],unus:5,upon:4,uuid:[3,5,7],valid:4,valu:4,version:4,via:[5,7],warranti:4,weak:[3,5,6,7],web:4,well:4,when:[4,5,7],where:4,without:4,word:4,worker:[],wrap:[5,7],you:4,your:4,zcontext:[5,7],zeromq:4,zmq:[4,5,7],zmqstream:[5,7],zsocket:[5,7]},titles:["API Documentation","Contributing to EventMQ","EventMQ Documentation","<code class=\"docutils literal\"><span class=\"pre\">jobmanager</span></code> &#8211; Job Manager","EventMQ Protocol Specification","<code class=\"docutils literal\"><span class=\"pre\">receiver</span></code> &#8211; Receiver","<code class=\"docutils literal\"><span class=\"pre\">router</span></code> &#8211; Router","<code class=\"docutils literal\"><span class=\"pre\">sender</span></code> &#8211; Sender"],titleterms:{address:4,api:0,architectur:4,client:4,contribut:1,document:[0,2],emqp:4,eventmq:[1,2,4],goal:4,heartbeat:4,indic:2,job:3,jobmanag:3,languag:4,licens:4,manag:3,protocol:4,receiv:5,router:[4,6],sender:7,specif:4,tabl:2,topolog:4,welcom:[],worker:4}}) \ No newline at end of file Search.setIndex({envversion:46,filenames:["api","contributing","exceptions","index","jobmanager","protocol","receiver","router","sender","utils"],objects:{"eventmq.exceptions":{EventMQError:[2,5,1,""],InvalidMessageError:[2,5,1,""],MessageError:[2,5,1,""]},"eventmq.exceptions.EventMQError":{"__weakref__":[2,1,1,""]},"eventmq.jobmanager":{JobManager:[4,3,1,""]},"eventmq.jobmanager.JobManager":{"__init__":[4,2,1,""],"__weakref__":[4,1,1,""],send_inform:[4,2,1,""],send_message:[4,2,1,""],start:[4,2,1,""]},"eventmq.receiver":{Receiver:[6,3,1,""]},"eventmq.receiver.Receiver":{"__init__":[6,2,1,""],"__weakref__":[6,1,1,""],connect:[6,2,1,""],listen:[6,2,1,""],name:[6,1,1,""],ready:[6,1,1,""],zcontext:[6,1,1,""],zsocket:[6,1,1,""]},"eventmq.router":{Router:[7,3,1,""]},"eventmq.router.Router":{"__weakref__":[7,1,1,""],on_receive_reply:[7,2,1,""],on_receive_request:[7,2,1,""],start:[7,2,1,""]},"eventmq.sender":{Sender:[8,3,1,""]},"eventmq.sender.Sender":{"__init__":[8,2,1,""],"__weakref__":[8,1,1,""],connect:[8,2,1,""],listen:[8,2,1,""],name:[8,1,1,""],ready:[8,1,1,""],recv:[8,2,1,""],recv_multipart:[8,2,1,""],send:[8,2,1,""],send_multipart:[8,2,1,""],zsocket:[8,1,1,""]},"eventmq.utils":{generate_msgid:[9,4,1,""],parse_message:[9,4,1,""]},eventmq:{exceptions:[2,0,0,"-"],jobmanager:[4,0,0,"-"],receiver:[6,0,0,"-"],router:[7,0,0,"-"],sender:[8,0,0,"-"],utils:[9,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","attribute","Python attribute"],"2":["py","method","Python method"],"3":["py","class","Python class"],"4":["py","function","Python function"],"5":["py","exception","Python exception"]},objtypes:{"0":"py:module","1":"py:attribute","2":"py:method","3":"py:class","4":"py:function","5":"py:exception"},terms:{"0mq":[5,8],"__init__":[4,6,8],"__weakref__":[2,4,6,7,8],"_empty_":5,"_headers_":5,"_msg_":5,"_msgid_":5,"_queue_name_":5,"abstract":5,"case":5,"class":[4,6,7,8,9],"default":[4,6,8],"function":[6,7],"public":5,"return":[4,6,8,9],"true":[6,8],"while":5,about:4,accept:5,act:5,actual:4,addr:[4,6,8],address:[],after:5,agre:5,all:[2,4,5,6,8],allow:5,alpha:5,and_data:9,ani:5,api:[],applic:5,architectur:[],arg:[4,6,7,8],automat:8,avail:[6,8],backend_addr:7,base:2,basi:5,befor:5,begin:[4,7],belong:5,below:5,between:5,bool:[6,8],both:5,broker:5,build:8,built:5,bulid:6,call:[6,7],callabl:6,can:5,chang:5,check:[6,8],client:[],come:7,command:[4,5,9],compon:5,connction:[6,8],connect:[4,5,6,7,8],consist:5,contain:[5,9],content:[],context:[6,8],convers:5,convienc:8,creat:[6,7,8,9],csv:5,current:[6,8],deal:9,dealer:8,debug:5,defin:[2,4,5,6,7,8],deliv:5,describ:5,descript:5,detail:5,detect:5,determin:5,dialog:5,dictionari:5,directli:8,disconnect:5,distribut:5,either:5,empti:5,emqp:[],encount:2,end:8,ensur:4,even:5,eventloop:[4,6,7,8],eventmqerror:2,except:[0,5,6,8],execut:5,explicitli:8,expos:4,extra:5,fair:5,fals:[6,8],first:5,fit:5,follow:5,format:[5,9],found:7,foundat:5,frame:[4,5,8],free:5,from:[2,5,7],frontend_addr:7,gener:[4,5,6,8,9],generate_msgid:9,gnu:5,goal:[],good:8,hand:9,handl:5,have:9,header:5,heartbeat:[],heavi:5,here:5,hope:5,html:5,http:5,ident:[5,8],ietf:5,implement:5,impli:5,includ:5,incom:4,index:3,inform:[4,5],inherit:2,insert:[5,8],instanc:4,interpret:5,interv:5,invalidmessageerror:2,isn:7,issu:5,job:[],jobmanag:[],kei:5,kwarg:[4,6,7,8],languag:[],later:5,least:5,leav:5,licens:[],like:[8,9],list:[2,4,6,7,8],listen:[4,6,7,8],look:8,mai:[5,8],main:4,make:9,malform:2,manag:[],manual:5,master:5,merchant:5,messag:[2,4,5,6,7,8,9],message_bodi:9,message_id:9,messageerror:2,method:[6,7],mode:6,modifi:5,modul:[3,9],more:[5,9],msg:[4,5,7],multipart:[5,8],must:5,name:[4,5,6,7,8],none:[6,8],note:[4,6,8],object:[2,4,6,7,8],on_command:7,on_receive_repli:7,on_receive_request:7,on_recv:6,onli:[6,8],option:[4,5,6,8],org:5,orient:5,origin:5,other:5,otherwis:[4,6,8],page:3,param:4,paramet:[4,6,7,8,9],pars:9,parse_messag:9,part:[5,9],particular:[5,8],pass:[5,6],peer:5,pictur:5,poll:[6,8],pool:5,portion:4,practic:8,prepend:5,pretti:5,problem:2,process:5,properti:[6,8],protocol:[],protocol_vers:8,provid:7,pub:5,publish:5,purpos:5,queue:[5,7],rais:[2,4,6,8],raw:8,raw_messag:[],readi:[5,6,8],receiv:[],recent:5,reciev:6,recommend:5,recv:8,recv_multipart:8,redistribut:5,refer:[2,4,6,7,8],regular:5,reliabl:5,remov:5,rep:6,repli:5,req:8,request:[4,5,7],requir:[5,6],resourc:[4,5],respond:5,respons:[4,6,8],restart:5,rfc2119:5,rfc:5,robin:5,round:5,rout:[5,7],router:[],run:4,search:3,see:5,self:4,send:[4,5,8],send_inform:4,send_messag:4,send_multipart:8,send_raw:[],sender:[],sender_id:9,sent:8,seper:5,serv:5,server:[4,5],servic:5,set:[5,6,8],shall:5,should:[2,5,6,8],shown:5,simpl:[7,9],singl:5,skip:[6,8],skip_zmqstream:[6,8],socket:[5,6,7,8],softwar:5,some:8,someth:8,spawn:4,specif:[],specifi:[5,8],start:[4,6,7,8],statu:5,stop:5,str:[4,6,7,8],string:[4,6,7,8],structur:2,sub:5,subclass:2,subject:5,subset:5,task:4,tcp:[4,7],term:5,them:6,thi:[2,4,5,6,7,8,9],thing:[4,9],through:5,time:5,tool:5,topic:[],topolog:[],tornado:[4,7],trace:5,tupl:[4,8,9],type:[5,6,8],typeerror:6,under:5,uniqu:[4,5,9],univers:9,unless:[4,6,8],unus:6,upon:5,uuid:[4,6,8],valid:5,valu:5,version:[5,8],via:[6,8],warn:7,warranti:5,weak:[2,4,6,7,8],web:5,well:5,when:[2,5,6,7,8],where:5,wish:9,without:5,word:5,worker:[],wrap:[6,8],you:[5,8,9],your:[5,8],zcontext:[6,8],zeromq:5,zmq:[5,6,8],zmqstream:[6,8],zsocket:[6,8]},titles:["API Documentation","Contributing to EventMQ","<code class=\"docutils literal\"><span class=\"pre\">exceptions</span></code> &#8211; Exceptions","EventMQ Documentation","<code class=\"docutils literal\"><span class=\"pre\">jobmanager</span></code> &#8211; Job Manager","EventMQ Protocol Specification","<code class=\"docutils literal\"><span class=\"pre\">receiver</span></code> &#8211; Receiver","<code class=\"docutils literal\"><span class=\"pre\">router</span></code> &#8211; Router","<code class=\"docutils literal\"><span class=\"pre\">sender</span></code> &#8211; Sender","<code class=\"docutils literal\"><span class=\"pre\">utils</span></code> &#8211; Utilities"],titleterms:{address:5,api:0,architectur:5,client:5,contribut:1,document:[0,3],emqp:5,eventmq:[1,3,5],except:2,goal:5,heartbeat:5,indic:3,job:4,jobmanag:4,languag:5,licens:5,manag:4,protocol:5,receiv:6,router:[5,7],sender:8,specif:5,tabl:3,topolog:5,util:9,welcom:[],worker:5}}) \ No newline at end of file
diff --git a/sender.html b/sender.html
index 8e7b660..e14c38b 100644
--- a/sender.html
+++ b/sender.html
@@ -31,6 +31,8 @@
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="API Documentation" href="api.html"/>
35 <link rel="next" title="utils – Utilities" href="utils.html"/>
34 <link rel="prev" title="router – Router" href="router.html"/> 36 <link rel="prev" title="router – Router" href="router.html"/>
35 37
36 38
@@ -81,10 +83,15 @@
81 83
82 84
83 <ul class="current"> 85 <ul class="current">
84<li class="toctree-l1"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li> 86<li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current">
85<li class="toctree-l1"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li> 87<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>
86<li class="toctree-l1"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li> 88<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>
87<li class="toctree-l1 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li> 89<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>
90<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</a></li>
91<li class="toctree-l2"><a class="reference internal" href="utils.html"><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li>
92</ul>
93</li>
94<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li>
88</ul> 95</ul>
89 96
90 97
@@ -115,6 +122,8 @@
115 <ul class="wy-breadcrumbs"> 122 <ul class="wy-breadcrumbs">
116 <li><a href="index.html">Docs</a> &raquo;</li> 123 <li><a href="index.html">Docs</a> &raquo;</li>
117 124
125 <li><a href="api.html">API Documentation</a> &raquo;</li>
126
118 <li><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</li> 127 <li><code class="docutils literal"><span class="pre">sender</span></code> &#8211; Sender</li>
119 <li class="wy-breadcrumbs-aside"> 128 <li class="wy-breadcrumbs-aside">
120 129
@@ -243,8 +252,20 @@ False</td>
243</dd></dl> 252</dd></dl>
244 253
245<dl class="method"> 254<dl class="method">
255<dt id="eventmq.sender.Sender.recv">
256<code class="descname">recv</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.sender.Sender.recv" title="Permalink to this definition">¶</a></dt>
257<dd><p>Receive a message</p>
258</dd></dl>
259
260<dl class="method">
261<dt id="eventmq.sender.Sender.recv_multipart">
262<code class="descname">recv_multipart</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.sender.Sender.recv_multipart" title="Permalink to this definition">¶</a></dt>
263<dd><p>Receive a multipart message</p>
264</dd></dl>
265
266<dl class="method">
246<dt id="eventmq.sender.Sender.send"> 267<dt id="eventmq.sender.Sender.send">
247<code class="descname">send</code><span class="sig-paren">(</span><em>message</em>, <em>queue=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.sender.Sender.send" title="Permalink to this definition">¶</a></dt> 268<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.sender.Sender.send" title="Permalink to this definition">¶</a></dt>
248<dd><p>Sends a message</p> 269<dd><p>Sends a message</p>
249<table class="docutils field-list" frame="void" rules="none"> 270<table class="docutils field-list" frame="void" rules="none">
250<col class="field-name" /> 271<col class="field-name" />
@@ -252,7 +273,8 @@ False</td>
252<tbody valign="top"> 273<tbody valign="top">
253<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 274<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
254<li><strong>message</strong> &#8211; message to send to something</li> 275<li><strong>message</strong> &#8211; message to send to something</li>
255<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; queue topic</li> 276<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
277you may explicitly specify None to skip adding the version</li>
256</ul> 278</ul>
257</td> 279</td>
258</tr> 280</tr>
@@ -261,14 +283,23 @@ False</td>
261</dd></dl> 283</dd></dl>
262 284
263<dl class="method"> 285<dl class="method">
264<dt id="eventmq.sender.Sender.send_raw"> 286<dt id="eventmq.sender.Sender.send_multipart">
265<code class="descname">send_raw</code><span class="sig-paren">(</span><em>raw_message</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.sender.Sender.send_raw" title="Permalink to this definition">¶</a></dt> 287<code class="descname">send_multipart</code><span class="sig-paren">(</span><em>message</em>, <em>protocol_version</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.sender.Sender.send_multipart" title="Permalink to this definition">¶</a></dt>
266<dd><p>Send a message directly to the 0mq socket</p> 288<dd><p>Send a message directly to the 0mq socket. Automatically inserts some
289frames for your convience. The sent frame ends up looking something
290like identity</p>
291<blockquote>
292<div>(this, &#8216;&#8217;, protocol_version) + (your, tuple)</div></blockquote>
267<table class="docutils field-list" frame="void" rules="none"> 293<table class="docutils field-list" frame="void" rules="none">
268<col class="field-name" /> 294<col class="field-name" />
269<col class="field-body" /> 295<col class="field-body" />
270<tbody valign="top"> 296<tbody valign="top">
271<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>raw_message</strong> (<em>tuple, list</em>) &#8211; Raw message to send.</td> 297<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
298<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>
299<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
300you may explicitly specify None to skip adding the version</li>
301</ul>
302</td>
272</tr> 303</tr>
273</tbody> 304</tbody>
274</table> 305</table>
@@ -285,6 +316,8 @@ False</td>
285 316
286 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 317 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
287 318
319 <a href="utils.html" class="btn btn-neutral float-right" title="utils – Utilities" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
320
288 321
289 <a href="router.html" class="btn btn-neutral" title="router – Router" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> 322 <a href="router.html" class="btn btn-neutral" title="router – Router" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
290 323
diff --git a/utils.html b/utils.html
new file mode 100644
index 0000000..f115675
--- /dev/null
+++ b/utils.html
@@ -0,0 +1,236 @@
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>utils – Utilities &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="API Documentation" href="api.html"/>
35 <link rel="next" title="&lt;no title&gt;" href="exceptions.html"/>
36 <link rel="prev" title="sender – Sender" href="sender.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="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> &#8211; Job Manager</a></li>
88<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>
89<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>
90<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</a></li>
91</ul>
92</li>
93<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li>
94</ul>
95
96
97
98 </div>
99 </div>
100 </nav>
101
102 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
103
104
105 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
106 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
107 <a href="index.html">EventMQ</a>
108 </nav>
109
110
111
112 <div class="wy-nav-content">
113 <div class="rst-content">
114
115
116
117
118
119
120<div role="navigation" aria-label="breadcrumbs navigation">
121 <ul class="wy-breadcrumbs">
122 <li><a href="index.html">Docs</a> &raquo;</li>
123
124 <li><a href="api.html">API Documentation</a> &raquo;</li>
125
126 <li><code class="docutils literal"><span class="pre">utils</span></code> &#8211; Utilities</li>
127 <li class="wy-breadcrumbs-aside">
128
129
130 <a href="_sources/utils.txt" rel="nofollow"> View page source</a>
131
132
133 </li>
134 </ul>
135 <hr/>
136</div>
137 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
138 <div itemprop="articleBody">
139
140 <span class="target" id="module-eventmq.utils"></span><div class="section" id="utils-utilities">
141<h1><code class="xref py py-mod docutils literal"><span class="pre">utils</span></code> &#8211; Utilities<a class="headerlink" href="#utils-utilities" title="Permalink to this headline">¶</a></h1>
142<p>This module contains a handful of utility classes to make dealing with things
143like creating message more simple.</p>
144<dl class="function">
145<dt id="eventmq.utils.generate_msgid">
146<code class="descclassname">eventmq.utils.</code><code class="descname">generate_msgid</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.generate_msgid" title="Permalink to this definition">¶</a></dt>
147<dd><p>Returns a (universally) unique id to be used for messages</p>
148</dd></dl>
149
150<dl class="function">
151<dt id="eventmq.utils.parse_message">
152<code class="descclassname">eventmq.utils.</code><code class="descname">parse_message</code><span class="sig-paren">(</span><em>message</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.parse_message" title="Permalink to this definition">¶</a></dt>
153<dd><p>Parses the generic format of an eMQP/1.0 message and returns the
154parts.</p>
155<table class="docutils field-list" frame="void" rules="none">
156<col class="field-name" />
157<col class="field-body" />
158<tbody valign="top">
159<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>message</strong> &#8211; the message you wish to have parsed</td>
160</tr>
161</tbody>
162</table>
163<p>Returns (tuple) (sender_id, command, message_id, (message_body, and_data))</p>
164</dd></dl>
165
166</div>
167
168
169 </div>
170 </div>
171 <footer>
172
173 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
174
175 <a href="exceptions.html" class="btn btn-neutral float-right" title="&lt;no title&gt;" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
176
177
178 <a href="sender.html" class="btn btn-neutral" title="sender – Sender" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
179
180 </div>
181
182
183 <hr/>
184
185 <div role="contentinfo">
186 <p>
187 &copy; Copyright 2015, eventboard.io.
188
189 </p>
190 </div>
191 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>.
192
193</footer>
194
195 </div>
196 </div>
197
198 </section>
199
200 </div>
201
202
203
204
205
206 <script type="text/javascript">
207 var DOCUMENTATION_OPTIONS = {
208 URL_ROOT:'./',
209 VERSION:'0',
210 COLLAPSE_INDEX:false,
211 FILE_SUFFIX:'.html',
212 HAS_SOURCE: true
213 };
214 </script>
215 <script type="text/javascript" src="_static/jquery.js"></script>
216 <script type="text/javascript" src="_static/underscore.js"></script>
217 <script type="text/javascript" src="_static/doctools.js"></script>
218
219
220
221
222
223 <script type="text/javascript" src="_static/js/theme.js"></script>
224
225
226
227
228 <script type="text/javascript">
229 jQuery(function () {
230 SphinxRtdTheme.StickyNav.enable();
231 });
232 </script>
233
234
235</body>
236</html> \ No newline at end of file
generated by cgit v1.2.1 (git 2.18.0) at 2026-01-12 03:05:27 +0000