aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2026-02-14 05:25:38 +00:00
Code Issues 3 Packages Projects Releases Wiki Activity
Files
benchmark
libaaruformat/docs/html/structCacheEntry.html

202 lines
10 KiB
HTML
Raw Permalink Normal View History

Add doxygen documentation
2025-10-11 01:35:43 +01:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
Updated doxygen documentation.
2025-12-21 20:17:32 +00:00
<meta name="generator" content="Doxygen 1.15.0"/>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
<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"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">libaaruformat<span id="projectnumber">&#160;1.0</span>
</div>
<div id="projectbrief">Aaru Data Preservation Suite - Format Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
Updated doxygen documentation.
2025-12-21 20:17:32 +00:00
<!-- Generated by Doxygen 1.15.0 -->
Add doxygen documentation
2025-10-11 01:35:43 +01:00
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('structCacheEntry.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">CacheEntry Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Single hash entry in the in-memory cache.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="lru_8h_source.html">aaruformat/lru.h</a>&gt;</code></p>
<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>
</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>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>
</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>
</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>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UT_hash_handle CacheEntry::hh</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 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>
Update doxygen documentation.
2025-12-31 10:59:13 +00:00
<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>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="aeb007cfa604b485f120ec1f7526c95f4" name="aeb007cfa604b485f120ec1f7526c95f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb007cfa604b485f120ec1f7526c95f4">&#9670;&#160;</a></span>key</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* CacheEntry::key</td>
</tr>
</table>
</div><div class="memdoc">
<p>Null-terminated key string (unique within the cache). May encode numeric keys. </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>
Update doxygen documentation.
2025-12-31 10:59:13 +00:00
<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>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="a7d6d1ed0aab03cffbb34aff16f6f3d56" name="a7d6d1ed0aab03cffbb34aff16f6f3d56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d6d1ed0aab03cffbb34aff16f6f3d56">&#9670;&#160;</a></span>value</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* CacheEntry::value</td>
</tr>
</table>
</div><div class="memdoc">
<p>Opaque value pointer associated with key (not freed automatically on eviction/clear). </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>
Update doxygen documentation.
2025-12-31 10:59:13 +00:00
<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>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/aaruformat/<a class="el" href="lru_8h_source.html">lru.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="structCacheEntry.html">CacheEntry</a></li>
Updated doxygen documentation.
2025-12-21 20:17:32 +00:00
<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>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink