diff options
Diffstat (limited to 'client/messages.html')
| -rw-r--r-- | client/messages.html | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/client/messages.html b/client/messages.html index 6e4b75c..d0cbb95 100644 --- a/client/messages.html +++ b/client/messages.html | |||
| @@ -61,7 +61,7 @@ | |||
| 61 | 61 | ||
| 62 | 62 | ||
| 63 | <div class="version"> | 63 | <div class="version"> |
| 64 | 0.2.6.5 | 64 | 0.2.7 |
| 65 | </div> | 65 | </div> |
| 66 | 66 | ||
| 67 | 67 | ||
| @@ -151,7 +151,7 @@ | |||
| 151 | <h1><code class="xref py py-mod docutils literal"><span class="pre">messages</span></code> – Client Messaging<a class="headerlink" href="#messages-client-messaging" title="Permalink to this headline">¶</a></h1> | 151 | <h1><code class="xref py py-mod docutils literal"><span class="pre">messages</span></code> – Client Messaging<a class="headerlink" href="#messages-client-messaging" title="Permalink to this headline">¶</a></h1> |
| 152 | <dl class="function"> | 152 | <dl class="function"> |
| 153 | <dt id="eventmq.client.messages.defer_job"> | 153 | <dt id="eventmq.client.messages.defer_job"> |
| 154 | <code class="descclassname">eventmq.client.messages.</code><code class="descname">defer_job</code><span class="sig-paren">(</span><em>socket</em>, <em>func</em>, <em>wrapper=None</em>, <em>args=()</em>, <em>kwargs=None</em>, <em>class_args=()</em>, <em>class_kwargs=None</em>, <em>reply_requested=False</em>, <em>guarantee=False</em>, <em>retry_count=0</em>, <em>debounce_secs=False</em>, <em>queue='default'</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.client.messages.defer_job" title="Permalink to this definition">¶</a></dt> | 154 | <code class="descclassname">eventmq.client.messages.</code><code class="descname">defer_job</code><span class="sig-paren">(</span><em>socket</em>, <em>func</em>, <em>wrapper=None</em>, <em>args=()</em>, <em>kwargs=None</em>, <em>class_args=()</em>, <em>class_kwargs=None</em>, <em>reply_requested=False</em>, <em>guarantee=False</em>, <em>retry_count=0</em>, <em>timeout=0</em>, <em>debounce_secs=False</em>, <em>queue='default'</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.client.messages.defer_job" title="Permalink to this definition">¶</a></dt> |
| 155 | <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> |
| 156 | <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 |
| 157 | guarentee things.</p> | 157 | guarentee things.</p> |
| @@ -165,7 +165,8 @@ guarentee things.</p> | |||
| 165 | <tbody valign="top"> | 165 | <tbody valign="top"> |
| 166 | <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"> |
| 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>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> |
| 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>func</strong> (<em>callable or str</em>) – the callable (or string path to callable) to be |
| 169 | deferred to a worker</li> | ||
| 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 | 170 | <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 |
| 170 | wrapped with</li> | 171 | wrapped with</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> | 172 | <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> |
| @@ -178,6 +179,8 @@ initializing (if applicable).</li> | |||
| 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 | 179 | <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 |
| 179 | an Exception or some other failure before giving up. (default: 0 | 180 | an Exception or some other failure before giving up. (default: 0 |
| 180 | or immediately fail)</li> | 181 | or immediately fail)</li> |
| 182 | <li><strong>timeout</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 seconds should we wait before killing the job | ||
| 183 | default: 0 which means infinite timeout</li> | ||
| 181 | <li><strong>debounce_secs</strong> (<em>secs</em>) – Number of seconds to debounce the job. See | 184 | <li><strong>debounce_secs</strong> (<em>secs</em>) – Number of seconds to debounce the job. See |
| 182 | <cite>debounce_deferred_job</cite> for more information.</li> | 185 | <cite>debounce_deferred_job</cite> for more information.</li> |
| 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 | 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>) – Name of queue to use when executing the job. If this value |
| @@ -215,7 +218,8 @@ was an error.</p> | |||
| 215 | <tbody valign="top"> | 218 | <tbody valign="top"> |
| 216 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | 219 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 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> | 220 | <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> |
| 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> | 221 | <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 (or string path to calable) to be |
| 222 | scheduled on a worker</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> | 223 | <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> |
| 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> | 224 | <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> |
| 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> | 225 | <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> |
| @@ -249,7 +253,7 @@ error</p> | |||
| 249 | 253 | ||
| 250 | <dl class="function"> | 254 | <dl class="function"> |
| 251 | <dt id="eventmq.client.messages.send_request"> | 255 | <dt id="eventmq.client.messages.send_request"> |
| 252 | <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> | 256 | <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>timeout=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> |
| 253 | <dd><p>Send a REQUEST command.</p> | 257 | <dd><p>Send a REQUEST command.</p> |
| 254 | <p>Default headers are always all disabled by default. If they are included in | 258 | <p>Default headers are always all disabled by default. If they are included in |
| 255 | the headers then they have been enabled.</p> | 259 | the headers then they have been enabled.</p> |
| @@ -289,6 +293,8 @@ the headers then they have been enabled.</p> | |||
| 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 | 293 | <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 |
| 290 | an Exception or some other failure before giving up. (default: 0 | 294 | an Exception or some other failure before giving up. (default: 0 |
| 291 | or immediatly fail)</li> | 295 | or immediatly fail)</li> |
| 296 | <li><strong>timeout</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 seconds should we wait before killing the job | ||
| 297 | default: 0 which means infinite timeout</li> | ||
| 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 | 298 | <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 |
| 293 | configured default queue name</li> | 299 | configured default queue name</li> |
| 294 | </ul> | 300 | </ul> |