diff options
Diffstat (limited to 'jobmanager.html')
| -rw-r--r-- | jobmanager.html | 52 |
1 files changed, 44 insertions, 8 deletions
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> – 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> – 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> – 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> – 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> – 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> – 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> – 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> – 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> – 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> »</li> | 123 | <li><a href="index.html">Docs</a> »</li> |
| 118 | 124 | ||
| 125 | <li><a href="api.html">API Documentation</a> »</li> | ||
| 126 | |||
| 119 | <li><code class="docutils literal"><span class="pre">jobmanager</span></code> – Job Manager</li> | 127 | <li><code class="docutils literal"><span class="pre">jobmanager</span></code> – 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> – 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> – 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> |
| 136 | Spawns 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>) – 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 | ||