Release 0.1.1

jackhftang · May 23, 2020 · a9b138a · a9b138a
1 parent 70dcc64
commit a9b138a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 35 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -105,8 +105,6 @@ <h1 class="title">taskqueue</h1>
   taskQueue: TaskQueue"><wbr />No<wbr />Task<wbr />Error<span class="attachedType"></span></a></li>
   <li><a class="reference" href="#Action"
     title="Action = proc () {.gcsafe.}"><wbr />Action<span class="attachedType"></span></a></li>
-  <li><a class="reference" href="#CancelableAction"
-    title="CancelableAction = proc (): bool {.gcsafe.}"><wbr />Cancelable<wbr />Action<span class="attachedType"></span></a></li>
   <li><a class="reference" href="#TaskQueue"
     title="TaskQueue = ref object
   active: bool
@@ -124,12 +122,6 @@ <h1 class="title">taskqueue</h1>
     title="newTaskQueue(): TaskQueue"><wbr />new<wbr />Task<wbr />Queue<span class="attachedType">TaskQueue</span></a></li>
   <li><a class="reference" href="#runAt%2CTaskQueue%2CTimestamp%2CAction"
     title="runAt(q: TaskQueue; time: Timestamp; action: Action)"><wbr />run<wbr />At<span class="attachedType">TaskQueue</span></a></li>
-  <li><a class="reference" href="#runEvery%2CTaskQueue%2CTimestamp%2CTimespan%2CCancelableAction"
-    title="runEvery(q: TaskQueue; firstTime: Timestamp; interval: Timespan;
-         action: CancelableAction)"><wbr />run<wbr />Every<span class="attachedType">TaskQueue</span></a></li>
-  <li><a class="reference" href="#runAround%2CTaskQueue%2CTimestamp%2CTimespan%2CCancelableAction"
-    title="runAround(q: TaskQueue; firstTime: Timestamp; timespan: Timespan;
-          action: CancelableAction)"><wbr />run<wbr />Around<span class="attachedType">TaskQueue</span></a></li>
   <li><a class="reference" href="#len%2CTaskQueue"
     title="len(q: TaskQueue): int"><wbr />len<span class="attachedType">TaskQueue</span></a></li>
   <li><a class="reference" href="#nextTaskTime%2CTaskQueue"
@@ -183,13 +175,6 @@ <h1><a class="toc-backref" href="#7">Types</a></h1>
 
 
 
-</dd>
-<a id="CancelableAction"></a>
-<dt><pre><a href="taskqueue.html#CancelableAction"><span class="Identifier">CancelableAction</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">gcsafe</span></span><span class="Other">.}</span></span></pre></dt>
-<dd>
-
-
-
 </dd>
 <a id="TaskQueue"></a>
 <dt><pre><a href="taskqueue.html#TaskQueue"><span class="Identifier">TaskQueue</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span>
@@ -227,22 +212,6 @@ <h1><a class="toc-backref" href="#12">Procs</a></h1>
 
 Schedule a task to run at <tt class="docutils literal"><span class="pre">time</span></tt>
 
