diff options
Diffstat (limited to 'client/messages.html')
| -rw-r--r-- | client/messages.html | 27 |
1 files changed, 4 insertions, 23 deletions
diff --git a/client/messages.html b/client/messages.html index fa76d2a..b59cf18 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.1 | 64 | 0.2.6.2 |
| 65 | </div> | 65 | </div> |
| 66 | 66 | ||
| 67 | 67 | ||
| @@ -150,27 +150,8 @@ | |||
| 150 | <span class="target" id="module-eventmq.client.messages"></span><div class="section" id="messages-client-messaging"> | 150 | <span class="target" id="module-eventmq.client.messages"></span><div class="section" id="messages-client-messaging"> |
| 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.build_module_path"> | ||
| 154 | <code class="descclassname">eventmq.client.messages.</code><code class="descname">build_module_path</code><span class="sig-paren">(</span><em>func</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.client.messages.build_module_path" title="Permalink to this definition">¶</a></dt> | ||
| 155 | <dd><p>Builds the module path in string format for a callable.</p> | ||
| 156 | <table class="docutils field-list" frame="void" rules="none"> | ||
| 157 | <col class="field-name" /> | ||
| 158 | <col class="field-body" /> | ||
| 159 | <tbody valign="top"> | ||
| 160 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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 function or method to build the path for</td> | ||
| 161 | </tr> | ||
| 162 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">(import path (w/ class seperated by a ‘:’), callable name) or | ||
| 163 | (None, None) on error</td> | ||
| 164 | </tr> | ||
| 165 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#list" title="(in Python v2.7)">list</a></td> | ||
| 166 | </tr> | ||
| 167 | </tbody> | ||
| 168 | </table> | ||
| 169 | </dd></dl> | ||
| 170 | |||
| 171 | <dl class="function"> | ||
| 172 | <dt id="eventmq.client.messages.defer_job"> | 153 | <dt id="eventmq.client.messages.defer_job"> |
| 173 | <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>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>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>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> |
| 174 | <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> |
| 175 | <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 |
| 176 | guarentee things.</p> | 157 | guarentee things.</p> |
| @@ -188,11 +169,11 @@ initializing (if applicable).</li> | |||
| 188 | <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 | 169 | <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 |
| 189 | initializing (if applicable).</li> | 170 | initializing (if applicable).</li> |
| 190 | <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> | 171 | <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> |
| 191 | <li><strong>guarantee</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – (Give your best effort) to guarantee that func is | ||
| 192 | executed. Exceptions and things will be logged.</li> | ||
| 193 | <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 | 172 | <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 |
| 194 | an Exception or some other failure before giving up. (default: 0 | 173 | an Exception or some other failure before giving up. (default: 0 |
| 195 | or immediately fail)</li> | 174 | or immediately fail)</li> |
| 175 | <li><strong>debounce_secs</strong> (<em>secs</em>) – Number of seconds to debounce the job. See | ||
| 176 | <cite>debounce_deferred_job</cite> for more information.</li> | ||
| 196 | <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 | 177 | <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 |
| 197 | evaluates to False, the default is used. Default: is configured | 178 | evaluates to False, the default is used. Default: is configured |
| 198 | default queue name</li> | 179 | default queue name</li> |