aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2026-04-25 07:29:28 +00:00
Code Issues 3 Packages Projects Releases Wiki Activity
Files
devel
libaaruformat/docs/html/structFluxHeader.html

227 lines
13 KiB
HTML
Raw Permalink Normal View History

Update doxygen documentation.
2026-01-04 16:05:30 +00: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"/>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<meta name="generator" content="Doxygen 1.16.1"/>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: FluxHeader 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 -->
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<!-- Generated by Doxygen 1.16.1 -->
Update doxygen documentation.
2026-01-04 16:05:30 +00: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('structFluxHeader.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">FluxHeader Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Header structure for a FluxDataBlock containing flux capture metadata.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="flux_8h_source.html">aaruformat/structs/flux.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>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:a17794a3f0cc5b11a5169580cc510a71c" id="r_a17794a3f0cc5b11a5169580cc510a71c"><td class="memItemLeft">uint32_t&#160;</td><td class="memItemRight"><a class="el" href="#a17794a3f0cc5b11a5169580cc510a71c">identifier</a></td></tr>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
<tr class="memdesc:a17794a3f0cc5b11a5169580cc510a71c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block identifier, must be BlockType::FluxDataBlock (0x58554C46, "FLUX"). <br /></td></tr>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:a26f2a1be977dc973341e6952eba159dc" id="r_a26f2a1be977dc973341e6952eba159dc"><td class="memItemLeft">uint16_t&#160;</td><td class="memItemRight"><a class="el" href="#a26f2a1be977dc973341e6952eba159dc">entries</a></td></tr>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
<tr class="memdesc:a26f2a1be977dc973341e6952eba159dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of <a class="el" href="structFluxEntry.html" title="Metadata entry describing a single flux capture in the FluxDataBlock.">FluxEntry</a> records following this header. Maximum value: 65535. <br /></td></tr>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:a8e2f7fb0153155438629cda42cb6f329" id="r_a8e2f7fb0153155438629cda42cb6f329"><td class="memItemLeft">uint8_t&#160;</td><td class="memItemRight"><a class="el" href="#a8e2f7fb0153155438629cda42cb6f329">blockAlignmentShift</a></td></tr>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
<tr class="memdesc:a8e2f7fb0153155438629cda42cb6f329"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block alignment shift: 2^blockAlignmentShift = block alignment boundary in bytes. <br /></td></tr>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:a3980b9bf3db82de544c991cae4e6126a" id="r_a3980b9bf3db82de544c991cae4e6126a"><td class="memItemLeft">uint64_t&#160;</td><td class="memItemRight"><a class="el" href="#a3980b9bf3db82de544c991cae4e6126a">crc64</a></td></tr>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
<tr class="memdesc:a3980b9bf3db82de544c991cae4e6126a"><td class="mdescLeft">&#160;</td><td class="mdescRight">CRC64-ECMA checksum of the <a class="el" href="structFluxEntry.html" title="Metadata entry describing a single flux capture in the FluxDataBlock.">FluxEntry</a> array (header excluded). <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Header structure for a FluxDataBlock containing flux capture metadata. </p>
<p>This structure is the header of a FluxDataBlock, which lists all flux captures in the image. The block contains this header followed by an array of <a class="el" href="structFluxEntry.html" title="Metadata entry describing a single flux capture in the FluxDataBlock.">FluxEntry</a> structures, one for each flux capture.</p>
<p>The header includes a CRC64 checksum computed over the <a class="el" href="structFluxEntry.html" title="Metadata entry describing a single flux capture in the FluxDataBlock.">FluxEntry</a> array to ensure data integrity. The identifier field must match BlockType::FluxDataBlock (0x58554C46, "FLUX" in ASCII).</p>
<p>The blockAlignmentShift field stores the block alignment shift value used to decode the payloadOffset values in <a class="el" href="structFluxEntry.html" title="Metadata entry describing a single flux capture in the FluxDataBlock.">FluxEntry</a> structures. This makes the block self-contained, similar to DDT headers, allowing correct decoding of offsets without requiring access to the main image header.</p>
<dl class="section note"><dt>Note</dt><dd>Only one FluxDataBlock is allowed per image. </dd>
<dd>
The entries field is limited to UINT16_MAX (65535) captures per image. </dd>
<dd>
The blockAlignmentShift field is stored in the header to support reliable decoding of payloadOffset values, which are stored divided by (1 &lt;&lt; blockAlignmentShift). </dd></dl>
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00116">116</a> of file <a class="el" href="flux_8h_source.html">flux.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="a8e2f7fb0153155438629cda42cb6f329" name="a8e2f7fb0153155438629cda42cb6f329"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e2f7fb0153155438629cda42cb6f329">&#9670;&#160;</a></span>blockAlignmentShift</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t FluxHeader::blockAlignmentShift</td>
</tr>
</table>
</div><div class="memdoc">
<p>Block alignment shift: 2^blockAlignmentShift = block alignment boundary in bytes. </p>
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00120">120</a> of file <a class="el" href="flux_8h_source.html">flux.h</a>.</p>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l01258">aaruf_read_flux_capture()</a>, and <a class="el" href="close__write_8c_source.html#l05024">write_flux_blocks()</a>.</p>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
</div>
</div>
<a id="a3980b9bf3db82de544c991cae4e6126a" name="a3980b9bf3db82de544c991cae4e6126a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3980b9bf3db82de544c991cae4e6126a">&#9670;&#160;</a></span>crc64</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t FluxHeader::crc64</td>
</tr>
</table>
</div><div class="memdoc">
<p>CRC64-ECMA checksum of the <a class="el" href="structFluxEntry.html" title="Metadata entry describing a single flux capture in the FluxDataBlock.">FluxEntry</a> array (header excluded). </p>
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00121">121</a> of file <a class="el" href="flux_8h_source.html">flux.h</a>.</p>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l00602">aaruf_write_flux_capture()</a>, <a class="el" href="flux_8c_source.html#l00308">process_flux_data_block()</a>, and <a class="el" href="close__write_8c_source.html#l05024">write_flux_blocks()</a>.</p>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
</div>
</div>
<a id="a26f2a1be977dc973341e6952eba159dc" name="a26f2a1be977dc973341e6952eba159dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26f2a1be977dc973341e6952eba159dc">&#9670;&#160;</a></span>entries</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t FluxHeader::entries</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of <a class="el" href="structFluxEntry.html" title="Metadata entry describing a single flux capture in the FluxDataBlock.">FluxEntry</a> records following this header. Maximum value: 65535. </p>
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00119">119</a> of file <a class="el" href="flux_8h_source.html">flux.h</a>.</p>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l00483">aaruf_get_flux_captures()</a>, <a class="el" href="flux_8c_source.html#l01258">aaruf_read_flux_capture()</a>, <a class="el" href="flux_8c_source.html#l00602">aaruf_write_flux_capture()</a>, <a class="el" href="flux_8c_source.html#l00416">ensure_flux_entries_loaded()</a>, <a class="el" href="flux_8c_source.html#l00819">find_flux_entry_by_key()</a>, <a class="el" href="flux_8c_source.html#l00172">flux_map_rebuild_from_entries()</a>, <a class="el" href="flux_8c_source.html#l00308">process_flux_data_block()</a>, and <a class="el" href="close__write_8c_source.html#l05024">write_flux_blocks()</a>.</p>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
</div>
</div>
<a id="a17794a3f0cc5b11a5169580cc510a71c" name="a17794a3f0cc5b11a5169580cc510a71c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17794a3f0cc5b11a5169580cc510a71c">&#9670;&#160;</a></span>identifier</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t FluxHeader::identifier</td>
</tr>
</table>
</div><div class="memdoc">
<p>Block identifier, must be BlockType::FluxDataBlock (0x58554C46, "FLUX"). </p>
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00118">118</a> of file <a class="el" href="flux_8h_source.html">flux.h</a>.</p>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l00602">aaruf_write_flux_capture()</a>, <a class="el" href="flux_8c_source.html#l00308">process_flux_data_block()</a>, and <a class="el" href="close__write_8c_source.html#l05024">write_flux_blocks()</a>.</p>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/aaruformat/structs/<a class="el" href="flux_8h_source.html">flux.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="structFluxHeader.html">FluxHeader</a></li>
Update doxygen documentation.
2026-04-11 23:17:09 +01: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.16.1 </li>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink