aboutsummaryrefslogtreecommitdiffstats
path: root/poller.html
diff options
context:
space:
mode:
Diffstat (limited to 'poller.html')
-rwxr-xr-xpoller.html63
1 files changed, 46 insertions, 17 deletions
diff --git a/poller.html b/poller.html
index 1538bd8..ea5f3bf 100755
--- a/poller.html
+++ b/poller.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">poller</span></code> &#8211; Poller</li> 154 <li><code class="docutils literal"><span class="pre">poller</span></code> &#8211; Poller</li>
155
156
135 <li class="wy-breadcrumbs-aside"> 157 <li class="wy-breadcrumbs-aside">
136 158
137 159
138 <a href="_sources/poller.rst.txt" rel="nofollow"> View page source</a> 160 <a href="_sources/poller.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">
@@ -169,7 +194,7 @@ no events happened.</p>
169<col class="field-name" /> 194<col class="field-name" />
170<col class="field-body" /> 195<col class="field-body" />
171<tbody valign="top"> 196<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>) &#8211; How long should poller wait for before iterating 197<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/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) &#8211; How long should poller wait for before iterating
173the next loop.</td> 198the next loop.</td>
174</tr> 199</tr>
175</tbody> 200</tbody>
@@ -189,8 +214,8 @@ the next loop.</td>
189<col class="field-body" /> 214<col class="field-body" />
190<tbody valign="top"> 215<tbody valign="top">
191<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 216<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>) &#8211; The socket object to register</li> 217<li><strong>socket</strong> (<a class="reference external" href="https://docs.python.org/3/library/socket.html#module-socket" title="(in Python v3.7)"><em>socket</em></a>) &#8211; 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>) &#8211; <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 218<li><strong>flags</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) &#8211; <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 219<code class="xref py py-attr docutils literal"><span class="pre">POLLIN`|:attr:`POLLOUT</span></code> for both. If undefined the
195socket remains unregistered.</li> 220socket remains unregistered.</li>
196</ul> 221</ul>
@@ -208,7 +233,7 @@ socket remains unregistered.</li>
208<col class="field-name" /> 233<col class="field-name" />
209<col class="field-body" /> 234<col class="field-body" />
210<tbody valign="top"> 235<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>) &#8211; The socket object to registering</td> 236<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/3/library/socket.html#module-socket" title="(in Python v3.7)"><em>socket</em></a>) &#8211; The socket object to registering</td>
212</tr> 237</tr>
213</tbody> 238</tbody>
214</table> 239</table>
@@ -220,15 +245,18 @@ socket remains unregistered.</li>
220 245
221 246
222 </div> 247 </div>
248 <div class="articleComments">
249
250 </div>
223 </div> 251 </div>
224 <footer> 252 <footer>
225 253
226 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> 254 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
227 255
228 <a href="receiver.html" class="btn btn-neutral float-right" title="receiver – Receiver" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> 256 <a href="receiver.html" class="btn btn-neutral float-right" title="receiver – Receiver" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
229 257
230 258
231 <a href="jobmanager.html" class="btn btn-neutral" title="jobmanager – Job Manager" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> 259 <a href="jobmanager.html" class="btn btn-neutral" title="jobmanager – Job Manager" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
232 260
233 </div> 261 </div>
234 262
@@ -262,7 +290,8 @@ socket remains unregistered.</li>
262 VERSION:'0', 290 VERSION:'0',
263 COLLAPSE_INDEX:false, 291 COLLAPSE_INDEX:false,
264 FILE_SUFFIX:'.html', 292 FILE_SUFFIX:'.html',
265 HAS_SOURCE: true 293 HAS_SOURCE: true,
294 SOURCELINK_SUFFIX: '.txt'
266 }; 295 };
267 </script> 296 </script>
268 <script type="text/javascript" src="_static/jquery.js"></script> 297 <script type="text/javascript" src="_static/jquery.js"></script>