Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ahmad88me committed Jan 25, 2025
1 parent 6a64f57 commit cbad273
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,10 @@ <h3>Quick Start<a class="headerlink" href="#quick-start" title="Permalink to thi
<h3>Methods<a class="headerlink" href="#methods" title="Permalink to this heading"></a></h3>
<p>The following methods are supported by <code class="docutils literal notranslate"><span class="pre">stiqueue</span></code>:</p>
<ul class="simple">
<li><p><strong>``enq(msg: bytes)``</strong>: Adds a message to the queue.</p></li>
<li><p><strong>``deq() -&gt; bytes``</strong>: Retrieves the next message from the queue (blocking call).</p></li>
<li><p><strong>``cnt() -&gt; int``</strong>: Returns the number of messages currently in the queue.</p></li>
<li><p><strong>``ack()``</strong>: Acknowledges a message when <code class="docutils literal notranslate"><span class="pre">ack_required=True</span></code>. If not acknowledged within <code class="docutils literal notranslate"><span class="pre">ack_timeout</span></code>,
<li><p><code class="docutils literal notranslate"><span class="pre">enq(msg:</span> <span class="pre">bytes)</span></code>: Adds a message to the queue.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">deq()</span> <span class="pre">-&gt;</span> <span class="pre">bytes</span></code>: Retrieves the next message from the queue (blocking call).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">cnt()</span> <span class="pre">-&gt;</span> <span class="pre">int</span></code>: Returns the number of messages currently in the queue.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ack()</span></code>: Acknowledges a message when <code class="docutils literal notranslate"><span class="pre">ack_required=True</span></code>. If not acknowledged within <code class="docutils literal notranslate"><span class="pre">ack_timeout</span></code>,
the server re-enqueues the message.</p></li>
</ul>
<blockquote>
Expand Down Expand Up @@ -161,7 +161,7 @@ <h2>Run a Specific Test<a class="headerlink" href="#run-a-specific-test" title="
</section>
</section>
<section id="key-highlights">
<h1><strong>Key Highlights</strong><a class="headerlink" href="#key-highlights" title="Permalink to this heading"></a></h1>
<h1>Key Highlights<a class="headerlink" href="#key-highlights" title="Permalink to this heading"></a></h1>
<ul class="simple">
<li><p><strong>Lightweight and Flexible</strong>: Minimal dependencies and easy to integrate.</p></li>
<li><p><strong>Blocking Dequeue</strong>: Efficient for resource-limited systems.</p></li>
Expand Down

0 comments on commit cbad273

Please sign in to comment.