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" / >
< meta name = "generator" content = "Doxygen 1.14.0" / >
< 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" / >
< 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" >   1.0< / span >
< / div >
< div id = "projectbrief" > Aaru Data Preservation Suite - Format Library< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.14.0 -->
< 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('structCacheHeader.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" > CacheHeader Struct Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > Cache top-level descriptor encapsulating the hash table root and capacity limit.
< a href = "#details" > More...< / a > < / p >
< p > < code > #include < < a class = "el" href = "lru_8h_source.html" > aaruformat/lru.h< / a > > < / 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:ad3b962f8ce6c6115143cf581c7936e55" id = "r_ad3b962f8ce6c6115143cf581c7936e55" > < td class = "memItemLeft" align = "right" valign = "top" > uint64_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#ad3b962f8ce6c6115143cf581c7936e55" > max_items< / a > < / td > < / tr >
< tr class = "memdesc:ad3b962f8ce6c6115143cf581c7936e55" > < td class = "mdescLeft" >   < / 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 > *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a44229bb929d8949f3c2700d07123d224" > cache< / a > < / td > < / tr >
< tr class = "memdesc:a44229bb929d8949f3c2700d07123d224" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Hash root (uthash). NULL when empty. < 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 > 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 >
< / 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 >
< / 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" > ◆   < / a > < / span > cache< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > struct < a class = "el" href = "structCacheEntry.html" > CacheEntry< / a > * CacheHeader::cache< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< 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 >
2025-10-21 14:23:35 +01:00
< 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 > , and < a class = "el" href = "lru_8c_source.html#l00024" > find_in_cache()< / a > .< / p >
2025-10-11 01:35:43 +01:00
< / div >
< / div >
< a id = "ad3b962f8ce6c6115143cf581c7936e55" name = "ad3b962f8ce6c6115143cf581c7936e55" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ad3b962f8ce6c6115143cf581c7936e55" > ◆   < / a > < / span > max_items< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > uint64_t CacheHeader::max_items< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Hard limit for number of entries (policy: enforce/ignore depends on implementation). < / 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 >
2025-10-21 14:23:35 +01:00
< 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 >
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 = "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.14.0 < / li >
< / ul >
< / div >
< / body >
< / html >