aboutsummaryrefslogtreecommitdiffstats
path: root/jobmanager.html
diff options
context:
space:
mode:
Diffstat (limited to 'jobmanager.html')
-rw-r--r--jobmanager.html59
1 files changed, 53 insertions, 6 deletions
diff --git a/jobmanager.html b/jobmanager.html
index 1553d9e..2c81041 100644
--- a/jobmanager.html
+++ b/jobmanager.html
@@ -183,6 +183,14 @@ this point the manager should wait for a slot to free up.</p>
183number changes as workers become busy with jobs</p> 183number changes as workers become busy with jobs</p>
184</dd></dl> 184</dd></dl>
185 185
186<dl class="attribute">
187<dt id="eventmq.jobmanager.JobManager.incoming">
188<code class="descname">incoming</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.jobmanager.JobManager.incoming" title="Permalink to this definition">¶</a></dt>
189<dd><p>JobManager starts out by INFORMing the router of it&#8217;s existance,
190then telling the router that it is READY. The reply will be the unit
191of work.</p>
192</dd></dl>
193
186<dl class="method"> 194<dl class="method">
187<dt id="eventmq.jobmanager.JobManager.jobmanager_main"> 195<dt id="eventmq.jobmanager.JobManager.jobmanager_main">
188<code class="descname">jobmanager_main</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.jobmanager_main" title="Permalink to this definition">¶</a></dt> 196<code class="descname">jobmanager_main</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.jobmanager_main" title="Permalink to this definition">¶</a></dt>
@@ -197,6 +205,12 @@ referring to the logs.</p>
197</dd></dl> 205</dd></dl>
198 206
199<dl class="method"> 207<dl class="method">
208<dt id="eventmq.jobmanager.JobManager.on_ack">
209<code class="descname">on_ack</code><span class="sig-paren">(</span><em>msgid</em>, <em>ackd_msgid</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.on_ack" title="Permalink to this definition">¶</a></dt>
210<dd><p>Sets <code class="xref py py-attr docutils literal"><span class="pre">awaiting_ack</span></code> to False</p>
211</dd></dl>
212
213<dl class="method">
200<dt id="eventmq.jobmanager.JobManager.on_heartbeat"> 214<dt id="eventmq.jobmanager.JobManager.on_heartbeat">
201<code class="descname">on_heartbeat</code><span class="sig-paren">(</span><em>msgid</em>, <em>message</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.on_heartbeat" title="Permalink to this definition">¶</a></dt> 215<code class="descname">on_heartbeat</code><span class="sig-paren">(</span><em>msgid</em>, <em>message</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.on_heartbeat" title="Permalink to this definition">¶</a></dt>
202<dd><p>a placeholder for a noop command. The actual &#8216;logic&#8217; for HEARTBEAT is 216<dd><p>a placeholder for a noop command. The actual &#8216;logic&#8217; for HEARTBEAT is
@@ -236,12 +250,31 @@ HEARTBEAT</p>
236</dl> 250</dl>
237</dd></dl> 251</dd></dl>
238 252
239<dl class="attribute"> 253<dl class="method">
240<dt id="eventmq.jobmanager.JobManager.outgoing"> 254<dt id="eventmq.jobmanager.JobManager.process_message">
241<code class="descname">outgoing</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.jobmanager.JobManager.outgoing" title="Permalink to this definition">¶</a></dt> 255<code class="descname">process_message</code><span class="sig-paren">(</span><em>msg</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.process_message" title="Permalink to this definition">¶</a></dt>
242<dd><p>JobManager starts out by INFORMing the router of it&#8217;s existance, 256<dd><p>Processes a message</p>
243then telling the router that it is READY. The reply will be the unit 257<table class="docutils field-list" frame="void" rules="none">
244of work.</p> 258<col class="field-name" />
259<col class="field-body" />
260<tbody valign="top">
261<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>msg</strong> &#8211; The message received from the socket to parse and process.
262Processing takes form of calling an <cite>on_COMMAND</cite> method.</td>
263</tr>
264</tbody>
265</table>
266</dd></dl>
267
268<dl class="method">
269<dt id="eventmq.jobmanager.JobManager.reset">
270<code class="descname">reset</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.reset" title="Permalink to this definition">¶</a></dt>
271<dd><p>Resets the current connection by closing and reopening the socket</p>
272</dd></dl>
273
274<dl class="method">
275<dt id="eventmq.jobmanager.JobManager.send_inform">
276<code class="descname">send_inform</code><span class="sig-paren">(</span><em>queue=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.send_inform" title="Permalink to this definition">¶</a></dt>
277<dd><p>Send an INFORM command</p>
245</dd></dl> 278</dd></dl>
246 279
247<dl class="method"> 280<dl class="method">
@@ -251,6 +284,20 @@ of work.</p>
251for another REQUEST message.</p> 284for another REQUEST message.</p>
252</dd></dl> 285</dd></dl>
253 286
287<dl class="method">
288<dt id="eventmq.jobmanager.JobManager.start">
289<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>
290<dd><p>Connect to <cite>addr</cite> and begin listening for job requests</p>
291<table class="docutils field-list" frame="void" rules="none">
292<col class="field-name" />
293<col class="field-body" />
294<tbody valign="top">
295<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; connection string to connect to</td>
296</tr>
297</tbody>
298</table>
299</dd></dl>
300
254</dd></dl> 301</dd></dl>
255 302
256</div> 303</div>