diff options
| author | jason | 2016-10-04 11:58:36 -0600 |
|---|---|---|
| committer | jason | 2016-10-04 11:58:36 -0600 |
| commit | 02002cd2f9b3521f803e992dd4b6cabc9f0aea5d (patch) | |
| tree | e928f16315148cbbf22326f6e37372baa3e8ffe1 /receiver.html | |
| parent | 41b2025fe4e22689599ae1c2d7feb91b2e978d7e (diff) | |
| download | eventmq-02002cd2f9b3521f803e992dd4b6cabc9f0aea5d.tar.gz eventmq-02002cd2f9b3521f803e992dd4b6cabc9f0aea5d.zip | |
docs updates
Diffstat (limited to 'receiver.html')
| -rw-r--r-- | receiver.html | 34 |
1 files changed, 20 insertions, 14 deletions
diff --git a/receiver.html b/receiver.html index 664c268..0f45eba 100644 --- 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.6.2 | 67 | 0.2.6.3 |
| 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 | ||
| @@ -158,13 +161,13 @@ | |||
| 158 | <dl class="attribute"> | 161 | <dl class="attribute"> |
| 159 | <dt id="eventmq.receiver.Receiver.zcontext"> | 162 | <dt id="eventmq.receiver.Receiver.zcontext"> |
| 160 | <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> |
| 161 | <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> – socket context</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> |
| 162 | </dd></dl> | 165 | </dd></dl> |
| 163 | 166 | ||
| 164 | <dl class="attribute"> | 167 | <dl class="attribute"> |
| 165 | <dt id="eventmq.receiver.Receiver.zsocket"> | 168 | <dt id="eventmq.receiver.Receiver.zsocket"> |
| 166 | <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> |
| 167 | <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> |
| 168 | </dd></dl> | 171 | </dd></dl> |
| 169 | 172 | ||
| 170 | <dl class="method"> | 173 | <dl class="method"> |
| @@ -179,11 +182,11 @@ | |||
| 179 | <col class="field-body" /> | 182 | <col class="field-body" /> |
| 180 | <tbody valign="top"> | 183 | <tbody valign="top"> |
| 181 | <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"> |
| 182 | <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 |
| 183 | generated</li> | 186 | generated</li> |
| 184 | <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 |
| 185 | socket</li> | 188 | socket</li> |
| 186 | <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 |
| 187 | <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> |
| 188 | </ul> | 191 | </ul> |
| 189 | </td> | 192 | </td> |
| @@ -203,7 +206,7 @@ socket</li> | |||
| 203 | <col class="field-name" /> | 206 | <col class="field-name" /> |
| 204 | <col class="field-body" /> | 207 | <col class="field-body" /> |
| 205 | <tbody valign="top"> | 208 | <tbody valign="top"> |
| 206 | <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> |
| 207 | </tr> | 210 | </tr> |
| 208 | <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> | 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> |
| 209 | </tr> | 212 | </tr> |
| @@ -219,7 +222,7 @@ socket</li> | |||
| 219 | <col class="field-name" /> | 222 | <col class="field-name" /> |
| 220 | <col class="field-body" /> | 223 | <col class="field-body" /> |
| 221 | <tbody valign="top"> | 224 | <tbody valign="top"> |
| 222 | <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> |
| 223 | </tr> | 226 | </tr> |
| 224 | <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> | 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> |
| 225 | </tr> | 228 | </tr> |
| @@ -235,10 +238,13 @@ socket</li> | |||
| 235 | <col class="field-name" /> | 238 | <col class="field-name" /> |
| 236 | <col class="field-body" /> | 239 | <col class="field-body" /> |
| 237 | <tbody valign="top"> | 240 | <tbody valign="top"> |
| 238 | <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"> |
| 239 | False</td> | 242 | <dt>True if the receiver is ready to connect or listen, otherwise</dt> |
| 243 | <dd>False</dd> | ||
| 244 | </dl> | ||
| 245 | </td> | ||
| 240 | </tr> | 246 | </tr> |
| 241 | <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> |
| 242 | </tr> | 248 | </tr> |
| 243 | </tbody> | 249 | </tbody> |
| 244 | </table> | 250 | </table> |
| @@ -252,7 +258,7 @@ False</td> | |||
| 252 | <col class="field-name" /> | 258 | <col class="field-name" /> |
| 253 | <col class="field-body" /> | 259 | <col class="field-body" /> |
| 254 | <tbody valign="top"> | 260 | <tbody valign="top"> |
| 255 | <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> |
| 256 | </tr> | 262 | </tr> |
| 257 | <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 | <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> |
| 258 | </tr> | 264 | </tr> |