aboutsummaryrefslogtreecommitdiffstats
path: root/receiver.html
diff options
context:
space:
mode:
Diffstat (limited to 'receiver.html')
-rw-r--r--receiver.html50
1 files changed, 25 insertions, 25 deletions
diff --git a/receiver.html b/receiver.html
index 0f45eba..8a5c973 100644
--- a/receiver.html
+++ b/receiver.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="router – Router" href="router.html"/> 35 <link rel="next" title="router – Router" href="router.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
@@ -92,7 +89,7 @@
92<li class="toctree-l2"><a class="reference internal" href="exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> &#8211; 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> &#8211; 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> &#8211; 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> &#8211; Job Manager</a></li>
94<li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> &#8211; Poller</a></li> 91<li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> &#8211; Poller</a></li>
95<li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</a></li> 92<li class="toctree-l2 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; 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> &#8211; 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> &#8211; 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> &#8211; 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> &#8211; Sender</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> &#8211; Utilities</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> &#8211; Utilities</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
@@ -155,19 +152,21 @@
155<dl class="attribute"> 152<dl class="attribute">
156<dt id="eventmq.receiver.Receiver.name"> 153<dt id="eventmq.receiver.Receiver.name">
157<code class="descname">name</code><a class="headerlink" href="#eventmq.receiver.Receiver.name" title="Permalink to this definition">¶</a></dt> 154<code class="descname">name</code><a class="headerlink" href="#eventmq.receiver.Receiver.name" title="Permalink to this definition">¶</a></dt>
158<dd><p><em>str</em> &#8211; Name of this socket</p> 155<dd><p><em>str</em></p>
156<p>Name of this socket</p>
159</dd></dl> 157</dd></dl>
160 158
161<dl class="attribute"> 159<dl class="attribute">
162<dt id="eventmq.receiver.Receiver.zcontext"> 160<dt id="eventmq.receiver.Receiver.zcontext">
163<code class="descname">zcontext</code><a class="headerlink" href="#eventmq.receiver.Receiver.zcontext" title="Permalink to this definition">¶</a></dt> 161<code class="descname">zcontext</code><a class="headerlink" href="#eventmq.receiver.Receiver.zcontext" title="Permalink to this definition">¶</a></dt>
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> &#8211; socket context</p> 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>
163<p>socket context</p>
165</dd></dl> 164</dd></dl>
166 165
167<dl class="attribute"> 166<dl class="attribute">
168<dt id="eventmq.receiver.Receiver.zsocket"> 167<dt id="eventmq.receiver.Receiver.zsocket">
169<code class="descname">zsocket</code><a class="headerlink" href="#eventmq.receiver.Receiver.zsocket" title="Permalink to this definition">¶</a></dt> 168<code class="descname">zsocket</code><a class="headerlink" href="#eventmq.receiver.Receiver.zsocket" title="Permalink to this definition">¶</a></dt>
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> 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>
171</dd></dl> 170</dd></dl>
172 171
173<dl class="method"> 172<dl class="method">
@@ -182,16 +181,17 @@
182<col class="field-body" /> 181<col class="field-body" />
183<tbody valign="top"> 182<tbody valign="top">
184<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 183<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
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>) &#8211; name of this socket. By default a uuid will be 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>) &#8211; name of this socket. By default a uuid will be
186generated</li> 185generated</li>
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>) &#8211; Context to use when buliding the 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>) &#8211; Context to use when buliding the
188socket</li> 187socket</li>
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>) &#8211; Should be one of <code class="xref py py-attr docutils literal"><span class="pre">zmq.REP</span></code> or 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>) &#8211; Should be one of <code class="xref py py-attr docutils literal"><span class="pre">zmq.REP</span></code> or
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> 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>
191</ul> 190</ul>
192</td> 191</td>
193</tr> 192</tr>
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> &#8211; when <cite>callable</cite> is not callable</p> 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> &#8211;
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,9 +206,10 @@ 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/2/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; 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/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; 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-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-exc docutils literal"><span class="pre">:class</span></code> &#8211;
212<cite>Exception</cite></td>
212</tr> 213</tr>
213</tbody> 214</tbody>
214</table> 215</table>
@@ -222,9 +223,10 @@ socket</li>
222<col class="field-name" /> 223<col class="field-name" />
223<col class="field-body" /> 224<col class="field-body" />
224<tbody valign="top"> 225<tbody valign="top">
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>) &#8211; Address to listen on as a connction string</td> 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>) &#8211; Address to listen on as a connction string</td>
226</tr> 227</tr>
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> 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> &#8211;
229<cite>Exception</cite></td>
228</tr> 230</tr>
229</tbody> 231</tbody>
230</table> 232</table>
@@ -238,13 +240,10 @@ socket</li>
238<col class="field-name" /> 240<col class="field-name" />
239<col class="field-body" /> 241<col class="field-body" />
240<tbody valign="top"> 242<tbody valign="top">
241<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils"> 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
242<dt>True if the receiver is ready to connect or listen, otherwise</dt> 244False</td>
243<dd>False</dd>
244</dl>
245</td>
246</tr> 245</tr>
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> 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>
248</tr> 247</tr>
249</tbody> 248</tbody>
250</table> 249</table>
@@ -258,9 +257,10 @@ socket</li>
258<col class="field-name" /> 257<col class="field-name" />
259<col class="field-body" /> 258<col class="field-body" />
260<tbody valign="top"> 259<tbody valign="top">
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>) &#8211; Address to disconnect from as a string</td> 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>) &#8211; Address to disconnect from as a string</td>
262</tr> 261</tr>
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> 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> &#8211;
263<cite>Exception</cite></td>
264</tr> 264</tr>
265</tbody> 265</tbody>
266</table> 266</table>
generated by cgit v1.2.1 (git 2.18.0) at 2026-01-12 04:56:42 +0000