diff options
Diffstat (limited to 'utils/classes.html')
| -rw-r--r-- | utils/classes.html | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/utils/classes.html b/utils/classes.html index 7e3ebcd..15ed5e6 100644 --- a/utils/classes.html +++ b/utils/classes.html | |||
| @@ -93,7 +93,7 @@ | |||
| 93 | <li class="toctree-l2 current"><a class="reference internal" href="../utils.html"><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a><ul class="current"> | 93 | <li class="toctree-l2 current"><a class="reference internal" href="../utils.html"><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a><ul class="current"> |
| 94 | <li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> | 94 | <li class="toctree-l3 current"><a class="current reference internal" href=""><code class="docutils literal"><span class="pre">classes</span></code> – Utility Classes</a></li> |
| 95 | <li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> – Message Utilities</a></li> | 95 | <li class="toctree-l3"><a class="reference internal" href="messages.html"><code class="docutils literal"><span class="pre">messages</span></code> – Message Utilities</a></li> |
| 96 | <li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">time</span></code> – Time Utilites</a></li> | 96 | <li class="toctree-l3"><a class="reference internal" href="timeutils.html"><code class="docutils literal"><span class="pre">timeutils</span></code> – Time Utilites</a></li> |
| 97 | </ul> | 97 | </ul> |
| 98 | </li> | 98 | </li> |
| 99 | </ul> | 99 | </ul> |
| @@ -169,21 +169,23 @@ | |||
| 169 | <dl class="method"> | 169 | <dl class="method"> |
| 170 | <dt id="eventmq.utils.classes.HeartbeatMixin.is_dead"> | 170 | <dt id="eventmq.utils.classes.HeartbeatMixin.is_dead"> |
| 171 | <code class="descname">is_dead</code><span class="sig-paren">(</span><em>now=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.HeartbeatMixin.is_dead" title="Permalink to this definition">¶</a></dt> | 171 | <code class="descname">is_dead</code><span class="sig-paren">(</span><em>now=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.classes.HeartbeatMixin.is_dead" title="Permalink to this definition">¶</a></dt> |
| 172 | <dd><p>Checks the counters for the heartbeats to find out if the thresholds | 172 | <dd><p>Checks the heartbeat counters to find out if the thresholds have been |
| 173 | have been met.</p> | 173 | met.</p> |
| 174 | <table class="docutils field-list" frame="void" rules="none"> | 174 | <table class="docutils field-list" frame="void" rules="none"> |
| 175 | <col class="field-name" /> | 175 | <col class="field-name" /> |
| 176 | <col class="field-body" /> | 176 | <col class="field-body" /> |
| 177 | <tbody valign="top"> | 177 | <tbody valign="top"> |
| 178 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>now</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#float" title="(in Python v2.7)"><em>float</em></a>) – The time to use to check if death has occurred. If</td> | 178 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>now</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#float" title="(in Python v2.7)"><em>float</em></a>) – The time to use to check if death has occurred. If |
| 179 | this value is None, then <code class="xref py py-func docutils literal"><span class="pre">utils.timeutils.monotonic()</span></code> | ||
| 180 | is used.</td> | ||
| 181 | </tr> | ||
| 182 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the connection to the peer has died, otherwise | ||
| 183 | False</td> | ||
| 184 | </tr> | ||
| 185 | <tr class="field-odd 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> | ||
| 179 | </tr> | 186 | </tr> |
| 180 | </tbody> | 187 | </tbody> |
| 181 | </table> | 188 | </table> |
| 182 | <p>:param this value is None, then <code class="xref py py-func docutils literal"><span class="pre">utils.timeutils.monotonic()</span></code> is used.:</p> | ||
| 183 | <dl class="docutils"> | ||
| 184 | <dt>Returns (bool) True if the connection to the peer has died, otherwise</dt> | ||
| 185 | <dd>False</dd> | ||
| 186 | </dl> | ||
| 187 | </dd></dl> | 189 | </dd></dl> |
| 188 | 190 | ||
| 189 | <dl class="method"> | 191 | <dl class="method"> |