diff options
Diffstat (limited to 'poller.html')
| -rw-r--r-- | poller.html | 23 |
1 files changed, 10 insertions, 13 deletions
diff --git a/poller.html b/poller.html index 2e476ea..e194f10 100644 --- a/poller.html +++ b/poller.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="API Documentation" href="api.html"/> | 34 | <link rel="up" title="API Documentation" href="api.html"/> |
| 38 | <link rel="next" title="receiver – Receiver" href="receiver.html"/> | 35 | <link rel="next" title="receiver – Receiver" href="receiver.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 | ||
| @@ -91,7 +88,7 @@ | |||
| 91 | <li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> – Client Utilities</a></li> | 88 | <li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> – Client Utilities</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> | 89 | <li class="toctree-l2"><a class="reference internal" href="exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> – Exceptions</a></li> |
| 93 | <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> | 90 | <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> |
| 94 | <li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">poller</span></code> – Poller</a></li> | 91 | <li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">poller</span></code> – Poller</a></li> |
| 95 | <li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> | 92 | <li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> |
| 96 | <li class="toctree-l2"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> | 93 | <li class="toctree-l2"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li> |
| 97 | <li class="toctree-l2"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> | 94 | <li class="toctree-l2"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li> |
| @@ -121,7 +118,7 @@ | |||
| 121 | <div class="rst-content"> | 118 | <div class="rst-content"> |
| 122 | 119 | ||
| 123 | 120 | ||
| 124 | 121 | ||
| 125 | 122 | ||
| 126 | 123 | ||
| 127 | 124 | ||
| @@ -151,17 +148,17 @@ | |||
| 151 | <dl class="class"> | 148 | <dl class="class"> |
| 152 | <dt id="eventmq.poller.Poller"> | 149 | <dt id="eventmq.poller.Poller"> |
| 153 | <em class="property">class </em><code class="descclassname">eventmq.poller.</code><code class="descname">Poller</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.poller.Poller" title="Permalink to this definition">¶</a></dt> | 150 | <em class="property">class </em><code class="descclassname">eventmq.poller.</code><code class="descname">Poller</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.poller.Poller" title="Permalink to this definition">¶</a></dt> |
| 154 | <dd><p><a class="reference external" href="http://pyzmq.readthedocs.io/en/v15.0.0/api/zmq.html#zmq.Poller" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Poller</span></code></a> based class.</p> | 151 | <dd><p><a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Poller" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Poller</span></code></a> based class.</p> |
| 155 | <dl class="method"> | 152 | <dl class="method"> |
| 156 | <dt id="eventmq.poller.Poller.__init__"> | 153 | <dt id="eventmq.poller.Poller.__init__"> |
| 157 | <code class="descname">__init__</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.poller.Poller.__init__" title="Permalink to this definition">¶</a></dt> | 154 | <code class="descname">__init__</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.poller.Poller.__init__" title="Permalink to this definition">¶</a></dt> |
| 158 | <dd><p>See <a class="reference external" href="http://pyzmq.readthedocs.io/en/v15.0.0/api/zmq.html#zmq.Poller" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Poller</span></code></a></p> | 155 | <dd><p>See <a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Poller" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Poller</span></code></a></p> |
| 159 | </dd></dl> | 156 | </dd></dl> |
| 160 | 157 | ||
| 161 | <dl class="method"> | 158 | <dl class="method"> |
| 162 | <dt id="eventmq.poller.Poller.poll"> | 159 | <dt id="eventmq.poller.Poller.poll"> |
| 163 | <code class="descname">poll</code><span class="sig-paren">(</span><em>timeout=1</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.poller.Poller.poll" title="Permalink to this definition">¶</a></dt> | 160 | <code class="descname">poll</code><span class="sig-paren">(</span><em>timeout=1</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.poller.Poller.poll" title="Permalink to this definition">¶</a></dt> |
| 164 | <dd><p>Calling <a class="reference external" href="http://pyzmq.readthedocs.io/en/v15.0.0/api/zmq.html#zmq.Poller.poll" title="(in PyZMQ v15.0.0)"><code class="xref py py-meth docutils literal"><span class="pre">zmq.Poller.poll()</span></code></a> directly returns a tuple set. This | 161 | <dd><p>Calling <a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Poller.poll" title="(in PyZMQ v15.0.0)"><code class="xref py py-meth docutils literal"><span class="pre">zmq.Poller.poll()</span></code></a> directly returns a tuple set. This |
| 165 | method typecasts to a dictionary for convience using the socket object | 162 | method typecasts to a dictionary for convience using the socket object |
| 166 | as the key. If a socket doesn’t appear in the returned dictionary then | 163 | as the key. If a socket doesn’t appear in the returned dictionary then |
| 167 | no events happened.</p> | 164 | no events happened.</p> |
| @@ -169,7 +166,7 @@ no events happened.</p> | |||
| 169 | <col class="field-name" /> | 166 | <col class="field-name" /> |
| 170 | <col class="field-body" /> | 167 | <col class="field-body" /> |
| 171 | <tbody valign="top"> | 168 | <tbody valign="top"> |
| 172 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>) – How long should poller wait for before iterating | 169 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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 long should poller wait for before iterating |
| 173 | the next loop.</td> | 170 | the next loop.</td> |
| 174 | </tr> | 171 | </tr> |
| 175 | </tbody> | 172 | </tbody> |
| @@ -189,8 +186,8 @@ the next loop.</td> | |||
| 189 | <col class="field-body" /> | 186 | <col class="field-body" /> |
| 190 | <tbody valign="top"> | 187 | <tbody valign="top"> |
| 191 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | 188 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| 192 | <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>) – The socket object to register</li> | 189 | <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>) – The socket object to register</li> |
| 193 | <li><strong>flags</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – <code class="xref py py-attr docutils literal"><span class="pre">POLLIN</span></code>, <code class="xref py py-attr docutils literal"><span class="pre">POLLOUT</span></code>, or | 190 | <li><strong>flags</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – <code class="xref py py-attr docutils literal"><span class="pre">POLLIN</span></code>, <code class="xref py py-attr docutils literal"><span class="pre">POLLOUT</span></code>, or |
| 194 | <code class="xref py py-attr docutils literal"><span class="pre">POLLIN`|:attr:`POLLOUT</span></code> for both. If undefined the | 191 | <code class="xref py py-attr docutils literal"><span class="pre">POLLIN`|:attr:`POLLOUT</span></code> for both. If undefined the |
| 195 | socket remains unregistered.</li> | 192 | socket remains unregistered.</li> |
| 196 | </ul> | 193 | </ul> |
| @@ -208,7 +205,7 @@ socket remains unregistered.</li> | |||
| 208 | <col class="field-name" /> | 205 | <col class="field-name" /> |
| 209 | <col class="field-body" /> | 206 | <col class="field-body" /> |
| 210 | <tbody valign="top"> | 207 | <tbody valign="top"> |
| 211 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>) – The socket object to registering</td> | 208 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><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>) – The socket object to registering</td> |
| 212 | </tr> | 209 | </tr> |
| 213 | </tbody> | 210 | </tbody> |
| 214 | </table> | 211 | </table> |