aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2026-07-11 03:16:30 +00:00
Code Issues 3 Packages Projects Releases Wiki Activity
Files
devel
libaaruformat/docs/html/structFluxCaptureRecord.html

246 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: FluxCaptureRecord 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('structFluxCaptureRecord.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">FluxCaptureRecord Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Internal structure for storing flux capture data during write mode.
<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:a002dbda89d68adac0d0a8281d34fc76a" id="r_a002dbda89d68adac0d0a8281d34fc76a"><td class="memItemLeft"><a class="el" href="structFluxEntry.html">FluxEntry</a>&#160;</td><td class="memItemRight"><a class="el" href="#a002dbda89d68adac0d0a8281d34fc76a">entry</a></td></tr>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
<tr class="memdesc:a002dbda89d68adac0d0a8281d34fc76a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flux entry metadata describing this capture. <br /></td></tr>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:afd9cf94122b9f59c548cda29599f8047" id="r_afd9cf94122b9f59c548cda29599f8047"><td class="memItemLeft">uint8_t *&#160;</td><td class="memItemRight"><a class="el" href="#afd9cf94122b9f59c548cda29599f8047">data_buffer</a></td></tr>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
<tr class="memdesc:afd9cf94122b9f59c548cda29599f8047"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to the flux data buffer. Owned by the utarray, freed automatically. <br /></td></tr>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:a9563435372ecc4af506c4fae2ac2f617" id="r_a9563435372ecc4af506c4fae2ac2f617"><td class="memItemLeft">uint32_t&#160;</td><td class="memItemRight"><a class="el" href="#a9563435372ecc4af506c4fae2ac2f617">data_length</a></td></tr>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
<tr class="memdesc:a9563435372ecc4af506c4fae2ac2f617"><td class="mdescLeft">&#160;</td><td class="mdescRight">Length of the data buffer in bytes. <br /></td></tr>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:af5bce1443f5112ce65f54c39ff873b57" id="r_af5bce1443f5112ce65f54c39ff873b57"><td class="memItemLeft">uint8_t *&#160;</td><td class="memItemRight"><a class="el" href="#af5bce1443f5112ce65f54c39ff873b57">index_buffer</a></td></tr>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
<tr class="memdesc:af5bce1443f5112ce65f54c39ff873b57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to the flux index buffer. Owned by the utarray, freed automatically. <br /></td></tr>
Update doxygen documentation.
2026-04-11 23:17:09 +01:00
<tr class="memitem:adcf7766ac4311fe79a1324f2eec6868d" id="r_adcf7766ac4311fe79a1324f2eec6868d"><td class="memItemLeft">uint32_t&#160;</td><td class="memItemRight"><a class="el" href="#adcf7766ac4311fe79a1324f2eec6868d">index_length</a></td></tr>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
<tr class="memdesc:adcf7766ac4311fe79a1324f2eec6868d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Length of the index buffer in bytes. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Internal structure for storing flux capture data during write mode. </p>
<p>This structure is used internally by the library to store flux capture data in memory before it is written to the image. It combines the <a class="el" href="structFluxEntry.html" title="Metadata entry describing a single flux capture in the FluxDataBlock.">FluxEntry</a> metadata with pointers to the actual data and index buffers.</p>
<p>The structure is stored in a utarray (ctx-&gt;flux_captures) during write mode, and the buffers are freed automatically when the record is removed from the array or when the array is freed.</p>
<dl class="section note"><dt>Note</dt><dd>This structure is used internally and is not part of the public API. </dd>
<dd>
The data_buffer and index_buffer are owned by the utarray and are freed automatically via the <a class="el" href="flux_8c.html#a548a8cb21d02fded8a5084c96bbf5e30" title="Destructor callback for FluxCaptureRecord elements in a utarray.">flux_capture_record_dtor()</a> destructor. </dd></dl>
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00270">270</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="afd9cf94122b9f59c548cda29599f8047" name="afd9cf94122b9f59c548cda29599f8047"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd9cf94122b9f59c548cda29599f8047">&#9670;&#160;</a></span>data_buffer</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* FluxCaptureRecord::data_buffer</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to the flux data buffer. Owned by the utarray, freed automatically. </p>
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00273">273</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#l00055">flux_capture_record_dtor()</a>, and <a class="el" href="close__write_8c_source.html#l04609">write_flux_capture_payload()</a>.</p>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
</div>
</div>
<a id="a9563435372ecc4af506c4fae2ac2f617" name="a9563435372ecc4af506c4fae2ac2f617"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9563435372ecc4af506c4fae2ac2f617">&#9670;&#160;</a></span>data_length</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t FluxCaptureRecord::data_length</td>
</tr>
</table>
</div><div class="memdoc">
<p>Length of the data buffer in bytes. </p>
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00274">274</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>, and <a class="el" href="close__write_8c_source.html#l04609">write_flux_capture_payload()</a>.</p>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
</div>
</div>
<a id="a002dbda89d68adac0d0a8281d34fc76a" name="a002dbda89d68adac0d0a8281d34fc76a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a002dbda89d68adac0d0a8281d34fc76a">&#9670;&#160;</a></span>entry</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structFluxEntry.html">FluxEntry</a> FluxCaptureRecord::entry</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flux entry metadata describing this capture. </p>
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00272">272</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>, and <a class="el" href="close__write_8c_source.html#l04609">write_flux_capture_payload()</a>.</p>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
</div>
</div>
<a id="af5bce1443f5112ce65f54c39ff873b57" name="af5bce1443f5112ce65f54c39ff873b57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5bce1443f5112ce65f54c39ff873b57">&#9670;&#160;</a></span>index_buffer</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* FluxCaptureRecord::index_buffer</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to the flux index buffer. Owned by the utarray, freed automatically. </p>
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00275">275</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#l00055">flux_capture_record_dtor()</a>, and <a class="el" href="close__write_8c_source.html#l04609">write_flux_capture_payload()</a>.</p>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
</div>
</div>
<a id="adcf7766ac4311fe79a1324f2eec6868d" name="adcf7766ac4311fe79a1324f2eec6868d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adcf7766ac4311fe79a1324f2eec6868d">&#9670;&#160;</a></span>index_length</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t FluxCaptureRecord::index_length</td>
</tr>
</table>
</div><div class="memdoc">
<p>Length of the index buffer in bytes. </p>
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00276">276</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>, and <a class="el" href="close__write_8c_source.html#l04609">write_flux_capture_payload()</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="structFluxCaptureRecord.html">FluxCaptureRecord</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