1 files changed, 107 insertions, 1 deletions

diff --git a/client/jobs.html b/client/jobs.html
index ee1e871..1da5fca 100755
--- a/client/jobs.html
+++ b/client/jobs.html
@@ -64,7 +64,7 @@
             
             
               <div class="version">
-                0.3
+                0.3.2
               </div>
             
           
@@ -157,6 +157,10 @@
 <dt id="eventmq.client.jobs.Job">
 <em class="property">class </em><code class="descclassname">eventmq.client.jobs.</code><code class="descname">Job</code><span class="sig-paren">(</span><em>broker_addr=None</em>, <em>queue=None</em>, <em>async=True</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.client.jobs.Job" title="Permalink to this definition">¶</a></dt>
 <dd><p>Defines a deferred EventMQ job.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">All passed class &amp; function kwargs/args MUST be json serializable.</p>
+</div>
 <p>Usage:</p>
 <div class="highlight-python"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">eventmq</span> <span class="kn">import</span> <span class="n">job</span>
 
@@ -217,6 +221,108 @@ can set this to False. This is useful for unit tests.</li>
 <a class="reference internal" href="#eventmq.client.jobs.Job" title="eventmq.client.jobs.Job"><code class="xref py py-class docutils literal"><span class="pre">Job</span></code></a> for more information.</p>
 </dd></dl>
 
+<dl class="function">
+<dt id="eventmq.client.jobs.schedule">
+<code class="descclassname">eventmq.client.jobs.</code><code class="descname">schedule</code><span class="sig-paren">(</span><em>func</em>, <em>broker_addr=None</em>, <em>interval_secs=None</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>cron=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.client.jobs.schedule" title="Permalink to this definition">¶</a></dt>
+<dd><p>Execute a task on a defined interval.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">All passed class &amp; function kwargs/args MUST be json serializable.</p>
+</div>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>func</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#callable" title="(in Python v2.7)"><em>callable</em></a>) &#8211; the callable (or string path to calable) to be
+scheduled on a worker</li>
+<li><strong>broker_addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Address of the broker to send the job to. If no
+address is given then the value of the environment variable
+<code class="docutils literal"><span class="pre">EMQ_BROKER_ADDR</span></code> will be used.</li>
+<li><strong>interval_secs</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Run job every interval_secs or None if using cron</li>
+<li><strong>args</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of <a href="#id1"><span class="problematic" id="id2">*</span></a>args to pass to the callable</li>
+<li><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; dict of <a href="#id3"><span class="problematic" id="id4">**</span></a>kwargs to pass to the callable</li>
+<li><strong>class_args</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of <a href="#id5"><span class="problematic" id="id6">*</span></a>args to pass to the class (if applicable)</li>
+<li><strong>class_kwargs</strong> (<a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; dict of <a href="#id7"><span class="problematic" id="id8">**</span></a>kwargs to pass to the class (if
+applicable)</li>
+<li><strong>headers</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of strings denoting enabled headers. Default:
+guarantee is enabled to ensure the scheduler schedules the job.</li>
+<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; name of the queue to use when executing the job. The
+default value is the default queue.</li>
+<li><strong>cron</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><em>string</em></a>) &#8211; cron formatted string used for job schedule if
+interval_secs is None, i.e. &#8216;* * * * <a href="#id9"><span class="problematic" id="id10">*</span></a>&#8216; (every minute)</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><code class="xref py py-exc docutils literal"><span class="pre">TypeError</span></code> &#8211; When one or more parameters are not JSON serializable.</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils">
+<dt>ID of the schedule message that was sent. None if there was an</dt>
+<dd><p class="first last">error</p>
+</dd>
+</dl>
+</p>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="function">
+<dt id="eventmq.client.jobs.unschedule">
+<code class="descclassname">eventmq.client.jobs.</code><code class="descname">unschedule</code><span class="sig-paren">(</span><em>func</em>, <em>broker_addr=None</em>, <em>interval_secs=None</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>cron=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.client.jobs.unschedule" title="Permalink to this definition">¶</a></dt>
+<dd><p>Stop periodically executing a task</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">All passed class &amp; function kwargs/args MUST be json serializable.</p>
+</div>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>func</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#callable" title="(in Python v2.7)"><em>callable</em></a>) &#8211; the callable (or string path to calable) to be
+scheduled on a worker</li>
+<li><strong>broker_addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Address of the broker to send the job to. If no
+address is given then the value of the environment variable
+<code class="docutils literal"><span class="pre">EMQ_BROKER_ADDR</span></code> will be used.</li>
+<li><strong>interval_secs</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Run job every interval_secs or None if using cron</li>
+<li><strong>args</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of <a href="#id11"><span class="problematic" id="id12">*</span></a>args to pass to the callable</li>
+<li><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; dict of <a href="#id13"><span class="problematic" id="id14">**</span></a>kwargs to pass to the callable</li>
+<li><strong>class_args</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of <a href="#id15"><span class="problematic" id="id16">*</span></a>args to pass to the class (if applicable)</li>
+<li><strong>class_kwargs</strong> (<a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><em>dict</em></a>) &#8211; dict of <a href="#id17"><span class="problematic" id="id18">**</span></a>kwargs to pass to the class (if
+applicable)</li>
+<li><strong>headers</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; list of strings denoting enabled headers. Default:
+guarantee is enabled to ensure the scheduler schedules the job.</li>
+<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; name of the queue to use when executing the job. The
+default value is the default queue.</li>
+<li><strong>cron</strong> (<a class="reference external" href="https://docs.python.org/2/library/string.html#module-string" title="(in Python v2.7)"><em>string</em></a>) &#8211; cron formatted string used for job schedule if
+interval_secs is None, i.e. &#8216;* * * * <a href="#id19"><span class="problematic" id="id20">*</span></a>&#8216; (every minute)</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><code class="xref py py-exc docutils literal"><span class="pre">TypeError</span></code> &#8211; When one or more parameters are not JSON serializable.</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils">
+<dt>ID of the schedule message that was sent. None if there was an</dt>
+<dd><p class="first last">error</p>
+</dd>
+</dl>
+</p>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)">str</a></p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
 </div>