diff options
Diffstat (limited to 'client/messages.html')
| -rw-r--r-- | client/messages.html | 51 |
1 files changed, 0 insertions, 51 deletions
diff --git a/client/messages.html b/client/messages.html index 744397a..4b9647f 100644 --- a/client/messages.html +++ b/client/messages.html | |||
| @@ -226,34 +226,6 @@ that would otherwise overwhelm a box that has to do it all alone. | |||
| 226 | </dd></dl> | 226 | </dd></dl> |
| 227 | 227 | ||
| 228 | <dl class="function"> | 228 | <dl class="function"> |
| 229 | <dt id="eventmq.client.messages.schedule"> | ||
| 230 | <code class="descclassname">eventmq.client.messages.</code><code class="descname">schedule</code><span class="sig-paren">(</span><em>socket</em>, <em>func</em>, <em>interval_secs</em>, <em>args=()</em>, <em>kwargs=None</em>, <em>class_args=()</em>, <em>class_kwargs=None</em>, <em>headers=('guarantee'</em>, <em>)</em>, <em>queue='default'</em>, <em>unschedule=False</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.client.messages.schedule" title="Permalink to this definition">¶</a></dt> | ||
| 231 | <dd><p>Execute a task on a defined interval.</p> | ||
| 232 | <table class="docutils field-list" frame="void" rules="none"> | ||
| 233 | <col class="field-name" /> | ||
| 234 | <col class="field-body" /> | ||
| 235 | <tbody valign="top"> | ||
| 236 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | ||
| 237 | <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>) – eventmq socket to use for sending the message</li> | ||
| 238 | <li><strong>func</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#callable" title="(in Python v2.7)"><em>callable</em></a>) – the callable to be scheduled on a worker</li> | ||
| 239 | <li><strong>minutes</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – minutes to wait in between executions</li> | ||
| 240 | <li><strong>args</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) – list of <a href="#id9"><span class="problematic" id="id10">*</span></a>args to pass to the callable</li> | ||
| 241 | <li><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) – dict of <a href="#id11"><span class="problematic" id="id12">**</span></a>kwargs to pass to the callable</li> | ||
| 242 | <li><strong>class_args</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) – list of <a href="#id13"><span class="problematic" id="id14">*</span></a>args to pass to the class (if applicable)</li> | ||
| 243 | <li><strong>class_kwargs</strong> (<a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) – dict of <a href="#id15"><span class="problematic" id="id16">**</span></a>kwargs to pass to the class (if | ||
| 244 | applicable)</li> | ||
| 245 | <li><strong>headers</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) – list of strings denoting enabled headers. Default: | ||
| 246 | guarantee is enabled to ensure the scheduler schedules the job.</li> | ||
| 247 | <li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – name of the queue to use when executing the job. The | ||
| 248 | default value is the default queue.</li> | ||
| 249 | </ul> | ||
| 250 | </td> | ||
| 251 | </tr> | ||
| 252 | </tbody> | ||
| 253 | </table> | ||
| 254 | </dd></dl> | ||
| 255 | |||
| 256 | <dl class="function"> | ||
| 257 | <dt id="eventmq.client.messages.send_request"> | 229 | <dt id="eventmq.client.messages.send_request"> |
| 258 | <code class="descclassname">eventmq.client.messages.</code><code class="descname">send_request</code><span class="sig-paren">(</span><em>socket</em>, <em>message</em>, <em>reply_requested=False</em>, <em>guarantee=False</em>, <em>retry_count=0</em>, <em>queue=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.client.messages.send_request" title="Permalink to this definition">¶</a></dt> | 230 | <code class="descclassname">eventmq.client.messages.</code><code class="descname">send_request</code><span class="sig-paren">(</span><em>socket</em>, <em>message</em>, <em>reply_requested=False</em>, <em>guarantee=False</em>, <em>retry_count=0</em>, <em>queue=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.client.messages.send_request" title="Permalink to this definition">¶</a></dt> |
| 259 | <dd><p>Send a REQUEST command.</p> | 231 | <dd><p>Send a REQUEST command.</p> |
| @@ -304,29 +276,6 @@ configured default queue name</li> | |||
| 304 | </table> | 276 | </table> |
| 305 | </dd></dl> | 277 | </dd></dl> |
| 306 | 278 | ||
| 307 | <dl class="function"> | ||
| 308 | <dt id="eventmq.client.messages.send_schedule_request"> | ||
| 309 | <code class="descclassname">eventmq.client.messages.</code><code class="descname">send_schedule_request</code><span class="sig-paren">(</span><em>socket</em>, <em>interval_secs</em>, <em>message</em>, <em>headers=()</em>, <em>queue=None</em>, <em>unschedule=False</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.client.messages.send_schedule_request" title="Permalink to this definition">¶</a></dt> | ||
| 310 | <dd><p>Send a SCHEDULE or UNSCHEDULE command.</p> | ||
| 311 | <p>Queues a message requesting that something happens on an | ||
| 312 | interval for the scheduler.</p> | ||
| 313 | <table class="docutils field-list" frame="void" rules="none"> | ||
| 314 | <col class="field-name" /> | ||
| 315 | <col class="field-body" /> | ||
| 316 | <tbody valign="top"> | ||
| 317 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | ||
| 318 | <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>) – </li> | ||
| 319 | <li><strong>interval_secs</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li> | ||
| 320 | <li><strong>message</strong> – Message to send socket.</li> | ||
| 321 | <li><strong>headers</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) – List of headers for the message</li> | ||
| 322 | <li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – name of queue the job should be executed in</li> | ||
| 323 | </ul> | ||
| 324 | </td> | ||
| 325 | </tr> | ||
| 326 | </tbody> | ||
| 327 | </table> | ||
| 328 | </dd></dl> | ||
| 329 | |||
| 330 | </div> | 279 | </div> |
| 331 | 280 | ||
| 332 | 281 | ||