Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@boazsegev
boazsegev committed May 18, 2020
1 parent 01f40f5 commit 063c9bb
Show file tree
Hide file tree
Showing 28 changed files with 511 additions and 487 deletions.
2 changes: 1 addition & 1 deletion docs/0.6.x/evio.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ <h3 id="evio_review"><code>evio_review</code></h3>
<p>Returns -1 on error, otherwise returns the number of events handled.</p>

<h3 id="evio_close"><code>evio_close</code></h3>
<div class="highlight"><pre class="highlight c"><code><span class="kt">void</span> <span class="n">evio_close</span><span class="p">(</span><span class="kt">void</span><span class="p">);</span>
<div class="highlight"><pre class="highlight c"><code><span class="kt">void</span> <span class="nf">evio_close</span><span class="p">(</span><span class="kt">void</span><span class="p">);</span>
</code></pre></div>
<p>Closes the <code>epoll</code> / <code>kqueue</code> object, releasing it&#39;s resources (important if
forking!).</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/0.6.x/fio_ary.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ <h3 id="the-fio_ary_for-macro">the <code>FIO_ARY_FOR</code> macro</h3>
<p>The <code>pos</code> variable can be named however you please (i.e. <code>FIO_ARY_FOR(&amp;bar, foo)</code> for <code>foo.i</code> and <code>foo.obj</code>).</p>

