diff options
Diffstat (limited to 'utils/timeutils.html')
| -rw-r--r-- | utils/timeutils.html | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/utils/timeutils.html b/utils/timeutils.html index 72b99ed..087322b 100644 --- a/utils/timeutils.html +++ b/utils/timeutils.html | |||
| @@ -150,6 +150,48 @@ | |||
| 150 | 150 | ||
| 151 | <span class="target" id="module-eventmq.utils.timeutils"></span><div class="section" id="timeutils-time-utilites"> | 151 | <span class="target" id="module-eventmq.utils.timeutils"></span><div class="section" id="timeutils-time-utilites"> |
| 152 | <h1><code class="xref py py-mod docutils literal"><span class="pre">timeutils</span></code> – Time Utilites<a class="headerlink" href="#timeutils-time-utilites" title="Permalink to this headline">¶</a></h1> | 152 | <h1><code class="xref py py-mod docutils literal"><span class="pre">timeutils</span></code> – Time Utilites<a class="headerlink" href="#timeutils-time-utilites" title="Permalink to this headline">¶</a></h1> |
| 153 | <dl class="class"> | ||
| 154 | <dt id="eventmq.utils.timeutils.IntervalIter"> | ||
| 155 | <em class="property">class </em><code class="descclassname">eventmq.utils.timeutils.</code><code class="descname">IntervalIter</code><span class="sig-paren">(</span><em>start_value</em>, <em>interval_secs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.timeutils.IntervalIter" title="Permalink to this definition">¶</a></dt> | ||
| 156 | <dd><p>represents an interval (in seconds) and it’s <cite>next()</cite> execution time</p> | ||
| 157 | <dl class="docutils"> | ||
| 158 | <dt>Usage:</dt> | ||
| 159 | <dd><p class="first"># interval of 5min using monotonic clock (assume it starts at 0 for the | ||
| 160 | # sake of the example) | ||
| 161 | interval = IntervalIter(monotonic, 300) | ||
| 162 | # Py2</p> | ||
| 163 | <p>interval.next() # 300 | ||
| 164 | interval.next() # 600</p> | ||
| 165 | <p class="last"># Py3 | ||
| 166 | next(interval) # 300 | ||
| 167 | next(interval) # 600</p> | ||
| 168 | </dd> | ||
| 169 | </dl> | ||
| 170 | <dl class="method"> | ||
| 171 | <dt id="eventmq.utils.timeutils.IntervalIter.__init__"> | ||
| 172 | <code class="descname">__init__</code><span class="sig-paren">(</span><em>start_value</em>, <em>interval_secs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.timeutils.IntervalIter.__init__" title="Permalink to this definition">¶</a></dt> | ||
| 173 | <dd><table class="docutils field-list" frame="void" rules="none"> | ||
| 174 | <col class="field-name" /> | ||
| 175 | <col class="field-body" /> | ||
| 176 | <tbody valign="top"> | ||
| 177 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> | ||
| 178 | <li><strong>start_value</strong> (<em>numeric</em>) – via <a class="reference internal" href="#eventmq.utils.timeutils.monotonic" title="eventmq.utils.timeutils.monotonic"><code class="xref py py-func docutils literal"><span class="pre">monotonic()</span></code></a> or <a class="reference internal" href="#eventmq.utils.timeutils.timestamp" title="eventmq.utils.timeutils.timestamp"><code class="xref py py-func docutils literal"><span class="pre">timestamp()</span></code></a></li> | ||
| 179 | <li><strong>interval_secs</strong> (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li> | ||
| 180 | </ul> | ||
| 181 | </td> | ||
| 182 | </tr> | ||
| 183 | </tbody> | ||
| 184 | </table> | ||
| 185 | </dd></dl> | ||
| 186 | |||
| 187 | <dl class="attribute"> | ||
| 188 | <dt id="eventmq.utils.timeutils.IntervalIter.__weakref__"> | ||
| 189 | <code class="descname">__weakref__</code><a class="headerlink" href="#eventmq.utils.timeutils.IntervalIter.__weakref__" title="Permalink to this definition">¶</a></dt> | ||
| 190 | <dd><p>list of weak references to the object (if defined)</p> | ||
| 191 | </dd></dl> | ||
| 192 | |||
| 193 | </dd></dl> | ||
| 194 | |||
| 153 | <dl class="function"> | 195 | <dl class="function"> |
| 154 | <dt id="eventmq.utils.timeutils.monotonic"> | 196 | <dt id="eventmq.utils.timeutils.monotonic"> |
| 155 | <code class="descclassname">eventmq.utils.timeutils.</code><code class="descname">monotonic</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.timeutils.monotonic" title="Permalink to this definition">¶</a></dt> | 197 | <code class="descclassname">eventmq.utils.timeutils.</code><code class="descname">monotonic</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.utils.timeutils.monotonic" title="Permalink to this definition">¶</a></dt> |