diff options
Diffstat (limited to 'receiver.html')
| -rw-r--r-- | receiver.html | 21 |
1 files changed, 14 insertions, 7 deletions
diff --git a/receiver.html b/receiver.html index 2147864..038c890 100644 --- a/receiver.html +++ b/receiver.html | |||
| @@ -31,6 +31,7 @@ | |||
| 31 | 31 | ||
| 32 | 32 | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> | 33 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> |
| 34 | <link rel="up" title="API Documentation" href="api.html"/> | ||
| 34 | <link rel="next" title="router – Router" href="router.html"/> | 35 | <link rel="next" title="router – Router" href="router.html"/> |
| 35 | <link rel="prev" title="jobmanager – Job Manager" href="jobmanager.html"/> | 36 | <link rel="prev" title="jobmanager – Job Manager" href="jobmanager.html"/> |
| 36 | 37 | ||
| @@ -82,10 +83,14 @@ | |||
| 82 | 83 | ||
| 83 | 84 | ||
| 84 | <ul class="current"> | 85 | <ul class="current"> |
| 85 | <li class="toctree-l1"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> – Job Manager</a></li> | 86 | <li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current"> |
| 86 | <li class="toctree-l1 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> | 87 | <li class="toctree-l2"><a class="reference internal" href="jobmanager.html"><code class="docutils literal"><span class="pre">jobmanager</span></code> – Job Manager</a></li> |
| 87 | <li class="toctree-l1"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> | 88 | <li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> |
| 88 | <li class="toctree-l1"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> | 89 | <li class="toctree-l2"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> |
| 90 | <li class="toctree-l2"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> | ||
| 91 | </ul> | ||
| 92 | </li> | ||
| 93 | <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li> | ||
| 89 | </ul> | 94 | </ul> |
| 90 | 95 | ||
| 91 | 96 | ||
| @@ -116,6 +121,8 @@ | |||
| 116 | <ul class="wy-breadcrumbs"> | 121 | <ul class="wy-breadcrumbs"> |
| 117 | <li><a href="index.html">Docs</a> »</li> | 122 | <li><a href="index.html">Docs</a> »</li> |
| 118 | 123 | ||
| 124 | <li><a href="api.html">API Documentation</a> »</li> | ||
| 125 | |||
| 119 | <li><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</li> | 126 | <li><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</li> |
| 120 | <li class="wy-breadcrumbs-aside"> | 127 | <li class="wy-breadcrumbs-aside"> |
| 121 | 128 | ||
| @@ -136,7 +143,7 @@ | |||
| 136 | <dl class="class"> | 143 | <dl class="class"> |
| 137 | <dt id="eventmq.receiver.Receiver"> | 144 | <dt id="eventmq.receiver.Receiver"> |
| 138 | <em class="property">class </em><code class="descclassname">eventmq.receiver.</code><code class="descname">Receiver</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.receiver.Receiver" title="Permalink to this definition">¶</a></dt> | 145 | <em class="property">class </em><code class="descclassname">eventmq.receiver.</code><code class="descname">Receiver</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.receiver.Receiver" title="Permalink to this definition">¶</a></dt> |
| 139 | <dd><p>Receives messages and pass them to a callable.</p> | 146 | <dd><p>Receives messages and pass them to a on_recv.</p> |
| 140 | <div class="admonition note"> | 147 | <div class="admonition note"> |
| 141 | <p class="first admonition-title">Note</p> | 148 | <p class="first admonition-title">Note</p> |
| 142 | <p class="last">Polling with this reciever is currently only available via an eventloop | 149 | <p class="last">Polling with this reciever is currently only available via an eventloop |
| @@ -173,8 +180,6 @@ | |||
| 173 | <col class="field-body" /> | 180 | <col class="field-body" /> |
| 174 | <tbody valign="top"> | 181 | <tbody valign="top"> |
| 175 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | 182 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 176 | <li><strong>callable</strong> – REQUIRED A function or method to call when a message is | ||
| 177 | received</li> | ||
| 178 | <li><strong>name</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 this socket. By default a uuid will be | 183 | <li><strong>name</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 this socket. By default a uuid will be |
| 179 | generated</li> | 184 | generated</li> |
| 180 | <li><strong>context</strong> (<a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Context" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Context</span></code></a>) – Context to use when buliding the | 185 | <li><strong>context</strong> (<a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Context" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Context</span></code></a>) – Context to use when buliding the |
| @@ -183,6 +188,8 @@ socket</li> | |||
| 183 | <code class="xref py py-attr docutils literal"><span class="pre">zmq.ROUTER</span></code>. By default a <cite>ROUTER</cite> is used</li> | 188 | <code class="xref py py-attr docutils literal"><span class="pre">zmq.ROUTER</span></code>. By default a <cite>ROUTER</cite> is used</li> |
| 184 | <li><strong>skip_zmqstream</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – If set to true, skip creating the zmqstream | 189 | <li><strong>skip_zmqstream</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – If set to true, skip creating the zmqstream |
| 185 | socket. Callable is unused and optional when this is True</li> | 190 | socket. Callable is unused and optional when this is True</li> |
| 191 | <li><strong>on_recv</strong> – REQUIRED for zmqstream mode. A function or method to call | ||
| 192 | when a message is received</li> | ||
| 186 | </ul> | 193 | </ul> |
| 187 | </td> | 194 | </td> |
| 188 | </tr> | 195 | </tr> |