diff options
Diffstat (limited to 'jobmanager.html')
| -rw-r--r-- | jobmanager.html | 80 |
1 files changed, 15 insertions, 65 deletions
diff --git a/jobmanager.html b/jobmanager.html index 2c81041..1c040f5 100644 --- a/jobmanager.html +++ b/jobmanager.html | |||
| @@ -149,7 +149,7 @@ | |||
| 149 | <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> | 149 | <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> |
| 150 | <dd><p>The exposed portion of the worker. The job manager’s main responsibility is | 150 | <dd><p>The exposed portion of the worker. The job manager’s main responsibility is |
| 151 | to manage the resources on the server it’s running.</p> | 151 | to manage the resources on the server it’s running.</p> |
| 152 | <p>This job manager uses tornado’s eventloop.</p> | 152 | <p>This job manager uses multiprocessing Queues</p> |
| 153 | <dl class="method"> | 153 | <dl class="method"> |
| 154 | <dt id="eventmq.jobmanager.JobManager.__init__"> | 154 | <dt id="eventmq.jobmanager.JobManager.__init__"> |
| 155 | <code class="descname">__init__</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.__init__" title="Permalink to this definition">¶</a></dt> | 155 | <code class="descname">__init__</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.__init__" title="Permalink to this definition">¶</a></dt> |
| @@ -168,29 +168,6 @@ generated.</td> | |||
| 168 | </table> | 168 | </table> |
| 169 | </dd></dl> | 169 | </dd></dl> |
| 170 | 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 | |||
| 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’s existance, | ||
| 190 | then telling the router that it is READY. The reply will be the unit | ||
| 191 | of work.</p> | ||
| 192 | </dd></dl> | ||
| 193 | |||
| 194 | <dl class="method"> | 171 | <dl class="method"> |
| 195 | <dt id="eventmq.jobmanager.JobManager.jobmanager_main"> | 172 | <dt id="eventmq.jobmanager.JobManager.jobmanager_main"> |
| 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> | 173 | <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> |
| @@ -205,12 +182,6 @@ referring to the logs.</p> | |||
| 205 | </dd></dl> | 182 | </dd></dl> |
| 206 | 183 | ||
| 207 | <dl class="method"> | 184 | <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"> | ||
| 214 | <dt id="eventmq.jobmanager.JobManager.on_heartbeat"> | 185 | <dt id="eventmq.jobmanager.JobManager.on_heartbeat"> |
| 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> | 186 | <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> |
| 216 | <dd><p>a placeholder for a noop command. The actual ‘logic’ for HEARTBEAT is | 187 | <dd><p>a placeholder for a noop command. The actual ‘logic’ for HEARTBEAT is |
| @@ -250,31 +221,18 @@ HEARTBEAT</p> | |||
| 250 | </dl> | 221 | </dl> |
| 251 | </dd></dl> | 222 | </dd></dl> |
| 252 | 223 | ||
| 253 | <dl class="method"> | 224 | <dl class="attribute"> |
| 254 | <dt id="eventmq.jobmanager.JobManager.process_message"> | 225 | <dt id="eventmq.jobmanager.JobManager.outgoing"> |
| 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> | 226 | <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> |
| 256 | <dd><p>Processes a message</p> | 227 | <dd><p>JobManager starts out by INFORMing the router of it’s existence, |
| 257 | <table class="docutils field-list" frame="void" rules="none"> | 228 | then telling the router that it is READY. The reply will be the unit |
| 258 | <col class="field-name" /> | 229 | of work.</p> |
| 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> – The message received from the socket to parse and process. | ||
| 262 | Processing 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> | 230 | </dd></dl> |
| 273 | 231 | ||
| 274 | <dl class="method"> | 232 | <dl class="attribute"> |
| 275 | <dt id="eventmq.jobmanager.JobManager.send_inform"> | 233 | <dt id="eventmq.jobmanager.JobManager.request_queue"> |
| 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> | 234 | <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> |
| 277 | <dd><p>Send an INFORM command</p> | 235 | <dd><p>Setup worker queues</p> |
| 278 | </dd></dl> | 236 | </dd></dl> |
| 279 | 237 | ||
| 280 | <dl class="method"> | 238 | <dl class="method"> |
| @@ -284,18 +242,10 @@ Processing takes form of calling an <cite>on_COMMAND</cite> method.</td> | |||
| 284 | for another REQUEST message.</p> | 242 | for another REQUEST message.</p> |
| 285 | </dd></dl> | 243 | </dd></dl> |
| 286 | 244 | ||
| 287 | <dl class="method"> | 245 | <dl class="attribute"> |
| 288 | <dt id="eventmq.jobmanager.JobManager.start"> | 246 | <dt id="eventmq.jobmanager.JobManager.workers"> |
| 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> | 247 | <code class="descname">workers</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.jobmanager.JobManager.workers" title="Permalink to this definition">¶</a></dt> |
| 290 | <dd><p>Connect to <cite>addr</cite> and begin listening for job requests</p> | 248 | <dd><p>keep track of workers</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>) – connection string to connect to</td> | ||
| 296 | </tr> | ||
| 297 | </tbody> | ||
| 298 | </table> | ||
| 299 | </dd></dl> | 249 | </dd></dl> |
| 300 | 250 | ||
| 301 | </dd></dl> | 251 | </dd></dl> |