aboutsummaryrefslogtreecommitdiffstats
path: root/client/jobs.html
diff options
context:
space:
mode:
Diffstat (limited to 'client/jobs.html')
-rwxr-xr-x[-rw-r--r--]client/jobs.html17
1 files changed, 10 insertions, 7 deletions
diff --git a/client/jobs.html b/client/jobs.html
index 1cf76bf..c40d15b 100644..100755
--- a/client/jobs.html
+++ b/client/jobs.html
@@ -30,6 +30,9 @@
30 30
31 31
32 32
33 <link rel="index" title="Index"
34 href="../genindex.html"/>
35 <link rel="search" title="Search" href="../search.html"/>
33 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> 36 <link rel="top" title="EventMQ 0 documentation" href="../index.html"/>
34 <link rel="up" title="client – Client Utilities" href="../client.html"/> 37 <link rel="up" title="client – Client Utilities" href="../client.html"/>
35 <link rel="next" title="exceptions – Exceptions" href="../exceptions.html"/> 38 <link rel="next" title="exceptions – Exceptions" href="../exceptions.html"/>
@@ -61,7 +64,7 @@
61 64
62 65
63 <div class="version"> 66 <div class="version">
64 0.2.7.1 67 0.3-rc8
65 </div> 68 </div>
66 69
67 70
@@ -87,7 +90,7 @@
87<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</a><ul class="current"> 90<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</a><ul class="current">
88<li class="toctree-l2 current"><a class="reference internal" href="../client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a><ul class="current"> 91<li class="toctree-l2 current"><a class="reference internal" href="../client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a><ul class="current">
89<li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Client Messaging</a></li> 92<li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Client Messaging</a></li>
90<li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">jobs</span></code> &#8211; Client Job Helpers</a></li> 93<li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">jobs</span></code> &#8211; Client Job Helpers</a></li>
91</ul> 94</ul>
92</li> 95</li>
93<li class="toctree-l2"><a class="reference internal" href="../exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> &#8211; Exceptions</a></li> 96<li class="toctree-l2"><a class="reference internal" href="../exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> &#8211; Exceptions</a></li>
@@ -122,7 +125,7 @@
122 <div class="rst-content"> 125 <div class="rst-content">
123 126
124 127
125 128
126 129
127 130
128 131
@@ -138,7 +141,7 @@
138 <li class="wy-breadcrumbs-aside"> 141 <li class="wy-breadcrumbs-aside">
139 142
140 143
141 <a href="../_sources/client/jobs.txt" rel="nofollow"> View page source</a> 144 <a href="../_sources/client/jobs.rst.txt" rel="nofollow"> View page source</a>
142 145
143 146
144 </li> 147 </li>
@@ -183,13 +186,13 @@
183<col class="field-body" /> 186<col class="field-body" />
184<tbody valign="top"> 187<tbody valign="top">
185<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 188<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
186<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>) &#8211; Name of the queue this function should be executed 189<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 this function should be executed
187in. If no queue provided <code class="docutils literal"><span class="pre">default</span></code> is used.</li> 190in. If no queue provided <code class="docutils literal"><span class="pre">default</span></code> is used.</li>
188<li><strong>broker_addr</strong> (<a class="reference external" href="https://docs.python.org/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 191<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
189address is given then the value of the environment variable 192address is given then the value of the environment variable
190<code class="docutils literal"><span class="pre">EMQ_BROKER_ADDR</span></code> will be used, If that is undefined a 193<code class="docutils literal"><span class="pre">EMQ_BROKER_ADDR</span></code> will be used, If that is undefined a
191warning will be emitted and the job will be run synchronously.</li> 194warning will be emitted and the job will be run synchronously.</li>
192<li><strong>async</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) &#8211; If you want to run all executions of a particular job 195<li><strong>async</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) &#8211; If you want to run all executions of a particular job
193synchronously but still decorate it with the job decorator you 196synchronously but still decorate it with the job decorator you
194can set this to False. This is useful for unit tests.</li> 197can set this to False. This is useful for unit tests.</li>
195</ul> 198</ul>