diff options
Diffstat (limited to 'receiver.html')
| -rwxr-xr-x[-rw-r--r--] | receiver.html | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/receiver.html b/receiver.html index 6e13f51..0a1db1d 100644..100755 --- a/receiver.html +++ b/receiver.html | |||
| @@ -30,6 +30,9 @@ | |||
| 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"/> | ||
| 33 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> | 36 | <link rel="top" title="EventMQ 0 documentation" href="index.html"/> |
| 34 | <link rel="up" title="API Documentation" href="api.html"/> | 37 | <link rel="up" title="API Documentation" href="api.html"/> |
| 35 | <link rel="next" title="router – Router" href="router.html"/> | 38 | <link rel="next" title="router – Router" href="router.html"/> |
| @@ -61,7 +64,7 @@ | |||
| 61 | 64 | ||
| 62 | 65 | ||
| 63 | <div class="version"> | 66 | <div class="version"> |
| 64 | 0.2.7.1 | 67 | 0.3-rc8 |
| 65 | </div> | 68 | </div> |
| 66 | 69 | ||
| 67 | 70 | ||
| @@ -89,7 +92,7 @@ | |||
| 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> | 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> |
| 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> | 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> |
| 91 | <li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> – Poller</a></li> | 94 | <li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> – Poller</a></li> |
| 92 | <li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li> | 95 | <li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</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> | 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> |
| 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> | 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> |
| 95 | <li class="toctree-l2"><a class="reference internal" href="utils/index.html"><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a></li> | 98 | <li class="toctree-l2"><a class="reference internal" href="utils/index.html"><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a></li> |
| @@ -118,7 +121,7 @@ | |||
| 118 | <div class="rst-content"> | 121 | <div class="rst-content"> |
| 119 | 122 | ||
| 120 | 123 | ||
| 121 | 124 | ||
| 122 | 125 | ||
| 123 | 126 | ||
| 124 | 127 | ||
| @@ -132,7 +135,7 @@ | |||
| 132 | <li class="wy-breadcrumbs-aside"> | 135 | <li class="wy-breadcrumbs-aside"> |
| 133 | 136 | ||
| 134 | 137 | ||
| 135 | <a href="_sources/receiver.txt" rel="nofollow"> View page source</a> | 138 | <a href="_sources/receiver.rst.txt" rel="nofollow"> View page source</a> |
| 136 | 139 | ||
| 137 | 140 | ||
| 138 | </li> | 141 | </li> |
| @@ -152,21 +155,19 @@ | |||
| 152 | <dl class="attribute"> | 155 | <dl class="attribute"> |
| 153 | <dt id="eventmq.receiver.Receiver.name"> | 156 | <dt id="eventmq.receiver.Receiver.name"> |
| 154 | <code class="descname">name</code><a class="headerlink" href="#eventmq.receiver.Receiver.name" title="Permalink to this definition">¶</a></dt> | 157 | <code class="descname">name</code><a class="headerlink" href="#eventmq.receiver.Receiver.name" title="Permalink to this definition">¶</a></dt> |
| 155 | <dd><p><em>str</em></p> | 158 | <dd><p><em>str</em> – Name of this socket</p> |
| 156 | <p>Name of this socket</p> | ||
| 157 | </dd></dl> | 159 | </dd></dl> |
| 158 | 160 | ||
| 159 | <dl class="attribute"> | 161 | <dl class="attribute"> |
| 160 | <dt id="eventmq.receiver.Receiver.zcontext"> | 162 | <dt id="eventmq.receiver.Receiver.zcontext"> |
| 161 | <code class="descname">zcontext</code><a class="headerlink" href="#eventmq.receiver.Receiver.zcontext" title="Permalink to this definition">¶</a></dt> | 163 | <code class="descname">zcontext</code><a class="headerlink" href="#eventmq.receiver.Receiver.zcontext" title="Permalink to this definition">¶</a></dt> |
| 162 | <dd><p><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></p> | 164 | <dd><p><a class="reference external" href="http://pyzmq.readthedocs.io/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> – socket context</p> |
| 163 | <p>socket context</p> | ||
| 164 | </dd></dl> | 165 | </dd></dl> |
| 165 | 166 | ||
| 166 | <dl class="attribute"> | 167 | <dl class="attribute"> |
| 167 | <dt id="eventmq.receiver.Receiver.zsocket"> | 168 | <dt id="eventmq.receiver.Receiver.zsocket"> |
| 168 | <code class="descname">zsocket</code><a class="headerlink" href="#eventmq.receiver.Receiver.zsocket" title="Permalink to this definition">¶</a></dt> | 169 | <code class="descname">zsocket</code><a class="headerlink" href="#eventmq.receiver.Receiver.zsocket" title="Permalink to this definition">¶</a></dt> |
| 169 | <dd><p><a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Socket" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Socket</span></code></a></p> | 170 | <dd><p><a class="reference external" href="http://pyzmq.readthedocs.io/en/v15.0.0/api/zmq.html#zmq.Socket" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Socket</span></code></a></p> |
| 170 | </dd></dl> | 171 | </dd></dl> |
| 171 | 172 | ||
| 172 | <dl class="method"> | 173 | <dl class="method"> |
| @@ -181,17 +182,16 @@ | |||
| 181 | <col class="field-body" /> | 182 | <col class="field-body" /> |
| 182 | <tbody valign="top"> | 183 | <tbody valign="top"> |
| 183 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> | 184 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
| 184 | <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 | 185 | <li><strong>name</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 this socket. By default a uuid will be |
| 185 | generated</li> | 186 | generated</li> |
| 186 | <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 | 187 | <li><strong>context</strong> (<a class="reference external" href="http://pyzmq.readthedocs.io/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 |
| 187 | socket</li> | 188 | socket</li> |
| 188 | <li><strong>socket</strong> (<a class="reference external" href="http://pyzmq.readthedocs.org/en/v15.0.0/api/zmq.html#zmq.Socket" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Socket</span></code></a>) – Should be one of <code class="xref py py-attr docutils literal"><span class="pre">zmq.REP</span></code> or | 189 | <li><strong>socket</strong> (<a class="reference external" href="http://pyzmq.readthedocs.io/en/v15.0.0/api/zmq.html#zmq.Socket" title="(in PyZMQ v15.0.0)"><code class="xref py py-class docutils literal"><span class="pre">zmq.Socket</span></code></a>) – Should be one of <code class="xref py py-attr docutils literal"><span class="pre">zmq.REP</span></code> or |
| 189 | <code class="xref py py-attr docutils literal"><span class="pre">zmq.ROUTER</span></code>. By default a <cite>ROUTER</cite> is used</li> | 190 | <code class="xref py py-attr docutils literal"><span class="pre">zmq.ROUTER</span></code>. By default a <cite>ROUTER</cite> is used</li> |
| 190 | </ul> | 191 | </ul> |
| 191 | </td> | 192 | </td> |
| 192 | </tr> | 193 | </tr> |
| 193 | <tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><code class="xref py py-exc docutils literal"><span class="pre">:class</span></code> – | 194 | <tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">TypeError</span></code> – when <cite>callable</cite> is not callable</p> |
| 194 | <cite>TypeError</cite>: when <cite>callable</cite> is not callable</p> | ||
| 195 | </td> | 195 | </td> |
| 196 | </tr> | 196 | </tr> |
| 197 | </tbody> | 197 | </tbody> |
| @@ -206,10 +206,9 @@ socket</li> | |||
| 206 | <col class="field-name" /> | 206 | <col class="field-name" /> |
| 207 | <col class="field-body" /> | 207 | <col class="field-body" /> |
| 208 | <tbody valign="top"> | 208 | <tbody valign="top"> |
| 209 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Address to connect to as a connection string</td> | 209 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Address to connect to as a connection string</td> |
| 210 | </tr> | 210 | </tr> |
| 211 | <tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal"><span class="pre">:class</span></code> – | 211 | <tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">Exception</span></code></td> |
| 212 | <cite>Exception</cite></td> | ||
| 213 | </tr> | 212 | </tr> |
| 214 | </tbody> | 213 | </tbody> |
| 215 | </table> | 214 | </table> |
| @@ -223,10 +222,9 @@ socket</li> | |||
| 223 | <col class="field-name" /> | 222 | <col class="field-name" /> |
| 224 | <col class="field-body" /> | 223 | <col class="field-body" /> |
| 225 | <tbody valign="top"> | 224 | <tbody valign="top"> |
| 226 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Address to listen on as a connction string</td> | 225 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Address to listen on as a connction string</td> |
| 227 | </tr> | 226 | </tr> |
| 228 | <tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal"><span class="pre">:class</span></code> – | 227 | <tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">Exception</span></code></td> |
| 229 | <cite>Exception</cite></td> | ||
| 230 | </tr> | 228 | </tr> |
| 231 | </tbody> | 229 | </tbody> |
| 232 | </table> | 230 | </table> |
| @@ -240,10 +238,13 @@ socket</li> | |||
| 240 | <col class="field-name" /> | 238 | <col class="field-name" /> |
| 241 | <col class="field-body" /> | 239 | <col class="field-body" /> |
| 242 | <tbody valign="top"> | 240 | <tbody valign="top"> |
| 243 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the receiver is ready to connect or listen, otherwise | 241 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> |
| 244 | False</td> | 242 | <dt>True if the receiver is ready to connect or listen, otherwise</dt> |
| 243 | <dd>False</dd> | ||
| 244 | </dl> | ||
| 245 | </td> | ||
| 245 | </tr> | 246 | </tr> |
| 246 | <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a></td> | 247 | <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td> |
| 247 | </tr> | 248 | </tr> |
| 248 | </tbody> | 249 | </tbody> |
| 249 | </table> | 250 | </table> |
| @@ -257,10 +258,9 @@ False</td> | |||
| 257 | <col class="field-name" /> | 258 | <col class="field-name" /> |
| 258 | <col class="field-body" /> | 259 | <col class="field-body" /> |
| 259 | <tbody valign="top"> | 260 | <tbody valign="top"> |
| 260 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Address to disconnect from as a string</td> | 261 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addr</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) – Address to disconnect from as a string</td> |
| 261 | </tr> | 262 | </tr> |
| 262 | <tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal"><span class="pre">:class</span></code> – | 263 | <tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-class docutils literal"><span class="pre">Exception</span></code></td> |
| 263 | <cite>Exception</cite></td> | ||
| 264 | </tr> | 264 | </tr> |
| 265 | </tbody> | 265 | </tbody> |
| 266 | </table> | 266 | </table> |