-</dd>
-<a id="runEvery,TaskQueue,Timestamp,Timespan,CancelableAction"></a>
-<dt><pre><span class="Keyword">proc</span> <a href="#runEvery%2CTaskQueue%2CTimestamp%2CTimespan%2CCancelableAction"><span class="Identifier">runEvery</span></a><span class="Other">(</span><span class="Identifier">q</span><span class="Other">:</span> <a href="taskqueue.html#TaskQueue"><span class="Identifier">TaskQueue</span></a><span class="Other">;</span> <span class="Identifier">firstTime</span><span class="Other">:</span> <span class="Identifier">Timestamp</span><span class="Other">;</span> <span class="Identifier">interval</span><span class="Other">:</span> <span class="Identifier">Timespan</span><span class="Other">;</span>
-             <span class="Identifier">action</span><span class="Other">:</span> <a href="taskqueue.html#CancelableAction"><span class="Identifier">CancelableAction</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
-<dd>
-
-Process task at <tt class="docutils literal"><span class="pre">firstTime</span></tt> and then schedule the next one at <em>t</em> = <tt class="docutils literal"><span class="pre">firstTime</span></tt> + i * <tt class="docutils literal"><span class="pre">interval</span></tt> where i is the smallest <em>whole number</em> such that <em>t</em> is larger than current time.
-
-</dd>
-<a id="runAround,TaskQueue,Timestamp,Timespan,CancelableAction"></a>
-<dt><pre><span class="Keyword">proc</span> <a href="#runAround%2CTaskQueue%2CTimestamp%2CTimespan%2CCancelableAction"><span class="Identifier">runAround</span></a><span class="Other">(</span><span class="Identifier">q</span><span class="Other">:</span> <a href="taskqueue.html#TaskQueue"><span class="Identifier">TaskQueue</span></a><span class="Other">;</span> <span class="Identifier">firstTime</span><span class="Other">:</span> <span class="Identifier">Timestamp</span><span class="Other">;</span> <span class="Identifier">timespan</span><span class="Other">:</span> <span class="Identifier">Timespan</span><span class="Other">;</span>
-              <span class="Identifier">action</span><span class="Other">:</span> <a href="taskqueue.html#CancelableAction"><span class="Identifier">CancelableAction</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
-<dd>
-
-Process task at <tt class="docutils literal"><span class="pre">firstTime</span></tt> and then schedule the next one at <tt class="docutils literal"><span class="pre">timespan</span></tt> later than current time.
-
 </dd>
 <a id="len,TaskQueue"></a>
 <dt><pre><span class="Keyword">proc</span> <a href="#len%2CTaskQueue"><span class="Identifier">len</span></a><span class="Other">(</span><span class="Identifier">q</span><span class="Other">:</span> <a href="taskqueue.html#TaskQueue"><span class="Identifier">TaskQueue</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
@@ -310,15 +279,15 @@ <h1><a class="toc-backref" href="#18">Templates</a></h1>
 <dt><pre><span class="Keyword">template</span> <a href="#runEvery.t%2CTaskQueue%2CTimestamp%2CTimespan%2Cuntyped"><span class="Identifier">runEvery</span></a><span class="Other">(</span><span class="Identifier">q</span><span class="Other">:</span> <a href="taskqueue.html#TaskQueue"><span class="Identifier">TaskQueue</span></a><span class="Other">;</span> <span class="Identifier">firstTime</span><span class="Other">:</span> <span class="Identifier">Timestamp</span><span class="Other">;</span> <span class="Identifier">interval</span><span class="Other">:</span> <span class="Identifier">Timespan</span><span class="Other">;</span> <span class="Identifier">body</span><span class="Other">:</span> <span class="Identifier">untyped</span><span class="Other">)</span></pre></dt>
 <dd>
 
-Tempalate version of <tt class="docutils literal"><span class="pre">runEvery</span></tt>
+Process task at <tt class="docutils literal"><span class="pre">firstTime</span></tt> and then schedule the next one at <em>t</em> = <tt class="docutils literal"><span class="pre">firstTime</span></tt> + i * <tt class="docutils literal"><span class="pre">interval</span></tt> where i is the smallest <em>whole number</em> such that <em>t</em> is larger than current time.
 
 </dd>
 <a id="runAround.t,TaskQueue,Timestamp,Timespan,untyped"></a>
 <dt><pre><span class="Keyword">template</span> <a href="#runAround.t%2CTaskQueue%2CTimestamp%2CTimespan%2Cuntyped"><span class="Identifier">runAround</span></a><span class="Other">(</span><span class="Identifier">q</span><span class="Other">:</span> <a href="taskqueue.html#TaskQueue"><span class="Identifier">TaskQueue</span></a><span class="Other">;</span> <span class="Identifier">firstTime</span><span class="Other">:</span> <span class="Identifier">Timestamp</span><span class="Other">;</span> <span class="Identifier">timespan</span><span class="Other">:</span> <span class="Identifier">Timespan</span><span class="Other">;</span>
                   <span class="Identifier">body</span><span class="Other">:</span> <span class="Identifier">untyped</span><span class="Other">)</span></pre></dt>
 <dd>
 
-Template verion of <tt class="docutils literal"><span class="pre">runAround</span></tt>
+Process task at <tt class="docutils literal"><span class="pre">firstTime</span></tt> and then schedule the next one <tt class="docutils literal"><span class="pre">timespan</span></tt> later than current time.
 
 </dd>
 
@@ -331,7 +300,7 @@ <h1><a class="toc-backref" href="#18">Templates</a></h1>
       <div class="twelve-columns footer">
         <span class="nim-sprite"></span>
         <br/>
-        <small style="color: var(--hint);">Made with Nim. Generated: 2020-05-23 07:06:44 UTC</small>
+        <small style="color: var(--hint);">Made with Nim. Generated: 2020-05-23 08:54:32 UTC</small>
       </div>
     </div>
   </div>

diff --git a/taskqueue.nimble b/taskqueue.nimble
@@ -1,6 +1,6 @@
 # Package
 
-version       = "0.1.0"
+version       = "0.1.1"
 author        = "Jack Tang"
 description   = "High precision and high performance task scheduler"
 license       = "MIT"