aboutsummaryrefslogtreecommitdiffstats
path: root/client/messages.html
diff options
context:
space:
mode:
Diffstat (limited to 'client/messages.html')
-rwxr-xr-xclient/messages.html123
1 files changed, 76 insertions, 47 deletions
diff --git a/client/messages.html b/client/messages.html
index f864c67..88998d6 100755
--- a/client/messages.html
+++ b/client/messages.html
@@ -13,6 +13,8 @@
13 13
14 14
15 15
16
17
16 18
17 19
18 20
@@ -45,6 +47,7 @@
45 47
46<body class="wy-body-for-nav" role="document"> 48<body class="wy-body-for-nav" role="document">
47 49
50
48 <div class="wy-grid-for-nav"> 51 <div class="wy-grid-for-nav">
49 52
50 53
@@ -64,7 +67,7 @@
64 67
65 68
66 <div class="version"> 69 <div class="version">
67 0.3.3 70 0.3.6
68 </div> 71 </div>
69 72
70 73
@@ -85,7 +88,10 @@
85 88
86 89
87 90
88 <ul class="current"> 91
92
93
94 <ul class="current">
89<li class="toctree-l1"><a class="reference internal" href="../using.html">Using EventMQ</a></li> 95<li class="toctree-l1"><a class="reference internal" href="../using.html">Using EventMQ</a></li>
90<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</a><ul class="current"> 96<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Documentation</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"> 97<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">
@@ -115,8 +121,10 @@
115 121
116 122
117 <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> 123 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
118 <i data-toggle="wy-nav-top" class="fa fa-bars"></i> 124
119 <a href="../index.html">EventMQ</a> 125 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
126 <a href="../index.html">EventMQ</a>
127
120 </nav> 128 </nav>
121 129
122 130
@@ -125,27 +133,44 @@
125 <div class="rst-content"> 133 <div class="rst-content">
126 134
127 135
128 136
137
138
139
140
141
142
143
144
145
146
129 147
130 148
131 149
132<div role="navigation" aria-label="breadcrumbs navigation"> 150<div role="navigation" aria-label="breadcrumbs navigation">
151
133 <ul class="wy-breadcrumbs"> 152 <ul class="wy-breadcrumbs">
134 <li><a href="../index.html">Docs</a> &raquo;</li> 153
135 154 <li><a href="../index.html">Docs</a> &raquo;</li>
155
136 <li><a href="../api.html">API Documentation</a> &raquo;</li> 156 <li><a href="../api.html">API Documentation</a> &raquo;</li>
137 157
138 <li><a href="../client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a> &raquo;</li> 158 <li><a href="../client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a> &raquo;</li>
139 159
140 <li><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Client Messaging</li> 160 <li><code class="docutils literal"><span class="pre">messages</span></code> &#8211; Client Messaging</li>
161
162
141 <li class="wy-breadcrumbs-aside"> 163 <li class="wy-breadcrumbs-aside">
142 164
143 165
144 <a href="../_sources/client/messages.rst.txt" rel="nofollow"> View page source</a> 166 <a href="../_sources/client/messages.rst.txt" rel="nofollow"> View page source</a>
145 167
146 168
147 </li> 169 </li>
170
148 </ul> 171 </ul>
172
173
149 <hr/> 174 <hr/>
150</div> 175</div>
151 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> 176 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
@@ -168,30 +193,30 @@ guarentee things.</p>
168<col class="field-body" /> 193<col class="field-body" />
169<tbody valign="top"> 194<tbody valign="top">
170<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 195<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
171<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/2/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; eventmq socket to use for sending the message</li> 196<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/3/library/socket.html#module-socket" title="(in Python v3.7)"><em>socket</em></a>) &#8211; eventmq socket to use for sending the message</li>
172<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><em> or </em><a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; the callable (or string path to callable) to be 197<li><strong>func</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#callable" title="(in Python v3.7)"><em>callable</em></a><em> or </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; the callable (or string path to callable) to be
173deferred to a worker</li> 198deferred to a worker</li>
174<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 for the callable</li> 199<li><strong>args</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a>) &#8211; list of <a href="#id1"><span class="problematic" id="id2">*</span></a>args for the callable</li>
175<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 for the callable</li> 200<li><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) &#8211; dict of <a href="#id3"><span class="problematic" id="id4">**</span></a>kwargs for the callable</li>
176<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 the class when 201<li><strong>class_args</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a>) &#8211; list of <a href="#id5"><span class="problematic" id="id6">*</span></a>args to pass to the the class when
177initializing (if applicable).</li> 202initializing (if applicable).</li>
178<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 when 203<li><strong>class_kwargs</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) &#8211; dict of <a href="#id7"><span class="problematic" id="id8">**</span></a>kwargs to pass to the class when
179initializing (if applicable).</li> 204initializing (if applicable).</li>
180<li><strong>reply_requested</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; request the return value of func as a reply</li> 205<li><strong>reply_requested</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) &#8211; request the return value of func as a reply</li>
181<li><strong>retry_count</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; How many times should be retried when encountering 206<li><strong>retry_count</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) &#8211; How many times should be retried when encountering
182an Exception or some other failure before giving up. (default: 0 207an Exception or some other failure before giving up. (default: 0
183or immediately fail)</li> 208or immediately fail)</li>
184<li><strong>timeout</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; How many seconds should we wait before killing the job 209<li><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) &#8211; How many seconds should we wait before killing the job
185default: 0 which means infinite timeout</li> 210default: 0 which means infinite timeout</li>
186<li><strong>debounce_secs</strong> (<em>secs</em>) &#8211; Number of seconds to debounce the job. See 211<li><strong>debounce_secs</strong> (<em>secs</em>) &#8211; Number of seconds to debounce the job. See
187<cite>debounce_deferred_job</cite> for more information.</li> 212<cite>debounce_deferred_job</cite> for more information.</li>
188<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 queue to use when executing the job. If this value 213<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; Name of queue to use when executing the job. If this value
189evaluates to False, the default is used. Default: is configured 214evaluates to False, the default is used. Default: is configured
190default queue name</li> 215default queue name</li>
191</ul> 216</ul>
192</td> 217</td>
193</tr> 218</tr>
194<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> 219<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.7)"><code class="xref py py-exc docutils literal"><span class="pre">TypeError</span></code></a> &#8211; When one or more parameters are not JSON serializable.</p>
195</td> 220</td>
196</tr> 221</tr>
197<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils"> 222<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils">
@@ -202,7 +227,7 @@ default queue name</li>
202</p> 227</p>
203</td> 228</td>
204</tr> 229</tr>
205<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> 230<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/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></p>
206</td> 231</td>
207</tr> 232</tr>
208</tbody> 233</tbody>
@@ -222,25 +247,25 @@ default queue name</li>
222<col class="field-body" /> 247<col class="field-body" />
223<tbody valign="top"> 248<tbody valign="top">
224<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 249<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
225<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/2/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; eventmq socket to use for sending the message</li> 250<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/3/library/socket.html#module-socket" title="(in Python v3.7)"><em>socket</em></a>) &#8211; eventmq socket to use for sending the message</li>
226<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 251<li><strong>func</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#callable" title="(in Python v3.7)"><em>callable</em></a>) &#8211; the callable (or string path to calable) to be
227scheduled on a worker</li> 252scheduled on a worker</li>
228<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> 253<li><strong>interval_secs</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) &#8211; Run job every interval_secs or None if using cron</li>
229<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="#id9"><span class="problematic" id="id10">*</span></a>args to pass to the callable</li> 254<li><strong>args</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a>) &#8211; list of <a href="#id9"><span class="problematic" id="id10">*</span></a>args to pass to the callable</li>
230<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 255<li><strong>cron</strong> (<a class="reference external" href="https://docs.python.org/3/library/string.html#module-string" title="(in Python v3.7)"><em>string</em></a>) &#8211; cron formatted string used for job schedule if
231interval_secs is None, i.e. &#8216;* * * * <a href="#id11"><span class="problematic" id="id12">*</span></a>&#8216; (every minute)</li> 256interval_secs is None, i.e. &#8216;* * * * <a href="#id11"><span class="problematic" id="id12">*</span></a>&#8216; (every minute)</li>
232<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> 257<li><strong>kwargs</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.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>
233<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> 258<li><strong>class_args</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.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>
234<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 259<li><strong>class_kwargs</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.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
235applicable)</li> 260applicable)</li>
236<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: 261<li><strong>headers</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a>) &#8211; list of strings denoting enabled headers. Default:
237guarantee is enabled to ensure the scheduler schedules the job.</li> 262guarantee is enabled to ensure the scheduler schedules the job.</li>
238<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 263<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; name of the queue to use when executing the job. The
239default value is the default queue.</li> 264default value is the default queue.</li>
240</ul> 265</ul>
241</td> 266</td>
242</tr> 267</tr>
243<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> 268<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.7)"><code class="xref py py-exc docutils literal"><span class="pre">TypeError</span></code></a> &#8211; When one or more parameters are not JSON serializable.</p>
244</td> 269</td>
245</tr> 270</tr>
246<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils"> 271<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils">
@@ -251,7 +276,7 @@ default value is the default queue.</li>
251</p> 276</p>
252</td> 277</td>
253</tr> 278</tr>
254<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> 279<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/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></p>
255</td> 280</td>
256</tr> 281</tr>
257</tbody> 282</tbody>
@@ -297,12 +322,12 @@ the headers then they have been enabled.</p>
297<col class="field-body" /> 322<col class="field-body" />
298<tbody valign="top"> 323<tbody valign="top">
299<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 324<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
300<li><strong>retry_count</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; How many times should be retried when encountering 325<li><strong>retry_count</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) &#8211; How many times should be retried when encountering
301an Exception or some other failure before giving up. (default: 0 326an Exception or some other failure before giving up. (default: 0
302or immediatly fail)</li> 327or immediatly fail)</li>
303<li><strong>timeout</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; How many seconds should we wait before killing the job 328<li><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) &#8211; How many seconds should we wait before killing the job
304default: 0 which means infinite timeout</li> 329default: 0 which means infinite timeout</li>
305<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 queue to use when executing the job. Default: is 330<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; Name of queue to use when executing the job. Default: is
306configured default queue name</li> 331configured default queue name</li>
307</ul> 332</ul>
308</td> 333</td>
@@ -310,7 +335,7 @@ configured default queue name</li>
310<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p> 335<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p>
311</td> 336</td>
312</tr> 337</tr>
313<tr class="field-odd 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> 338<tr class="field-odd 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/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></p>
314</td> 339</td>
315</tr> 340</tr>
316</tbody> 341</tbody>
@@ -328,18 +353,18 @@ interval for the scheduler.</p>
328<col class="field-body" /> 353<col class="field-body" />
329<tbody valign="top"> 354<tbody valign="top">
330<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 355<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
331<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/2/library/socket.html#module-socket" title="(in Python v2.7)"><em>socket</em></a>) &#8211; </li> 356<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/3/library/socket.html#module-socket" title="(in Python v3.7)"><em>socket</em></a>) &#8211; </li>
332<li><strong>job_schedule</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; </li> 357<li><strong>job_schedule</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; </li>
333<li><strong>message</strong> &#8211; Message to send socket.</li> 358<li><strong>message</strong> &#8211; Message to send socket.</li>
334<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 headers for the message</li> 359<li><strong>headers</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a>) &#8211; List of headers for the message</li>
335<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 queue the job should be executed in</li> 360<li><strong>queue</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; name of queue the job should be executed in</li>
336</ul> 361</ul>
337</td> 362</td>
338</tr> 363</tr>
339<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p> 364<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p>
340</td> 365</td>
341</tr> 366</tr>
342<tr class="field-odd 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> 367<tr class="field-odd 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/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></p>
343</td> 368</td>
344</tr> 369</tr>
345</tbody> 370</tbody>
@@ -350,15 +375,18 @@ interval for the scheduler.</p>
350 375
351 376
352 </div> 377 </div>
378 <div class="articleComments">
379
380 </div>
353 </div> 381 </div>
354 <footer> 382 <footer>
355 383
356 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 384 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
357 385
358 <a href="jobs.html" class="btn btn-neutral float-right" title="jobs – Client Job Helpers" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> 386 <a href="jobs.html" class="btn btn-neutral float-right" title="jobs – Client Job Helpers" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
359 387
360 388
361 <a href="../client.html" class="btn btn-neutral" title="client – Client Utilities" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> 389 <a href="../client.html" class="btn btn-neutral" title="client – Client Utilities" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
362 390
363 </div> 391 </div>
364 392
@@ -392,7 +420,8 @@ interval for the scheduler.</p>
392 VERSION:'0', 420 VERSION:'0',
393 COLLAPSE_INDEX:false, 421 COLLAPSE_INDEX:false,
394 FILE_SUFFIX:'.html', 422 FILE_SUFFIX:'.html',
395 HAS_SOURCE: true 423 HAS_SOURCE: true,
424 SOURCELINK_SUFFIX: '.txt'
396 }; 425 };
397 </script> 426 </script>
398 <script type="text/javascript" src="../_static/jquery.js"></script> 427 <script type="text/javascript" src="../_static/jquery.js"></script>
generated by cgit v1.2.1 (git 2.18.0) at 2026-01-12 04:54:54 +0000