diff options
Diffstat (limited to 'jobmanager.html')
| -rw-r--r-- | jobmanager.html | 74 |
1 files changed, 32 insertions, 42 deletions
diff --git a/jobmanager.html b/jobmanager.html index 638acd6..1553d9e 100644 --- a/jobmanager.html +++ b/jobmanager.html | |||
| @@ -84,6 +84,7 @@ | |||
| 84 | 84 | ||
| 85 | <ul class="current"> | 85 | <ul class="current"> |
| 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="reference internal" href="api.html">API Documentation</a><ul class="current"> |
| 87 | <li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> – Client Utilities</a></li> | ||
| 87 | <li class="toctree-l2"><a class="reference internal" href="exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> – Exceptions</a></li> | 88 | <li class="toctree-l2"><a class="reference internal" href="exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> – Exceptions</a></li> |
| 88 | <li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">jobmanager</span></code> – Job Manager</a></li> | 89 | <li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">jobmanager</span></code> – 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> – Poller</a></li> | 90 | <li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> – Poller</a></li> |
| @@ -167,10 +168,32 @@ generated.</td> | |||
| 167 | </table> | 168 | </table> |
| 168 | </dd></dl> | 169 | </dd></dl> |
| 169 | 170 | ||
| 171 | <dl class="attribute"> | ||
| 172 | <dt id="eventmq.jobmanager.JobManager.active_jobs"> | ||
| 173 | <code class="descname">active_jobs</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.jobmanager.JobManager.active_jobs" title="Permalink to this definition">¶</a></dt> | ||
| 174 | <dd><p>Jobs that are running should be stored in <cite>active_jobs</cite>. There | ||
| 175 | should always be at most <cite>available_workers</cite> count of active jobs. | ||
| 176 | this point the manager should wait for a slot to free up.</p> | ||
| 177 | </dd></dl> | ||
| 178 | |||
| 179 | <dl class="attribute"> | ||
| 180 | <dt id="eventmq.jobmanager.JobManager.available_workers"> | ||
| 181 | <code class="descname">available_workers</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.jobmanager.JobManager.available_workers" title="Permalink to this definition">¶</a></dt> | ||
| 182 | <dd><p>Number of workers that are available to have a job executed. This | ||
| 183 | number changes as workers become busy with jobs</p> | ||
| 184 | </dd></dl> | ||
| 185 | |||
| 170 | <dl class="method"> | 186 | <dl class="method"> |
| 171 | <dt id="eventmq.jobmanager.JobManager.on_ack"> | 187 | <dt id="eventmq.jobmanager.JobManager.jobmanager_main"> |
| 172 | <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> | 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> |
| 173 | <dd><p>Sets <code class="xref py py-attr docutils literal"><span class="pre">awaiting_ack</span></code> to False</p> | 189 | <dd><p>Kick off jobmanager with logging and settings import</p> |
| 190 | </dd></dl> | ||
| 191 | |||
| 192 | <dl class="attribute"> | ||
| 193 | <dt id="eventmq.jobmanager.JobManager.name"> | ||
| 194 | <code class="descname">name</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.jobmanager.JobManager.name" title="Permalink to this definition">¶</a></dt> | ||
| 195 | <dd><p>Define the name of this JobManager instance. Useful to know when | ||
| 196 | referring to the logs.</p> | ||
| 174 | </dd></dl> | 197 | </dd></dl> |
| 175 | 198 | ||
| 176 | <dl class="method"> | 199 | <dl class="method"> |
| @@ -213,31 +236,12 @@ HEARTBEAT</p> | |||
| 213 | </dl> | 236 | </dl> |
| 214 | </dd></dl> | 237 | </dd></dl> |
| 215 | 238 | ||
| 216 | <dl class="method"> | 239 | <dl class="attribute"> |
| 217 | <dt id="eventmq.jobmanager.JobManager.process_message"> | 240 | <dt id="eventmq.jobmanager.JobManager.outgoing"> |
| 218 | <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> | 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> |
| 219 | <dd><p>Processes a message</p> | 242 | <dd><p>JobManager starts out by INFORMing the router of it’s existance, |
| 220 | <table class="docutils field-list" frame="void" rules="none"> | 243 | then telling the router that it is READY. The reply will be the unit |
| 221 | <col class="field-name" /> | 244 | of work.</p> |
| 222 | <col class="field-body" /> | ||
| 223 | <tbody valign="top"> | ||
| 224 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>msg</strong> – The message received from the socket to parse and process. | ||
| 225 | Processing takes form of calling an <cite>on_COMMAND</cite> method.</td> | ||
| 226 | </tr> | ||
| 227 | </tbody> | ||
| 228 | </table> | ||
| 229 | </dd></dl> | ||
| 230 | |||
| 231 | <dl class="method"> | ||
| 232 | <dt id="eventmq.jobmanager.JobManager.reset"> | ||
| 233 | <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> | ||
| 234 | <dd><p>Resets the current connection by closing and reopening the socket</p> | ||
| 235 | </dd></dl> | ||
| 236 | |||
| 237 | <dl class="method"> | ||
| 238 | <dt id="eventmq.jobmanager.JobManager.send_inform"> | ||
| 239 | <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> | ||
| 240 | <dd><p>Send an INFORM command</p> | ||
| 241 | </dd></dl> | 245 | </dd></dl> |
| 242 | 246 | ||
| 243 | <dl class="method"> | 247 | <dl class="method"> |
| @@ -247,20 +251,6 @@ Processing takes form of calling an <cite>on_COMMAND</cite> method.</td> | |||
| 247 | for another REQUEST message.</p> | 251 | for another REQUEST message.</p> |
| 248 | </dd></dl> | 252 | </dd></dl> |
| 249 | 253 | ||
| 250 | <dl class="method"> | ||
| 251 | <dt id="eventmq.jobmanager.JobManager.start"> | ||
| 252 | <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> | ||
| 253 | <dd><p>Connect to <cite>addr</cite> and begin listening for job requests</p> | ||
| 254 | <table class="docutils field-list" frame="void" rules="none"> | ||
| 255 | <col class="field-name" /> | ||
| 256 | <col class="field-body" /> | ||
| 257 | <tbody valign="top"> | ||
| 258 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – connection string to connect to</td> | ||
| 259 | </tr> | ||
| 260 | </tbody> | ||
| 261 | </table> | ||
| 262 | </dd></dl> | ||
| 263 | |||
| 264 | </dd></dl> | 254 | </dd></dl> |
| 265 | 255 | ||
| 266 | </div> | 256 | </div> |