aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2026-09-16 11:54:18 +00:00
Code Issues 3 Packages Projects Releases Wiki Activity

Update doxygen documentation.

Browse Source
This commit is contained in:
Natalia Portillo
2026-04-11 23:17:09 +01:00
parent 7af6e613ab
commit a94f388238
658 changed files with 65760 additions and 36437 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
docs/html/structCacheHeader.html
View File

@@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.15.0"/>
<meta name="generator" content="Doxygen 1.16.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: CacheHeader Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -35,7 +35,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.15.0 -->
<!-- Generated by Doxygen 1.16.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
@@ -100,22 +100,23 @@ $(function(){initNavTree('structCacheHeader.html','',''); });
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ad3b962f8ce6c6115143cf581c7936e55" id="r_ad3b962f8ce6c6115143cf581c7936e55"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad3b962f8ce6c6115143cf581c7936e55">max_items</a></td></tr>
<tr class="memdesc:ad3b962f8ce6c6115143cf581c7936e55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hard limit for number of entries (policy: enforce/ignore depends on implementation). <br /></td></tr>
<tr class="memitem:a44229bb929d8949f3c2700d07123d224" id="r_a44229bb929d8949f3c2700d07123d224"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structCacheEntry.html">CacheEntry</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a44229bb929d8949f3c2700d07123d224">cache</a></td></tr>
<tr class="memitem:ad3b962f8ce6c6115143cf581c7936e55" id="r_ad3b962f8ce6c6115143cf581c7936e55"><td class="memItemLeft">uint64_t&#160;</td><td class="memItemRight"><a class="el" href="#ad3b962f8ce6c6115143cf581c7936e55">max_items</a></td></tr>
<tr class="memdesc:ad3b962f8ce6c6115143cf581c7936e55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hard limit for number of entries. <br /></td></tr>
<tr class="memitem:a44229bb929d8949f3c2700d07123d224" id="r_a44229bb929d8949f3c2700d07123d224"><td class="memItemLeft">struct <a class="el" href="structCacheEntry.html">CacheEntry</a> *&#160;</td><td class="memItemRight"><a class="el" href="#a44229bb929d8949f3c2700d07123d224">cache</a></td></tr>
<tr class="memdesc:a44229bb929d8949f3c2700d07123d224"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hash root (uthash). NULL when empty. <br /></td></tr>
<tr class="memitem:afeac54c794f8fece845e49954fd89f1a" id="r_afeac54c794f8fece845e49954fd89f1a"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afeac54c794f8fece845e49954fd89f1a">free_func</a> )(void *)</td></tr>
<tr class="memdesc:afeac54c794f8fece845e49954fd89f1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional callback to free cached values. NULL if values don't need freeing. <br /></td></tr>
<tr class="memitem:afeac54c794f8fece845e49954fd89f1a" id="r_afeac54c794f8fece845e49954fd89f1a"><td class="memItemLeft">void(*&#160;</td><td class="memItemRight"><a class="el" href="#afeac54c794f8fece845e49954fd89f1a">free_func</a> )(void *)</td></tr>
<tr class="memdesc:afeac54c794f8fece845e49954fd89f1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional callback to free cached values. NULL if not needed. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Cache top-level descriptor encapsulating the hash table root and capacity limit. </p>
<p>The cache enforces an upper bound (max_items) on the number of tracked entries. Insert helpers are expected to evict (or refuse) when the limit is exceeded (strategy defined in implementation; current behavior may be simple non-evicting if not yet implemented as a true LRU). The cache pointer holds the uthash root (NULL when empty).</p>
<p>The cache enforces an upper bound (max_items) on the number of tracked entries. On insert, the oldest entry is evicted when the limit is reached (LRU via uthash insertion order).</p>
<p>Fields:</p><ul>
<li>max_items: Maximum number of entries allowed; 0 means "no explicit limit" if accepted by implementation.</li>
<li>cache: uthash root pointer; NULL when the cache is empty. </li>
<li>max_items: Maximum number of entries allowed; 0 means unlimited.</li>
<li>cache: uthash root pointer; NULL when the cache is empty.</li>
<li>free_func: Optional callback to free cached values on eviction/clear. </li>
</ul>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00045">45</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00041">41</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
</div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
<a id="a44229bb929d8949f3c2700d07123d224" name="a44229bb929d8949f3c2700d07123d224"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44229bb929d8949f3c2700d07123d224">&#9670;&#160;</a></span>cache</h2>
@@ -131,9 +132,9 @@ Data Fields</h2></td></tr>
<p>Hash root (uthash). NULL when empty. </p>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00048">48</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00044">44</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, <a class="el" href="open_8c_source.html#l00223">aaruf_open()</a>, <a class="el" href="lru_8c_source.html#l00047">add_to_cache()</a>, <a class="el" href="lru_8c_source.html#l00024">find_in_cache()</a>, and <a class="el" href="lru_8c_source.html#l00130">free_cache()</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00291">aaruf_create()</a>, <a class="el" href="open_8c_source.html#l00236">aaruf_open()</a>, <a class="el" href="lru_8c_source.html#l00048">add_to_cache_uint64()</a>, <a class="el" href="lru_8c_source.html#l00024">find_in_cache_uint64()</a>, and <a class="el" href="lru_8c_source.html#l00082">free_cache()</a>.</p>
</div>
</div>
@@ -149,11 +150,11 @@ Data Fields</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Optional callback to free cached values. NULL if values don't need freeing. </p>
<p>Optional callback to free cached values. NULL if not needed. </p>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00049">49</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00045">45</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="open_8c_source.html#l00223">aaruf_open()</a>, <a class="el" href="lru_8c_source.html#l00047">add_to_cache()</a>, and <a class="el" href="lru_8c_source.html#l00130">free_cache()</a>.</p>
<p class="reference">Referenced by <a class="el" href="open_8c_source.html#l00236">aaruf_open()</a>, <a class="el" href="lru_8c_source.html#l00048">add_to_cache_uint64()</a>, and <a class="el" href="lru_8c_source.html#l00082">free_cache()</a>.</p>
</div>
</div>
@@ -169,11 +170,11 @@ Data Fields</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Hard limit for number of entries (policy: enforce/ignore depends on implementation). </p>
<p>Hard limit for number of entries. </p>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00047">47</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00043">43</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, <a class="el" href="open_8c_source.html#l00223">aaruf_open()</a>, and <a class="el" href="lru_8c_source.html#l00047">add_to_cache()</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00291">aaruf_create()</a>, <a class="el" href="open_8c_source.html#l00236">aaruf_open()</a>, and <a class="el" href="lru_8c_source.html#l00048">add_to_cache_uint64()</a>.</p>
</div>
</div>
@@ -194,7 +195,7 @@ Data Fields</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="structCacheHeader.html">CacheHeader</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
</ul>
</div>
</body>