diff options
Diffstat (limited to 'client/messages.html')
| -rw-r--r-- | client/messages.html | 103 |
1 files changed, 54 insertions, 49 deletions
diff --git a/client/messages.html b/client/messages.html index 786c501..6e4b75c 100644 --- a/client/messages.html +++ b/client/messages.html | |||
| @@ -30,9 +30,6 @@ | |||
| 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"/> | ||
| 36 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> | 33 | <link rel="top" title="EventMQ 0 documentation" href="../index.html"/> |
| 37 | <link rel="up" title="client – Client Utilities" href="../client.html"/> | 34 | <link rel="up" title="client – Client Utilities" href="../client.html"/> |
| 38 | <link rel="next" title="exceptions – Exceptions" href="../exceptions.html"/> | 35 | <link rel="next" title="exceptions – Exceptions" href="../exceptions.html"/> |
| @@ -64,7 +61,7 @@ | |||
| 64 | 61 | ||
| 65 | 62 | ||
| 66 | <div class="version"> | 63 | <div class="version"> |
| 67 | 0.2.6.3 | 64 | 0.2.6.5 |
| 68 | </div> | 65 | </div> |
| 69 | 66 | ||
| 70 | 67 | ||
| @@ -89,7 +86,7 @@ | |||
| 89 | <li class="toctree-l1"><a class="reference internal" href="../using.html">Using EventMQ</a></li> | 86 | <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"> | 87 | <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> – Client Utilities</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> – Client Utilities</a><ul class="current"> |
| 92 | <li class="toctree-l3 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">messages</span></code> – Client Messaging</a></li> | 89 | <li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">messages</span></code> – Client Messaging</a></li> |
| 93 | </ul> | 90 | </ul> |
| 94 | </li> | 91 | </li> |
| 95 | <li class="toctree-l2"><a class="reference internal" href="../exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> – Exceptions</a></li> | 92 | <li class="toctree-l2"><a class="reference internal" href="../exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> – Exceptions</a></li> |
| @@ -124,7 +121,7 @@ | |||
| 124 | <div class="rst-content"> | 121 | <div class="rst-content"> |
| 125 | 122 | ||
| 126 | 123 | ||
| 127 | 124 | ||
| 128 | 125 | ||
| 129 | 126 | ||
| 130 | 127 | ||
| @@ -158,42 +155,46 @@ | |||
| 158 | <dd><p>Used to send a job to a worker to execute via <cite>socket</cite>.</p> | 155 | <dd><p>Used to send a job to a worker to execute via <cite>socket</cite>.</p> |
| 159 | <p>This tries not to raise any exceptions so use some of the message flags to | 156 | <p>This tries not to raise any exceptions so use some of the message flags to |
| 160 | guarentee things.</p> | 157 | guarentee things.</p> |
| 158 | <div class="admonition note"> | ||
| 159 | <p class="first admonition-title">Note</p> | ||
| 160 | <p class="last">All passed class & fuction kwargs/args MUST be json serializable.</p> | ||
| 161 | </div> | ||
| 161 | <table class="docutils field-list" frame="void" rules="none"> | 162 | <table class="docutils field-list" frame="void" rules="none"> |
| 162 | <col class="field-name" /> | 163 | <col class="field-name" /> |
| 163 | <col class="field-body" /> | 164 | <col class="field-body" /> |
| 164 | <tbody valign="top"> | 165 | <tbody valign="top"> |
| 165 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | 166 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 166 | <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>) – eventmq socket to use for sending the message</li> | 167 | <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> |
| 167 | <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>) – the callable to be deferred to a worker</li> | 168 | <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 deferred to a worker</li> |
| 168 | <li><strong>wrapper</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#callable" title="(in Python v2.7)"><em>callable</em></a>) – optional wrapper for the call to func to be | 169 | <li><strong>wrapper</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#callable" title="(in Python v2.7)"><em>callable</em></a>) – optional wrapper for the call to func to be |
| 169 | wrapped with</li> | 170 | wrapped with</li> |
| 170 | <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>) – list of <a href="#id1"><span class="problematic" id="id2">*</span></a>args for the callable</li> | 171 | <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="#id1"><span class="problematic" id="id2">*</span></a>args for the callable</li> |
| 171 | <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>) – dict of <a href="#id3"><span class="problematic" id="id4">**</span></a>kwargs for the callable</li> | 172 | <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="#id3"><span class="problematic" id="id4">**</span></a>kwargs for the callable</li> |
| 172 | <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>) – list of <a href="#id5"><span class="problematic" id="id6">*</span></a>args to pass to the the class when | 173 | <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="#id5"><span class="problematic" id="id6">*</span></a>args to pass to the the class when |
| 173 | initializing (if applicable).</li> | 174 | initializing (if applicable).</li> |
| 174 | <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>) – dict of <a href="#id7"><span class="problematic" id="id8">**</span></a>kwargs to pass to the class when | 175 | <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="#id7"><span class="problematic" id="id8">**</span></a>kwargs to pass to the class when |
| 175 | initializing (if applicable).</li> | 176 | initializing (if applicable).</li> |
| 176 | <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>) – request the return value of func as a reply</li> | 177 | <li><strong>reply_requested</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – request the return value of func as a reply</li> |
| 177 | <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>) – How many times should be retried when encountering | 178 | <li><strong>retry_count</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – How many times should be retried when encountering |
| 178 | an Exception or some other failure before giving up. (default: 0 | 179 | an Exception or some other failure before giving up. (default: 0 |
| 179 | or immediately fail)</li> | 180 | or immediately fail)</li> |
| 180 | <li><strong>debounce_secs</strong> (<em>secs</em>) – Number of seconds to debounce the job. See | 181 | <li><strong>debounce_secs</strong> (<em>secs</em>) – Number of seconds to debounce the job. See |
| 181 | <cite>debounce_deferred_job</cite> for more information.</li> | 182 | <cite>debounce_deferred_job</cite> for more information.</li> |
| 182 | <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>) – Name of queue to use when executing the job. If this value | 183 | <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 to use when executing the job. If this value |
| 183 | evaluates to False, the default is used. Default: is configured | 184 | evaluates to False, the default is used. Default: is configured |
| 184 | default queue name</li> | 185 | default queue name</li> |
| 185 | </ul> | 186 | </ul> |
| 186 | </td> | 187 | </td> |
| 187 | </tr> | 188 | </tr> |
| 188 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils"> | 189 | <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> – |
| 189 | <dt>ID for the message/deferred job. This value will be None if there</dt> | 190 | When one or more parameters are not JSON serializable.</p> |
| 190 | <dd><p class="first last">was an error.</p> | 191 | </td> |
| 191 | </dd> | 192 | </tr> |
| 192 | </dl> | 193 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID for the message/deferred job. This value will be None if there |
| 193 | </p> | 194 | was an error.</p> |
| 194 | </td> | 195 | </td> |
| 195 | </tr> | 196 | </tr> |
| 196 | <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> | 197 | <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/library/functions.html#str" title="(in Python v2.7)">str</a></p> |
| 197 | </td> | 198 | </td> |
| 198 | </tr> | 199 | </tr> |
| 199 | </tbody> | 200 | </tbody> |
| @@ -204,38 +205,42 @@ default queue name</li> | |||
| 204 | <dt id="eventmq.client.messages.schedule"> | 205 | <dt id="eventmq.client.messages.schedule"> |
| 205 | <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=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>unschedule=False</em>, <em>cron=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.client.messages.schedule" title="Permalink to this definition">¶</a></dt> | 206 | <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=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>unschedule=False</em>, <em>cron=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.client.messages.schedule" title="Permalink to this definition">¶</a></dt> |
| 206 | <dd><p>Execute a task on a defined interval.</p> | 207 | <dd><p>Execute a task on a defined interval.</p> |
| 208 | <div class="admonition note"> | ||
| 209 | <p class="first admonition-title">Note</p> | ||
| 210 | <p class="last">All passed class & fuction kwargs/args MUST be json serializable.</p> | ||
| 211 | </div> | ||
| 207 | <table class="docutils field-list" frame="void" rules="none"> | 212 | <table class="docutils field-list" frame="void" rules="none"> |
| 208 | <col class="field-name" /> | 213 | <col class="field-name" /> |
| 209 | <col class="field-body" /> | 214 | <col class="field-body" /> |
| 210 | <tbody valign="top"> | 215 | <tbody valign="top"> |
| 211 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | 216 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 212 | <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>) – eventmq socket to use for sending the message</li> | 217 | <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> |
| 213 | <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>) – the callable to be scheduled on a worker</li> | 218 | <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> |
| 214 | <li><strong>minutes</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – minutes to wait in between executions</li> | 219 | <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> |
| 215 | <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>) – list of <a href="#id9"><span class="problematic" id="id10">*</span></a>args to pass to the callable</li> | 220 | <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> |
| 216 | <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>) – Run job every interval_secs or None if using cron</li> | 221 | <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>) – Run job every interval_secs or None if using cron</li> |
| 217 | <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>) – cron formatted string used for job schedule if | 222 | <li><strong>cron</strong> (<a class="reference external" href="https://docs.python.org/library/string.html#module-string" title="(in Python v2.7)"><em>string</em></a>) – cron formatted string used for job schedule if |
| 218 | interval_secs is None, i.e. ‘* * * * <a href="#id11"><span class="problematic" id="id12">*</span></a>‘ (every minute)</li> | 223 | interval_secs is None, i.e. ‘* * * * <a href="#id11"><span class="problematic" id="id12">*</span></a>‘ (every minute)</li> |
| 219 | <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>) – dict of <a href="#id13"><span class="problematic" id="id14">**</span></a>kwargs to pass to the callable</li> | 224 | <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="#id13"><span class="problematic" id="id14">**</span></a>kwargs to pass to the callable</li> |
| 220 | <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>) – list of <a href="#id15"><span class="problematic" id="id16">*</span></a>args to pass to the class (if applicable)</li> | 225 | <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="#id15"><span class="problematic" id="id16">*</span></a>args to pass to the class (if applicable)</li> |
| 221 | <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>) – dict of <a href="#id17"><span class="problematic" id="id18">**</span></a>kwargs to pass to the class (if | 226 | <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="#id17"><span class="problematic" id="id18">**</span></a>kwargs to pass to the class (if |
| 222 | applicable)</li> | 227 | applicable)</li> |
| 223 | <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>) – list of strings denoting enabled headers. Default: | 228 | <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: |
| 224 | guarantee is enabled to ensure the scheduler schedules the job.</li> | 229 | guarantee is enabled to ensure the scheduler schedules the job.</li> |
| 225 | <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>) – name of the queue to use when executing the job. The | 230 | <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 |
| 226 | default value is the default queue.</li> | 231 | default value is the default queue.</li> |
| 227 | </ul> | 232 | </ul> |
| 228 | </td> | 233 | </td> |
| 229 | </tr> | 234 | </tr> |
| 230 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils"> | 235 | <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> – |
| 231 | <dt>ID of the schedule message that was sent. None if there was an</dt> | 236 | When one or more parameters are not JSON serializable.</p> |
| 232 | <dd><p class="first last">error</p> | 237 | </td> |
| 233 | </dd> | 238 | </tr> |
| 234 | </dl> | 239 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the schedule message that was sent. None if there was an |
| 235 | </p> | 240 | error</p> |
| 236 | </td> | 241 | </td> |
| 237 | </tr> | 242 | </tr> |
| 238 | <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> | 243 | <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/library/functions.html#str" title="(in Python v2.7)">str</a></p> |
| 239 | </td> | 244 | </td> |
| 240 | </tr> | 245 | </tr> |
| 241 | </tbody> | 246 | </tbody> |
| @@ -281,10 +286,10 @@ the headers then they have been enabled.</p> | |||
| 281 | <col class="field-body" /> | 286 | <col class="field-body" /> |
| 282 | <tbody valign="top"> | 287 | <tbody valign="top"> |
| 283 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | 288 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 284 | <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>) – How many times should be retried when encountering | 289 | <li><strong>retry_count</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – How many times should be retried when encountering |
| 285 | an Exception or some other failure before giving up. (default: 0 | 290 | an Exception or some other failure before giving up. (default: 0 |
| 286 | or immediatly fail)</li> | 291 | or immediatly fail)</li> |
| 287 | <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>) – Name of queue to use when executing the job. Default: is | 292 | <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 to use when executing the job. Default: is |
| 288 | configured default queue name</li> | 293 | configured default queue name</li> |
| 289 | </ul> | 294 | </ul> |
| 290 | </td> | 295 | </td> |
| @@ -292,7 +297,7 @@ configured default queue name</li> | |||
| 292 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p> | 297 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p> |
| 293 | </td> | 298 | </td> |
| 294 | </tr> | 299 | </tr> |
| 295 | <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> | 300 | <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/library/functions.html#str" title="(in Python v2.7)">str</a></p> |
| 296 | </td> | 301 | </td> |
| 297 | </tr> | 302 | </tr> |
| 298 | </tbody> | 303 | </tbody> |
| @@ -310,18 +315,18 @@ interval for the scheduler.</p> | |||
| 310 | <col class="field-body" /> | 315 | <col class="field-body" /> |
| 311 | <tbody valign="top"> | 316 | <tbody valign="top"> |
| 312 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | 317 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 313 | <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>) – </li> | 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> |
| 314 | <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>) – </li> | 319 | <li><strong>(str)</strong> (<em>job_schedule</em>) – </li> |
| 315 | <li><strong>message</strong> – Message to send socket.</li> | 320 | <li><strong>message</strong> – Message to send socket.</li> |
| 316 | <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>) – List of headers for the message</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> |
| 317 | <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>) – name of queue the job should be executed in</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> |
| 318 | </ul> | 323 | </ul> |
| 319 | </td> | 324 | </td> |
| 320 | </tr> | 325 | </tr> |
| 321 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p> | 326 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ID of the message</p> |
| 322 | </td> | 327 | </td> |
| 323 | </tr> | 328 | </tr> |
| 324 | <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> | 329 | <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/library/functions.html#str" title="(in Python v2.7)">str</a></p> |
| 325 | </td> | 330 | </td> |
| 326 | </tr> | 331 | </tr> |
| 327 | </tbody> | 332 | </tbody> |