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

49
docs/html/structCacheEntry.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: CacheEntry 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,21 @@ $(function(){initNavTree('structCacheEntry.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:aeb007cfa604b485f120ec1f7526c95f4" id="r_aeb007cfa604b485f120ec1f7526c95f4"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aeb007cfa604b485f120ec1f7526c95f4">key</a></td></tr>
<tr class="memdesc:aeb007cfa604b485f120ec1f7526c95f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Null-terminated key string (unique within the cache). May encode numeric keys. <br /></td></tr>
<tr class="memitem:a7d6d1ed0aab03cffbb34aff16f6f3d56" id="r_a7d6d1ed0aab03cffbb34aff16f6f3d56"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7d6d1ed0aab03cffbb34aff16f6f3d56">value</a></td></tr>
<tr class="memdesc:a7d6d1ed0aab03cffbb34aff16f6f3d56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opaque value pointer associated with key (not freed automatically on eviction/clear). <br /></td></tr>
<tr class="memitem:ae7e5f03fa52b88d99e27e2433623b4f5" id="r_ae7e5f03fa52b88d99e27e2433623b4f5"><td class="memItemLeft" align="right" valign="top">UT_hash_handle&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae7e5f03fa52b88d99e27e2433623b4f5">hh</a></td></tr>
<tr class="memdesc:ae7e5f03fa52b88d99e27e2433623b4f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">uthash handle linking this entry into the hash table (must remain last or per uthash docs). <br /></td></tr>
<tr class="memitem:acee4cc303db10f54cfe2314142f24428" id="r_acee4cc303db10f54cfe2314142f24428"><td class="memItemLeft">uint64_t&#160;</td><td class="memItemRight"><a class="el" href="#acee4cc303db10f54cfe2314142f24428">key</a></td></tr>
<tr class="memdesc:acee4cc303db10f54cfe2314142f24428"><td class="mdescLeft">&#160;</td><td class="mdescRight">64-bit integer key (unique within the cache). <br /></td></tr>
<tr class="memitem:a7d6d1ed0aab03cffbb34aff16f6f3d56" id="r_a7d6d1ed0aab03cffbb34aff16f6f3d56"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><a class="el" href="#a7d6d1ed0aab03cffbb34aff16f6f3d56">value</a></td></tr>
<tr class="memdesc:a7d6d1ed0aab03cffbb34aff16f6f3d56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opaque value pointer associated with key. <br /></td></tr>
<tr class="memitem:ae7e5f03fa52b88d99e27e2433623b4f5" id="r_ae7e5f03fa52b88d99e27e2433623b4f5"><td class="memItemLeft">UT_hash_handle&#160;</td><td class="memItemRight"><a class="el" href="#ae7e5f03fa52b88d99e27e2433623b4f5">hh</a></td></tr>
<tr class="memdesc:ae7e5f03fa52b88d99e27e2433623b4f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">uthash handle (must remain per uthash docs). <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Single hash entry in the in-memory cache. </p>
<p>This structure is managed by uthash (open addressing with chaining semantics provided by macros). It represents one key/value association tracked by the cache. The cache implementation supports both string keys (null-terminated) and 64-bit numeric keys; numeric keys are stored by casting to a temporary string buffer upstream (see implementation). Callers do not allocate or free individual entries directly; use the cache API helpers.</p>
<p>This structure is managed by uthash and represents one key/value association tracked by the cache. Keys are native 64-bit integers, hashed directly by uthash without string conversion. Callers do not allocate or free individual entries directly; use the cache API helpers.</p>
<p>Lifetime &amp; ownership:</p><ul>
<li>key points either to a heap-allocated C string owned by the cache or to a short-lived buffer duplicated internally; callers must not free it after insertion.</li>
<li>value is an opaque pointer supplied by caller; the cache does not take ownership of the pointee (caller remains responsible for the underlying object unless documented otherwise). </li>
<li>value is an opaque pointer supplied by caller; the cache does not take ownership unless a free_func is registered on the <a class="el" href="structCacheHeader.html" title="Cache top-level descriptor encapsulating the hash table root and capacity limit.">CacheHeader</a>. </li>
</ul>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00026">26</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#l00023">23</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="ae7e5f03fa52b88d99e27e2433623b4f5" name="ae7e5f03fa52b88d99e27e2433623b4f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7e5f03fa52b88d99e27e2433623b4f5">&#9670;&#160;</a></span>hh</h2>
@@ -129,31 +128,31 @@ Data Fields</h2></td></tr>
</table>
</div><div class="memdoc">
<p>uthash handle linking this entry into the hash table (must remain last or per uthash docs). </p>
<p>uthash handle (must remain per uthash docs). </p>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00030">30</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#l00027">27</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
<p class="reference">Referenced by <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="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>
<a id="aeb007cfa604b485f120ec1f7526c95f4" name="aeb007cfa604b485f120ec1f7526c95f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb007cfa604b485f120ec1f7526c95f4">&#9670;&#160;</a></span>key</h2>
<a id="acee4cc303db10f54cfe2314142f24428" name="acee4cc303db10f54cfe2314142f24428"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acee4cc303db10f54cfe2314142f24428">&#9670;&#160;</a></span>key</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* CacheEntry::key</td>
<td class="memname">uint64_t CacheEntry::key</td>
</tr>
</table>
</div><div class="memdoc">
<p>Null-terminated key string (unique within the cache). May encode numeric keys. </p>
<p>64-bit integer key (unique within the cache). </p>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00028">28</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#l00025">25</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="lru_8c_source.html#l00047">add_to_cache()</a>, <a class="el" href="lru_8c_source.html#l00113">add_to_cache_uint64()</a>, <a class="el" href="lru_8c_source.html#l00024">find_in_cache()</a>, <a class="el" href="lru_8c_source.html#l00093">find_in_cache_uint64()</a>, and <a class="el" href="lru_8c_source.html#l00130">free_cache()</a>.</p>
<p class="reference">Referenced by <a class="el" href="lru_8c_source.html#l00048">add_to_cache_uint64()</a>, and <a class="el" href="lru_8c_source.html#l00024">find_in_cache_uint64()</a>.</p>
</div>
</div>
@@ -169,11 +168,11 @@ Data Fields</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Opaque value pointer associated with key (not freed automatically on eviction/clear). </p>
<p>Opaque value pointer associated with key. </p>
<p class="definition">Definition at line <a class="el" href="lru_8h_source.html#l00029">29</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#l00026">26</a> of file <a class="el" href="lru_8h_source.html">lru.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="lru_8c_source.html#l00047">add_to_cache()</a>, <a class="el" href="lru_8c_source.html#l00113">add_to_cache_uint64()</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="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>
@@ -194,7 +193,7 @@ Data Fields</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="structCacheEntry.html">CacheEntry</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>