aboutsummaryrefslogtreecommitdiffstats
path: root/receiver.html
diff options
context:
space:
mode:
Diffstat (limited to 'receiver.html')
-rwxr-xr-xreceiver.html73
1 files changed, 51 insertions, 22 deletions
diff --git a/receiver.html b/receiver.html
index 7e5f826..f755d60 100755
--- a/receiver.html
+++ b/receiver.html
@@ -13,6 +13,8 @@
13 13
14 14
15 15
16
17
16 18
17 19
18 20
@@ -45,6 +47,7 @@
45 47
46<body class="wy-body-for-nav" role="document"> 48<body class="wy-body-for-nav" role="document">
47 49
50
48 <div class="wy-grid-for-nav"> 51 <div class="wy-grid-for-nav">
49 52
50 53
@@ -64,7 +67,7 @@
64 67
65 68
66 <div class="version"> 69 <div class="version">
67 0.3.3 70 0.3.6
68 </div> 71 </div>
69 72
70 73
@@ -85,7 +88,10 @@
85 88
86 89
87 90
88 <ul class="current"> 91
92
93
94 <ul class="current">
89<li class="toctree-l1"><a class="reference internal" href="using.html">Using EventMQ</a></li> 95<li class="toctree-l1"><a class="reference internal" href="using.html">Using EventMQ</a></li>
90<li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current"> 96<li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current">
91<li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a></li> 97<li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> &#8211; Client Utilities</a></li>
@@ -111,8 +117,10 @@
111 117
112 118
113 <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> 119 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
114 <i data-toggle="wy-nav-top" class="fa fa-bars"></i> 120
115 <a href="index.html">EventMQ</a> 121 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
122 <a href="index.html">EventMQ</a>
123
116 </nav> 124 </nav>
117 125
118 126
@@ -121,25 +129,42 @@
121 <div class="rst-content"> 129 <div class="rst-content">
122 130
123 131
124 132
133
134
135
136
137
138
139
140
141
142
125 143
126 144
127 145
128<div role="navigation" aria-label="breadcrumbs navigation"> 146<div role="navigation" aria-label="breadcrumbs navigation">
147
129 <ul class="wy-breadcrumbs"> 148 <ul class="wy-breadcrumbs">
130 <li><a href="index.html">Docs</a> &raquo;</li> 149
131 150 <li><a href="index.html">Docs</a> &raquo;</li>
151
132 <li><a href="api.html">API Documentation</a> &raquo;</li> 152 <li><a href="api.html">API Documentation</a> &raquo;</li>
133 153
134 <li><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</li> 154 <li><code class="docutils literal"><span class="pre">receiver</span></code> &#8211; Receiver</li>
155
156
135 <li class="wy-breadcrumbs-aside"> 157 <li class="wy-breadcrumbs-aside">
136 158
137 159
138 <a href="_sources/receiver.rst.txt" rel="nofollow"> View page source</a> 160 <a href="_sources/receiver.rst.txt" rel="nofollow"> View page source</a>
139 161
140 162
141 </li> 163 </li>
164
142 </ul> 165 </ul>
166
167
143 <hr/> 168 <hr/>
144</div> 169</div>
145 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> 170 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
@@ -182,7 +207,7 @@
182<col class="field-body" /> 207<col class="field-body" />
183<tbody valign="top"> 208<tbody valign="top">
184<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 209<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 210<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; name of this socket. By default a uuid will be
186generated</li> 211generated</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 212<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
188socket</li> 213socket</li>
@@ -191,7 +216,7 @@ socket</li>
191</ul> 216</ul>
192</td> 217</td>
193</tr> 218</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> 219<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.7)"><code class="xref py py-class docutils literal"><span class="pre">TypeError</span></code></a> &#8211; when <cite>callable</cite> is not callable</p>
195</td> 220</td>
196</tr> 221</tr>
197</tbody> 222</tbody>
@@ -206,9 +231,9 @@ socket</li>
206<col class="field-name" /> 231<col class="field-name" />
207<col class="field-body" /> 232<col class="field-body" />
208<tbody valign="top"> 233<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> 234<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/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; Address to connect to as a connection string</td>
210</tr> 235</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> 236<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.7)"><code class="xref py py-class docutils literal"><span class="pre">Exception</span></code></a></td>
212</tr> 237</tr>
213</tbody> 238</tbody>
214</table> 239</table>
@@ -222,9 +247,9 @@ socket</li>
222<col class="field-name" /> 247<col class="field-name" />
223<col class="field-body" /> 248<col class="field-body" />
224<tbody valign="top"> 249<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> 250<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/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; Address to listen on as a connction string</td>
226</tr> 251</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> 252<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.7)"><code class="xref py py-class docutils literal"><span class="pre">Exception</span></code></a></td>
228</tr> 253</tr>
229</tbody> 254</tbody>
230</table> 255</table>
@@ -244,7 +269,7 @@ socket</li>
244</dl> 269</dl>
245</td> 270</td>
246</tr> 271</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> 272<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/3/library/functions.html#bool" title="(in Python v3.7)">bool</a></td>
248</tr> 273</tr>
249</tbody> 274</tbody>
250</table> 275</table>
@@ -258,9 +283,9 @@ socket</li>
258<col class="field-name" /> 283<col class="field-name" />
259<col class="field-body" /> 284<col class="field-body" />
260<tbody valign="top"> 285<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> 286<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/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) &#8211; Address to disconnect from as a string</td>
262</tr> 287</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> 288<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.7)"><code class="xref py py-class docutils literal"><span class="pre">Exception</span></code></a></td>
264</tr> 289</tr>
265</tbody> 290</tbody>
266</table> 291</table>
@@ -272,15 +297,18 @@ socket</li>
272 297
273 298
274 </div> 299 </div>
300 <div class="articleComments">
301
302 </div>
275 </div> 303 </div>
276 <footer> 304 <footer>
277 305
278 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 306 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
279 307
280 <a href="router.html" class="btn btn-neutral float-right" title="router – Router" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> 308 <a href="router.html" class="btn btn-neutral float-right" title="router – Router" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
281 309
282 310
283 <a href="poller.html" class="btn btn-neutral" title="poller – Poller" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> 311 <a href="poller.html" class="btn btn-neutral" title="poller – Poller" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
284 312
285 </div> 313 </div>
286 314
@@ -314,7 +342,8 @@ socket</li>
314 VERSION:'0', 342 VERSION:'0',
315 COLLAPSE_INDEX:false, 343 COLLAPSE_INDEX:false,
316 FILE_SUFFIX:'.html', 344 FILE_SUFFIX:'.html',
317 HAS_SOURCE: true 345 HAS_SOURCE: true,
346 SOURCELINK_SUFFIX: '.txt'
318 }; 347 };
319 </script> 348 </script>
320 <script type="text/javascript" src="_static/jquery.js"></script> 349 <script type="text/javascript" src="_static/jquery.js"></script>