<h3 id="the-fio_ary_each-function">the <code>fio_ary_each</code> function</h3>
<div class="highlight"><pre class="highlight c"><code><span class="kt">size_t</span> <span class="n">fio_ary_each</span><span class="p">(</span><span class="n">fio_ary_s</span> <span class="o">*</span><span class="n">ary</span><span class="p">,</span> <span class="kt">size_t</span> <span class="n">start_at</span><span class="p">,</span>
<div class="highlight"><pre class="highlight c"><code><span class="kt">size_t</span> <span class="nf">fio_ary_each</span><span class="p">(</span><span class="n">fio_ary_s</span> <span class="o">*</span><span class="n">ary</span><span class="p">,</span> <span class="kt">size_t</span> <span class="n">start_at</span><span class="p">,</span>
<span class="kt">int</span> <span class="p">(</span><span class="o">*</span><span class="n">task</span><span class="p">)(</span><span class="kt">void</span> <span class="o">*</span><span class="n">pt</span><span class="p">,</span> <span class="kt">void</span> <span class="o">*</span><span class="n">arg</span><span class="p">),</span>
<span class="kt">void</span> <span class="o">*</span><span class="n">arg</span><span class="p">);</span>
</code></pre></div>
Expand Down
2 changes: 1 addition & 1 deletion docs/0.6.x/fio_hashmap.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ <h3 id="fio_hash_rehash"><code>fio_hash_rehash</code></h3>
<p>This function is called automatically when needed, it&#39;s unlikely that you should want to call the function yourself.</p>

<h3 id="fio_hash_each"><code>fio_hash_each</code></h3>
<div class="highlight"><pre class="highlight c"><code><span class="kt">size_t</span> <span class="n">fio_hash_each</span><span class="p">(</span><span class="n">fio_hash_s</span> <span class="o">*</span><span class="n">hash</span><span class="p">,</span>
<div class="highlight"><pre class="highlight c"><code><span class="kt">size_t</span> <span class="nf">fio_hash_each</span><span class="p">(</span><span class="n">fio_hash_s</span> <span class="o">*</span><span class="n">hash</span><span class="p">,</span>
<span class="k">const</span> <span class="kt">size_t</span> <span class="n">start_at</span><span class="p">,</span>
<span class="kt">int</span> <span class="p">(</span><span class="o">*</span><span class="n">task</span><span class="p">)(</span><span class="n">FIO_HASH_KEY_TYPE</span> <span class="n">key</span><span class="p">,</span>
<span class="kt">void</span> <span class="o">*</span><span class="n">obj</span><span class="p">,</span>
Expand Down
30 changes: 15 additions & 15 deletions docs/0.6.x/fiobj_ary.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -138,36 +138,36 @@ <h3 id="core-types"><a href="/0.6.x/types">Core Types</a></h3>
<h3 id="array-creation-api">Array creation API</h3>

<h4 id="fiobj_ary_new"><code>fiobj_ary_new</code></h4>
<div class="highlight"><pre class="highlight c"><code><span class="n">FIOBJ</span> <span class="n">fiobj_ary_new</span><span class="p">(</span><span class="kt">void</span><span class="p">);</span>
<div class="highlight"><pre class="highlight c"><code><span class="n">FIOBJ</span> <span class="nf">fiobj_ary_new</span><span class="p">(</span><span class="kt">void</span><span class="p">);</span>
</code></pre></div>
<p>Creates a mutable empty Array object. Use <code>fiobj_free</code> when done.</p>

<h4 id="fiobj_ary_new2"><code>fiobj_ary_new2</code></h4>
<div class="highlight"><pre class="highlight c"><code><span class="n">FIOBJ</span> <span class="n">fiobj_ary_new2</span><span class="p">(</span><span class="kt">size_t</span> <span class="n">capa</span><span class="p">);</span>
<div class="highlight"><pre class="highlight c"><code><span class="n">FIOBJ</span> <span class="nf">fiobj_ary_new2</span><span class="p">(</span><span class="kt">size_t</span> <span class="n">capa</span><span class="p">);</span>
</code></pre></div>
<p>Creates a mutable empty Array object with the requested capacity.</p>

<h3 id="accessing-array-members-data">Accessing Array Members / Data</h3>

<h4 id="fiobj_ary_count"><code>fiobj_ary_count</code></h4>
<div class="highlight"><pre class="highlight c"><code><span class="kt">size_t</span> <span class="n">fiobj_ary_count</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">);</span>
<div class="highlight"><pre class="highlight c"><code><span class="kt">size_t</span> <span class="nf">fiobj_ary_count</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">);</span>
</code></pre></div>
<p>Returns the number of elements in the Array.</p>

<h4 id="fiobj_ary_capa"><code>fiobj_ary_capa</code></h4>
<div class="highlight"><pre class="highlight c"><code><span class="kt">size_t</span> <span class="n">fiobj_ary_capa</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">);</span>
<div class="highlight"><pre class="highlight c"><code><span class="kt">size_t</span> <span class="nf">fiobj_ary_capa</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">);</span>
</code></pre></div>
<p>Returns the current, temporary, array capacity (it&#39;s dynamic).</p>

<h4 id="fiobj_ary2ptr"><code>fiobj_ary2ptr</code></h4>
<div class="highlight"><pre class="highlight c"><code><span class="n">FIOBJ</span> <span class="o">*</span><span class="n">fiobj_ary2ptr</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">);</span>
<div class="highlight"><pre class="highlight c"><code><span class="n">FIOBJ</span> <span class="o">*</span><span class="nf">fiobj_ary2ptr</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">);</span>
</code></pre></div>
<p>Returns a TEMPORARY pointer to the beginning of the array.</p>

<p>This pointer can be used for sorting and other direct access operations as long as no other actions (insertion/deletion) are performed on the array.</p>

<h4 id="fiobj_ary_index"><code>fiobj_ary_index</code></h4>
<div class="highlight"><pre class="highlight c"><code><span class="n">FIOBJ</span> <span class="n">fiobj_ary_index</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">,</span> <span class="kt">int64_t</span> <span class="n">pos</span><span class="p">);</span>
<div class="highlight"><pre class="highlight c"><code><span class="n">FIOBJ</span> <span class="nf">fiobj_ary_index</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">,</span> <span class="kt">int64_t</span> <span class="n">pos</span><span class="p">);</span>
</code></pre></div>
<p>Returns a temporary object owned by the Array.</p>

Expand All @@ -192,49 +192,49 @@ <h4 id="fiobj_ary_entry"><code>fiobj_ary_entry</code></h4>
<h3 id="array-push-shift-api">Array push / shift API</h3>

<h4 id="fiobj_ary_push"><code>fiobj_ary_push</code></h4>
<div class="highlight"><pre class="highlight c"><code><span class="kt">void</span> <span class="n">fiobj_ary_push</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">,</span> <span class="n">FIOBJ</span> <span class="n">obj</span><span class="p">);</span>
<div class="highlight"><pre class="highlight c"><code><span class="kt">void</span> <span class="nf">fiobj_ary_push</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">,</span> <span class="n">FIOBJ</span> <span class="n">obj</span><span class="p">);</span>
</code></pre></div>
<p>Pushes an object to the end of the Array.</p>

<h4 id="fiobj_ary_pop"><code>fiobj_ary_pop</code></h4>
<div class="highlight"><pre class="highlight c"><code><span class="n">FIOBJ</span> <span class="n">fiobj_ary_pop</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">);</span>
<div class="highlight"><pre class="highlight c"><code><span class="n">FIOBJ</span> <span class="nf">fiobj_ary_pop</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">);</span>
</code></pre></div>
<p>Pops an object from the end of the Array.</p>

<h4 id="fiobj_ary_unshift"><code>fiobj_ary_unshift</code></h4>
<div class="highlight"><pre class="highlight c"><code><span class="kt">void</span> <span class="n">fiobj_ary_unshift</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">,</span> <span class="n">FIOBJ</span> <span class="n">obj</span><span class="p">);</span>
<div class="highlight"><pre class="highlight c"><code><span class="kt">void</span> <span class="nf">fiobj_ary_unshift</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">,</span> <span class="n">FIOBJ</span> <span class="n">obj</span><span class="p">);</span>
</code></pre></div>
<p>Unshifts an object to the beginning of the Array. This could be expensive.</p>

<h4 id="fiobj_ary_shift"><code>fiobj_ary_shift</code></h4>
<div class="highlight"><pre class="highlight c"><code><span class="n">FIOBJ</span> <span class="n">fiobj_ary_shift</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">);</span>
<div class="highlight"><pre class="highlight c"><code><span class="n">FIOBJ</span> <span class="nf">fiobj_ary_shift</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">);</span>
</code></pre></div>
<p>Shifts an object from the beginning of the Array.</p>

<h1 id="find-remove-replace">Find / Remove / Replace</h1>

<h4 id="fiobj_ary_replace"><code>fiobj_ary_replace</code></h4>
<div class="highlight"><pre class="highlight c"><code><span class="n">FIOBJ</span> <span class="n">fiobj_ary_replace</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">,</span> <span class="n">FIOBJ</span> <span class="n">obj</span><span class="p">,</span> <span class="kt">int64_t</span> <span class="n">pos</span><span class="p">);</span>
<div class="highlight"><pre class="highlight c"><code><span class="n">FIOBJ</span> <span class="nf">fiobj_ary_replace</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">,</span> <span class="n">FIOBJ</span> <span class="n">obj</span><span class="p">,</span> <span class="kt">int64_t</span> <span class="n">pos</span><span class="p">);</span>
</code></pre></div>
<p>Replaces the object at a specific position, returning the old object -
remember to <code>fiobj_free</code> the old object.</p>

<h4 id="fiobj_ary_find"><code>fiobj_ary_find</code></h4>
<div class="highlight"><pre class="highlight c"><code><span class="kt">int64_t</span> <span class="n">fiobj_ary_find</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">,</span> <span class="n">FIOBJ</span> <span class="n">data</span><span class="p">);</span>
<div class="highlight"><pre class="highlight c"><code><span class="kt">int64_t</span> <span class="nf">fiobj_ary_find</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">,</span> <span class="n">FIOBJ</span> <span class="n">data</span><span class="p">);</span>
</code></pre></div>
<p>Finds the index of a specifide object (if any). Returns -1 if the object
isn&#39;t found.</p>

<h4 id="fiobj_ary_remove"><code>fiobj_ary_remove</code></h4>
<div class="highlight"><pre class="highlight c"><code><span class="kt">int</span> <span class="n">fiobj_ary_remove</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">,</span> <span class="kt">int64_t</span> <span class="n">pos</span><span class="p">);</span>
<div class="highlight"><pre class="highlight c"><code><span class="kt">int</span> <span class="nf">fiobj_ary_remove</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">,</span> <span class="kt">int64_t</span> <span class="n">pos</span><span class="p">);</span>
</code></pre></div>
<p>Removes the object at the index (if valid), changing the index of any
following objects.</p>

<p>Returns 0 on success or -1 (if no object or out of bounds).</p>

<h4 id="fiobj_ary_remove2"><code>fiobj_ary_remove2</code></h4>
<div class="highlight"><pre class="highlight c"><code><span class="kt">int</span> <span class="n">fiobj_ary_remove2</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">,</span> <span class="n">FIOBJ</span> <span class="n">data</span><span class="p">);</span>
<div class="highlight"><pre class="highlight c"><code><span class="kt">int</span> <span class="nf">fiobj_ary_remove2</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">,</span> <span class="n">FIOBJ</span> <span class="n">data</span><span class="p">);</span>
</code></pre></div>
<p>Removes the first instance of an object from the Array (if any), changing the
index of any following objects.</p>
Expand All @@ -244,7 +244,7 @@ <h4 id="fiobj_ary_remove2"><code>fiobj_ary_remove2</code></h4>
<h3 id="array-compacting">Array Compacting</h3>

<h4 id="fiobj_ary_compact"><code>fiobj_ary_compact</code></h4>
<div class="highlight"><pre class="highlight c"><code><span class="kt">void</span> <span class="n">fiobj_ary_compact</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">);</span>
<div class="highlight"><pre class="highlight c"><code><span class="kt">void</span> <span class="nf">fiobj_ary_compact</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">ary</span><span class="p">);</span>
</code></pre></div>
<p>Removes any NULL <em>pointers</em> from an Array, keeping all Objects (including
explicit NULL objects) in the array.</p>
Expand Down
Loading

0 comments on commit 063c9bb

Please sign in to comment.