Files
pcp/man/html/struct__vault__t.html

249 lines
12 KiB
HTML
Raw Normal View History

2014-02-20 20:09:24 +01:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>libpcp: _vault_t 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>
<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 style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libpcp
&#160;<span id="projectnumber">0.2.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="struct__vault__t-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">_vault_t Struct Reference<div class="ingroups"><a class="el" href="group__VAULT.html">VAULT</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>This structure represents a vault.
<a href="struct__vault__t.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="vault_8h_source.html">vault.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a0ac0cd4db869ca11128eeebf4e44ab1f"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__vault__t.html#a0ac0cd4db869ca11128eeebf4e44ab1f">filename</a></td></tr>
<tr class="memdesc:a0ac0cd4db869ca11128eeebf4e44ab1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The filename of the vault (full path) <a href="#a0ac0cd4db869ca11128eeebf4e44ab1f"></a><br/></td></tr>
<tr class="separator:a0ac0cd4db869ca11128eeebf4e44ab1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb36f1f7c2c1a5ee5dfa15e0047a851c"><td class="memItemLeft" align="right" valign="top">FILE *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__vault__t.html#aeb36f1f7c2c1a5ee5dfa15e0047a851c">fd</a></td></tr>
<tr class="memdesc:aeb36f1f7c2c1a5ee5dfa15e0047a851c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Filehandle if opened. <a href="#aeb36f1f7c2c1a5ee5dfa15e0047a851c"></a><br/></td></tr>
<tr class="separator:aeb36f1f7c2c1a5ee5dfa15e0047a851c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabb4ba4d964189e84e80b843abe8b7bf"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__vault__t.html#aabb4ba4d964189e84e80b843abe8b7bf">unsafed</a></td></tr>
<tr class="memdesc:aabb4ba4d964189e84e80b843abe8b7bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flag to tell if the file needs to be written. <a href="#aabb4ba4d964189e84e80b843abe8b7bf"></a><br/></td></tr>
<tr class="separator:aabb4ba4d964189e84e80b843abe8b7bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada18cb30c8ef3aa4976b431a99a1d170"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__vault__t.html#ada18cb30c8ef3aa4976b431a99a1d170">isnew</a></td></tr>
<tr class="memdesc:ada18cb30c8ef3aa4976b431a99a1d170"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flag to tell if the vault has been newly created. <a href="#ada18cb30c8ef3aa4976b431a99a1d170"></a><br/></td></tr>
<tr class="separator:ada18cb30c8ef3aa4976b431a99a1d170"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aedf5d37e686a68b527bf44534398e113"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__vault__t.html#aedf5d37e686a68b527bf44534398e113">size</a></td></tr>
<tr class="memdesc:aedf5d37e686a68b527bf44534398e113"><td class="mdescLeft">&#160;</td><td class="mdescRight">Filesize. <a href="#aedf5d37e686a68b527bf44534398e113"></a><br/></td></tr>
<tr class="separator:aedf5d37e686a68b527bf44534398e113"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f8062cda1f43dacd6960c6edf7317f3"><td class="memItemLeft" align="right" valign="top">time_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__vault__t.html#a6f8062cda1f43dacd6960c6edf7317f3">modified</a></td></tr>
<tr class="memdesc:a6f8062cda1f43dacd6960c6edf7317f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">mtime <a href="#a6f8062cda1f43dacd6960c6edf7317f3"></a><br/></td></tr>
<tr class="separator:a6f8062cda1f43dacd6960c6edf7317f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a763b363f077e9656ecb4dc2c58ad006b"><td class="memItemLeft" align="right" valign="top">mode_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__vault__t.html#a763b363f077e9656ecb4dc2c58ad006b">mode</a></td></tr>
<tr class="memdesc:a763b363f077e9656ecb4dc2c58ad006b"><td class="mdescLeft">&#160;</td><td class="mdescRight">File mode. <a href="#a763b363f077e9656ecb4dc2c58ad006b"></a><br/></td></tr>
<tr class="separator:a763b363f077e9656ecb4dc2c58ad006b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c19b6b1629efb8504272bbeb62d97ed"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__vault__t.html#a3c19b6b1629efb8504272bbeb62d97ed">version</a></td></tr>
<tr class="memdesc:a3c19b6b1629efb8504272bbeb62d97ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vault version. <a href="#a3c19b6b1629efb8504272bbeb62d97ed"></a><br/></td></tr>
<tr class="separator:a3c19b6b1629efb8504272bbeb62d97ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39fb3dfd4fe6aaafdbfb9a3e88f4f09e"><td class="memItemLeft" align="right" valign="top">byte&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__vault__t.html#a39fb3dfd4fe6aaafdbfb9a3e88f4f09e">checksum</a> [32]</td></tr>
<tr class="memdesc:a39fb3dfd4fe6aaafdbfb9a3e88f4f09e"><td class="mdescLeft">&#160;</td><td class="mdescRight">SHA256 checksum over the whole vault. <a href="#a39fb3dfd4fe6aaafdbfb9a3e88f4f09e"></a><br/></td></tr>
<tr class="separator:a39fb3dfd4fe6aaafdbfb9a3e88f4f09e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This structure represents a vault. </p>
<p>Definition at line <a class="el" href="vault_8h_source.html#l00095">95</a> of file <a class="el" href="vault_8h_source.html">vault.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a39fb3dfd4fe6aaafdbfb9a3e88f4f09e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">byte _vault_t::checksum[32]</td>
</tr>
</table>
</div><div class="memdoc">
<p>SHA256 checksum over the whole vault. </p>
<p>Definition at line <a class="el" href="vault_8h_source.html#l00104">104</a> of file <a class="el" href="vault_8h_source.html">vault.h</a>.</p>
</div>
</div>
<a class="anchor" id="aeb36f1f7c2c1a5ee5dfa15e0047a851c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FILE* _vault_t::fd</td>
</tr>
</table>
</div><div class="memdoc">
<p>Filehandle if opened. </p>
<p>Definition at line <a class="el" href="vault_8h_source.html#l00097">97</a> of file <a class="el" href="vault_8h_source.html">vault.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0ac0cd4db869ca11128eeebf4e44ab1f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* _vault_t::filename</td>
</tr>
</table>
</div><div class="memdoc">
<p>The filename of the vault (full path) </p>
<p>Definition at line <a class="el" href="vault_8h_source.html#l00096">96</a> of file <a class="el" href="vault_8h_source.html">vault.h</a>.</p>
</div>
</div>
<a class="anchor" id="ada18cb30c8ef3aa4976b431a99a1d170"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t _vault_t::isnew</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flag to tell if the vault has been newly created. </p>
<p>Definition at line <a class="el" href="vault_8h_source.html#l00099">99</a> of file <a class="el" href="vault_8h_source.html">vault.h</a>.</p>
</div>
</div>
<a class="anchor" id="a763b363f077e9656ecb4dc2c58ad006b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mode_t _vault_t::mode</td>
</tr>
</table>
</div><div class="memdoc">
<p>File mode. </p>
<p>Definition at line <a class="el" href="vault_8h_source.html#l00102">102</a> of file <a class="el" href="vault_8h_source.html">vault.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6f8062cda1f43dacd6960c6edf7317f3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">time_t _vault_t::modified</td>
</tr>
</table>
</div><div class="memdoc">
<p>mtime </p>
<p>Definition at line <a class="el" href="vault_8h_source.html#l00101">101</a> of file <a class="el" href="vault_8h_source.html">vault.h</a>.</p>
</div>
</div>
<a class="anchor" id="aedf5d37e686a68b527bf44534398e113"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t _vault_t::size</td>
</tr>
</table>
</div><div class="memdoc">
<p>Filesize. </p>
<p>Definition at line <a class="el" href="vault_8h_source.html#l00100">100</a> of file <a class="el" href="vault_8h_source.html">vault.h</a>.</p>
</div>
</div>
<a class="anchor" id="aabb4ba4d964189e84e80b843abe8b7bf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t _vault_t::unsafed</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flag to tell if the file needs to be written. </p>
<p>Definition at line <a class="el" href="vault_8h_source.html#l00098">98</a> of file <a class="el" href="vault_8h_source.html">vault.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3c19b6b1629efb8504272bbeb62d97ed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t _vault_t::version</td>
</tr>
</table>
</div><div class="memdoc">
<p>Vault version. </p>
<p>Definition at line <a class="el" href="vault_8h_source.html#l00103">103</a> of file <a class="el" href="vault_8h_source.html">vault.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="vault_8h_source.html">vault.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
2014-02-20 21:02:52 +01:00
Generated on Thu Feb 20 2014 20:58:12 for libpcp by &#160;<a href="http://www.doxygen.org/index.html">
2014-02-20 20:09:24 +01:00
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.2
</small></address>
</body>
</html>