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

Update doxygen documentation.

Browse Source
This commit is contained in:
Natalia Portillo
2025-12-31 10:59:13 +00:00
parent 48259087f8
commit e962e3443e
467 changed files with 14662 additions and 13929 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/html/lru_8h_source.html
View File

@@ -114,19 +114,22 @@ $(function(){initNavTree('lru_8h_source.html','',''); });
<div class="foldopen" id="foldopen00045" data-start="{" data-end="};">
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="structCacheHeader.html"> 45</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structCacheHeader.html">CacheHeader</a></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span>{</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="structCacheHeader.html#ad3b962f8ce6c6115143cf581c7936e55"> 47</a></span> uint64_t <a class="code hl_variable" href="structCacheHeader.html#ad3b962f8ce6c6115143cf581c7936e55">max_items</a>; </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="structCacheHeader.html#a44229bb929d8949f3c2700d07123d224"> 48</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structCacheEntry.html">CacheEntry</a> *<a class="code hl_variable" href="structCacheHeader.html#a44229bb929d8949f3c2700d07123d224">cache</a>; </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>};</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="structCacheHeader.html#ad3b962f8ce6c6115143cf581c7936e55"> 47</a></span> uint64_t <a class="code hl_variable" href="structCacheHeader.html#ad3b962f8ce6c6115143cf581c7936e55">max_items</a>; </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="structCacheHeader.html#a44229bb929d8949f3c2700d07123d224"> 48</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structCacheEntry.html">CacheEntry</a> *<a class="code hl_variable" href="structCacheHeader.html#a44229bb929d8949f3c2700d07123d224">cache</a>; </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="structCacheHeader.html#afeac54c794f8fece845e49954fd89f1a"> 49</a></span> void (*<a class="code hl_variable" href="structCacheHeader.html#afeac54c794f8fece845e49954fd89f1a">free_func</a>)(<span class="keywordtype">void</span> *); </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>};</div>
</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="keywordtype">void</span> *<a class="code hl_function" href="lru_8h.html#ac7008173fc7e392fa825c69410920f0a">find_in_cache</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structCacheHeader.html">CacheHeader</a> *cache, <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="structCacheEntry.html#aeb007cfa604b485f120ec1f7526c95f4">key</a>);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="keywordtype">void</span> <a class="code hl_function" href="lru_8h.html#a962bb6b97fb208cbd8a5932afb60e680">add_to_cache</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structCacheHeader.html">CacheHeader</a> *cache, <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="structCacheEntry.html#aeb007cfa604b485f120ec1f7526c95f4">key</a>, <span class="keywordtype">void</span> *<a class="code hl_variable" href="structCacheEntry.html#a7d6d1ed0aab03cffbb34aff16f6f3d56">value</a>);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="keywordtype">void</span> *<a class="code hl_function" href="lru_8h.html#a8cb7ac8e057627210732ee61d2966e35">find_in_cache_uint64</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structCacheHeader.html">CacheHeader</a> *cache, uint64_t <a class="code hl_variable" href="structCacheEntry.html#aeb007cfa604b485f120ec1f7526c95f4">key</a>);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="keywordtype">void</span> <a class="code hl_function" href="lru_8h.html#a0735969939ca80db3fe439ed92b787bb">add_to_cache_uint64</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structCacheHeader.html">CacheHeader</a> *cache, uint64_t <a class="code hl_variable" href="structCacheEntry.html#aeb007cfa604b485f120ec1f7526c95f4">key</a>, <span class="keywordtype">void</span> *<a class="code hl_variable" href="structCacheEntry.html#a7d6d1ed0aab03cffbb34aff16f6f3d56">value</a>);</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="preprocessor">#endif </span><span class="comment">// LIBAARUFORMAT_LRU_H</span></div>
<div class="ttc" id="alru_8h_html_a0735969939ca80db3fe439ed92b787bb"><div class="ttname"><a href="lru_8h.html#a0735969939ca80db3fe439ed92b787bb">add_to_cache_uint64</a></div><div class="ttdeci">void add_to_cache_uint64(struct CacheHeader *cache, uint64_t key, void *value)</div><div class="ttdoc">Adds a value to the cache with a uint64_t key, using string conversion.</div><div class="ttdef"><b>Definition</b> <a href="lru_8c_source.html#l00102">lru.c:102</a></div></div>
<div class="ttc" id="alru_8h_html_a8cb7ac8e057627210732ee61d2966e35"><div class="ttname"><a href="lru_8h.html#a8cb7ac8e057627210732ee61d2966e35">find_in_cache_uint64</a></div><div class="ttdeci">void * find_in_cache_uint64(struct CacheHeader *cache, uint64_t key)</div><div class="ttdoc">Finds a value in the cache by uint64_t key, using string conversion.</div><div class="ttdef"><b>Definition</b> <a href="lru_8c_source.html#l00088">lru.c:88</a></div></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="keywordtype">void</span> *<a class="code hl_function" href="lru_8h.html#ac7008173fc7e392fa825c69410920f0a">find_in_cache</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structCacheHeader.html">CacheHeader</a> *cache, <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="structCacheEntry.html#aeb007cfa604b485f120ec1f7526c95f4">key</a>);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="keywordtype">void</span> <a class="code hl_function" href="lru_8h.html#a962bb6b97fb208cbd8a5932afb60e680">add_to_cache</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structCacheHeader.html">CacheHeader</a> *cache, <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="structCacheEntry.html#aeb007cfa604b485f120ec1f7526c95f4">key</a>, <span class="keywordtype">void</span> *<a class="code hl_variable" href="structCacheEntry.html#a7d6d1ed0aab03cffbb34aff16f6f3d56">value</a>);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="keywordtype">void</span> *<a class="code hl_function" href="lru_8h.html#a8cb7ac8e057627210732ee61d2966e35">find_in_cache_uint64</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structCacheHeader.html">CacheHeader</a> *cache, uint64_t <a class="code hl_variable" href="structCacheEntry.html#aeb007cfa604b485f120ec1f7526c95f4">key</a>);</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="keywordtype">void</span> <a class="code hl_function" href="lru_8h.html#a0735969939ca80db3fe439ed92b787bb">add_to_cache_uint64</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structCacheHeader.html">CacheHeader</a> *cache, uint64_t <a class="code hl_variable" href="structCacheEntry.html#aeb007cfa604b485f120ec1f7526c95f4">key</a>, <span class="keywordtype">void</span> *<a class="code hl_variable" href="structCacheEntry.html#a7d6d1ed0aab03cffbb34aff16f6f3d56">value</a>);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="keywordtype">void</span> <a class="code hl_function" href="lru_8h.html#a92e298695411672c3497ae5c8d9c0427">free_cache</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structCacheHeader.html">CacheHeader</a> *cache);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="preprocessor">#endif </span><span class="comment">// LIBAARUFORMAT_LRU_H</span></div>
<div class="ttc" id="alru_8h_html_a0735969939ca80db3fe439ed92b787bb"><div class="ttname"><a href="lru_8h.html#a0735969939ca80db3fe439ed92b787bb">add_to_cache_uint64</a></div><div class="ttdeci">void add_to_cache_uint64(struct CacheHeader *cache, uint64_t key, void *value)</div><div class="ttdoc">Adds a value to the cache with a uint64_t key, using string conversion.</div><div class="ttdef"><b>Definition</b> <a href="lru_8c_source.html#l00113">lru.c:113</a></div></div>
<div class="ttc" id="alru_8h_html_a8cb7ac8e057627210732ee61d2966e35"><div class="ttname"><a href="lru_8h.html#a8cb7ac8e057627210732ee61d2966e35">find_in_cache_uint64</a></div><div class="ttdeci">void * find_in_cache_uint64(struct CacheHeader *cache, uint64_t key)</div><div class="ttdoc">Finds a value in the cache by uint64_t key, using string conversion.</div><div class="ttdef"><b>Definition</b> <a href="lru_8c_source.html#l00093">lru.c:93</a></div></div>
<div class="ttc" id="alru_8h_html_a92e298695411672c3497ae5c8d9c0427"><div class="ttname"><a href="lru_8h.html#a92e298695411672c3497ae5c8d9c0427">free_cache</a></div><div class="ttdeci">void free_cache(struct CacheHeader *cache)</div><div class="ttdoc">Frees all entries in the cache and clears it.</div><div class="ttdef"><b>Definition</b> <a href="lru_8c_source.html#l00130">lru.c:130</a></div></div>
<div class="ttc" id="alru_8h_html_a962bb6b97fb208cbd8a5932afb60e680"><div class="ttname"><a href="lru_8h.html#a962bb6b97fb208cbd8a5932afb60e680">add_to_cache</a></div><div class="ttdeci">void add_to_cache(struct CacheHeader *cache, const char *key, void *value)</div><div class="ttdoc">Adds a value to the cache with a string key, pruning if necessary.</div><div class="ttdef"><b>Definition</b> <a href="lru_8c_source.html#l00047">lru.c:47</a></div></div>
<div class="ttc" id="alru_8h_html_ac7008173fc7e392fa825c69410920f0a"><div class="ttname"><a href="lru_8h.html#ac7008173fc7e392fa825c69410920f0a">find_in_cache</a></div><div class="ttdeci">void * find_in_cache(struct CacheHeader *cache, const char *key)</div><div class="ttdoc">Finds a value in the cache by string key.</div><div class="ttdef"><b>Definition</b> <a href="lru_8c_source.html#l00024">lru.c:24</a></div></div>
<div class="ttc" id="astructCacheEntry_html"><div class="ttname"><a href="structCacheEntry.html">CacheEntry</a></div><div class="ttdoc">Single hash entry in the in-memory cache.</div><div class="ttdef"><b>Definition</b> <a href="#l00026">lru.h:27</a></div></div>
@@ -136,6 +139,7 @@ $(function(){initNavTree('lru_8h_source.html','',''); });
<div class="ttc" id="astructCacheHeader_html"><div class="ttname"><a href="structCacheHeader.html">CacheHeader</a></div><div class="ttdoc">Cache top-level descriptor encapsulating the hash table root and capacity limit.</div><div class="ttdef"><b>Definition</b> <a href="#l00045">lru.h:46</a></div></div>
<div class="ttc" id="astructCacheHeader_html_a44229bb929d8949f3c2700d07123d224"><div class="ttname"><a href="structCacheHeader.html#a44229bb929d8949f3c2700d07123d224">CacheHeader::cache</a></div><div class="ttdeci">struct CacheEntry * cache</div><div class="ttdoc">Hash root (uthash). NULL when empty.</div><div class="ttdef"><b>Definition</b> <a href="#l00048">lru.h:48</a></div></div>
<div class="ttc" id="astructCacheHeader_html_ad3b962f8ce6c6115143cf581c7936e55"><div class="ttname"><a href="structCacheHeader.html#ad3b962f8ce6c6115143cf581c7936e55">CacheHeader::max_items</a></div><div class="ttdeci">uint64_t max_items</div><div class="ttdoc">Hard limit for number of entries (policy: enforce/ignore depends on implementation).</div><div class="ttdef"><b>Definition</b> <a href="#l00047">lru.h:47</a></div></div>
<div class="ttc" id="astructCacheHeader_html_afeac54c794f8fece845e49954fd89f1a"><div class="ttname"><a href="structCacheHeader.html#afeac54c794f8fece845e49954fd89f1a">CacheHeader::free_func</a></div><div class="ttdeci">void(* free_func)(void *)</div><div class="ttdoc">Optional callback to free cached values. NULL if values don&#39;t need freeing.</div><div class="ttdef"><b>Definition</b> <a href="#l00049">lru.h:49</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div><!-- container -->