aboutsummaryrefslogtreecommitdiffstats
path: root/jobmanager.html
diff options
context:
space:
mode:
authorjason2017-01-23 20:18:42 -0700
committerjason2017-01-23 20:18:42 -0700
commitf3c64b9a0837dd03584b67179267e1e0ca8edadd (patch)
tree4b282f228902334e13415547f9d3ff8e9889d0d4 /jobmanager.html
parent4780da086a62543c2bfbf0b98cabc181c4420244 (diff)
downloadeventmq-f3c64b9a0837dd03584b67179267e1e0ca8edadd.tar.gz
eventmq-f3c64b9a0837dd03584b67179267e1e0ca8edadd.zip
update docs
Diffstat (limited to 'jobmanager.html')
-rwxr-xr-x[-rw-r--r--]jobmanager.html47
1 files changed, 27 insertions, 20 deletions
diff --git a/jobmanager.html b/jobmanager.html
index 840922d..f5053fc 100644..100755
--- a/jobmanager.html
+++ b/jobmanager.html
@@ -30,6 +30,9 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="genindex.html"/>
35 <link rel="search" title="Search" href="search.html"/>
33 <link rel="top" title="EventMQ 0 documentation" href="index.html"/> 36 <link rel="top" title="EventMQ 0 documentation" href="index.html"/>
34 <link rel="up" title="API Documentation" href="api.html"/> 37 <link rel="up" title="API Documentation" href="api.html"/>
35 <link rel="next" title="poller – Poller" href="poller.html"/> 38 <link rel="next" title="poller – Poller" href="poller.html"/>
@@ -61,7 +64,7 @@
61 64
62 65
63 <div class="version"> 66 <div class="version">
64 0.2.7.1 67 0.3-rc8
65 </div> 68 </div>
66 69
67 70
@@ -87,7 +90,7 @@
87<li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current"> 90<li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current">
88<li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a></li> 91<li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a></li>
89<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> 92<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<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> 93<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>
91<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> 94<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>
92<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> 95<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>
93<li class="toctree-l2"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li> 96<li class="toctree-l2"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> &#8211; Router</a></li>
@@ -118,7 +121,7 @@
118 <div class="rst-content"> 121 <div class="rst-content">
119 122
120 123
121 124
122 125
123 126
124 127
@@ -132,7 +135,7 @@
132 <li class="wy-breadcrumbs-aside"> 135 <li class="wy-breadcrumbs-aside">
133 136
134 137
135 <a href="_sources/jobmanager.txt" rel="nofollow"> View page source</a> 138 <a href="_sources/jobmanager.rst.txt" rel="nofollow"> View page source</a>
136 139
137 140
138 </li> 141 </li>
@@ -163,10 +166,10 @@ to manage the resources on the server it&#8217;s running.</p>
163<col class="field-body" /> 166<col class="field-body" />
164<tbody valign="top"> 167<tbody valign="top">
165<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 168<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
166<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; unique name of this instance. By default a uuid will be 169<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; unique name of this instance. By default a uuid will be
167generated.</li> 170generated.</li>
168<li><strong>queues</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#tuple" title="(in Python v2.7)"><em>tuple</em></a>) &#8211; List of queue names to listen on.</li> 171<li><strong>queues</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#tuple" title="(in Python v2.7)"><em>tuple</em></a>) &#8211; List of queue names to listen on.</li>
169<li><strong>skip_signal</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) &#8211; Don&#8217;t register the signal handlers. Useful for 172<li><strong>skip_signal</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) &#8211; Don&#8217;t register the signal handlers. Useful for
170testing.</li> 173testing.</li>
171</ul> 174</ul>
172</td> 175</td>
@@ -175,6 +178,13 @@ testing.</li>
175</table> 178</table>
176</dd></dl> 179</dd></dl>
177 180
181<dl class="method">
182<dt id="eventmq.jobmanager.JobManager.check_worker_health">
183<code class="descname">check_worker_health</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.check_worker_health" title="Permalink to this definition">¶</a></dt>
184<dd><p>Checks for any dead processes in the pool and recreates them if
185necessary</p>
186</dd></dl>
187
178<dl class="attribute"> 188<dl class="attribute">
179<dt id="eventmq.jobmanager.JobManager.concurrent_jobs"> 189<dt id="eventmq.jobmanager.JobManager.concurrent_jobs">
180<code class="descname">concurrent_jobs</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.jobmanager.JobManager.concurrent_jobs" title="Permalink to this definition">¶</a></dt> 190<code class="descname">concurrent_jobs</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.jobmanager.JobManager.concurrent_jobs" title="Permalink to this definition">¶</a></dt>
@@ -189,7 +199,7 @@ testing.</li>
189<col class="field-name" /> 199<col class="field-name" />
190<col class="field-body" /> 200<col class="field-body" />
191<tbody valign="top"> 201<tbody valign="top">
192<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>broker_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; The address of the broker to connect to.</td> 202<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>broker_addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; The address of the broker to connect to.</td>
193</tr> 203</tr>
194</tbody> 204</tbody>
195</table> 205</table>
@@ -256,6 +266,12 @@ of work.</p>
256<dd><p>List of queues that this job manager is listening on</p> 266<dd><p>List of queues that this job manager is listening on</p>
257</dd></dl> 267</dd></dl>
258 268
269<dl class="attribute">
270<dt id="eventmq.jobmanager.JobManager.request_queue">
271<code class="descname">request_queue</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.jobmanager.JobManager.request_queue" title="Permalink to this definition">¶</a></dt>
272<dd><p>Setup worker queues</p>
273</dd></dl>
274
259<dl class="method"> 275<dl class="method">
260<dt id="eventmq.jobmanager.JobManager.send_ready"> 276<dt id="eventmq.jobmanager.JobManager.send_ready">
261<code class="descname">send_ready</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.send_ready" title="Permalink to this definition">¶</a></dt> 277<code class="descname">send_ready</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.send_ready" title="Permalink to this definition">¶</a></dt>
@@ -265,15 +281,15 @@ for another REQUEST message.</p>
265 281
266<dl class="method"> 282<dl class="method">
267<dt id="eventmq.jobmanager.JobManager.send_reply"> 283<dt id="eventmq.jobmanager.JobManager.send_reply">
268<code class="descname">send_reply</code><span class="sig-paren">(</span><em>res</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.send_reply" title="Permalink to this definition">¶</a></dt> 284<code class="descname">send_reply</code><span class="sig-paren">(</span><em>reply</em>, <em>msgid</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.send_reply" title="Permalink to this definition">¶</a></dt>
269<dd><p>Sends an REPLY response</p> 285<dd><p>Sends an REPLY response</p>
270<table class="docutils field-list" frame="void" rules="none"> 286<table class="docutils field-list" frame="void" rules="none">
271<col class="field-name" /> 287<col class="field-name" />
272<col class="field-body" /> 288<col class="field-body" />
273<tbody valign="top"> 289<tbody valign="top">
274<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 290<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
275<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; The socket to use for this ack</li> 291<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/2/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; The socket to use for this ack</li>
276<li><strong>recipient</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; The recipient id for the ack</li> 292<li><strong>recipient</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; The recipient id for the ack</li>
277<li><strong>msgid</strong> &#8211; The unique id that we are acknowledging</li> 293<li><strong>msgid</strong> &#8211; The unique id that we are acknowledging</li>
278</ul> 294</ul>
279</td> 295</td>
@@ -284,15 +300,6 @@ for another REQUEST message.</p>
284 300
285</dd></dl> 301</dd></dl>
286 302
287<dl class="function">
288<dt id="eventmq.jobmanager.mp_init">
289<code class="descclassname">eventmq.jobmanager.</code><code class="descname">mp_init</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.mp_init" title="Permalink to this definition">¶</a></dt>
290<dd><p>The instance of Context is copied when python multiprocessing fork()s the
291worker processes, so we need to terminate that Context so a new one can be
292rebuilt. Without doing this, messages sent from functions in those child
293processes will never be delivered.</p>
294</dd></dl>
295
296</div> 303</div>
297 304
298 305