/usr/share/doc/liblzma-doc/html/mytime_8c.html is in liblzma-doc 5.2.2-1.2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 | <!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"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>XZ Utils: xz/mytime.c File 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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">XZ Utils
 <span id="projectnumber">5.2.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_53e01eec41348db90f08d9ee7e6793af.html">xz</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">mytime.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Time handling functions.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="private_8h.html">private.h</a>"</code><br />
<code>#include <sys/time.h></code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aa88d8754572c09d04f39023b7532a669"><td class="memItemLeft" align="right" valign="top">static uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="mytime_8c.html#aa88d8754572c09d04f39023b7532a669">mytime_now</a> (void)</td></tr>
<tr class="memdesc:aa88d8754572c09d04f39023b7532a669"><td class="mdescLeft"> </td><td class="mdescRight">Get the current time as milliseconds. <a href="#aa88d8754572c09d04f39023b7532a669">More...</a><br /></td></tr>
<tr class="separator:aa88d8754572c09d04f39023b7532a669"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abc987b617c3d37bb64f26e2e6a1047f8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mytime_8c.html#abc987b617c3d37bb64f26e2e6a1047f8">mytime_set_start_time</a> (void)</td></tr>
<tr class="memdesc:abc987b617c3d37bb64f26e2e6a1047f8"><td class="mdescLeft"> </td><td class="mdescRight">Store the time when (de)compression was started. <a href="#abc987b617c3d37bb64f26e2e6a1047f8">More...</a><br /></td></tr>
<tr class="separator:abc987b617c3d37bb64f26e2e6a1047f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1cbb67212ba8955425ec3ae30f854964"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="mytime_8c.html#a1cbb67212ba8955425ec3ae30f854964">mytime_get_elapsed</a> (void)</td></tr>
<tr class="memdesc:a1cbb67212ba8955425ec3ae30f854964"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of milliseconds since the operation started. <a href="#a1cbb67212ba8955425ec3ae30f854964">More...</a><br /></td></tr>
<tr class="separator:a1cbb67212ba8955425ec3ae30f854964"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade93cf3cf43b05f8cb67474ad7d7589f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mytime_8c.html#ade93cf3cf43b05f8cb67474ad7d7589f">mytime_set_flush_time</a> (void)</td></tr>
<tr class="memdesc:ade93cf3cf43b05f8cb67474ad7d7589f"><td class="mdescLeft"> </td><td class="mdescRight">Store the time of when compressor was flushed. <a href="#ade93cf3cf43b05f8cb67474ad7d7589f">More...</a><br /></td></tr>
<tr class="separator:ade93cf3cf43b05f8cb67474ad7d7589f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab0193efe1ad07b8eef17bbf712fbe788"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="mytime_8c.html#ab0193efe1ad07b8eef17bbf712fbe788">mytime_get_flush_timeout</a> (void)</td></tr>
<tr class="memdesc:ab0193efe1ad07b8eef17bbf712fbe788"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of milliseconds until the next flush. <a href="#ab0193efe1ad07b8eef17bbf712fbe788">More...</a><br /></td></tr>
<tr class="separator:ab0193efe1ad07b8eef17bbf712fbe788"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a8c313eb268d319b6a5e538628049333a"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="mytime_8c.html#a8c313eb268d319b6a5e538628049333a">opt_flush_timeout</a> = 0</td></tr>
<tr class="memdesc:a8c313eb268d319b6a5e538628049333a"><td class="mdescLeft"> </td><td class="mdescRight">Number of milliseconds to between LZMA_SYNC_FLUSHes. <a href="#a8c313eb268d319b6a5e538628049333a">More...</a><br /></td></tr>
<tr class="separator:a8c313eb268d319b6a5e538628049333a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6d388eefb45931239a4c197f6f70899"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="mytime_8c.html#ab6d388eefb45931239a4c197f6f70899">flush_needed</a></td></tr>
<tr class="memdesc:ab6d388eefb45931239a4c197f6f70899"><td class="mdescLeft"> </td><td class="mdescRight">True when flushing is needed due to expired timeout. <a href="#ab6d388eefb45931239a4c197f6f70899">More...</a><br /></td></tr>
<tr class="separator:ab6d388eefb45931239a4c197f6f70899"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b11efea935978e9f1913e964a5e5396"><td class="memItemLeft" align="right" valign="top"><a id="a5b11efea935978e9f1913e964a5e5396"></a>
static uint64_t </td><td class="memItemRight" valign="bottom"><b>start_time</b></td></tr>
<tr class="separator:a5b11efea935978e9f1913e964a5e5396"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6b93fa2981864c6e2f0358edfa88897"><td class="memItemLeft" align="right" valign="top"><a id="af6b93fa2981864c6e2f0358edfa88897"></a>
static uint64_t </td><td class="memItemRight" valign="bottom"><b>next_flush</b></td></tr>
<tr class="separator:af6b93fa2981864c6e2f0358edfa88897"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Time handling functions. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="aa88d8754572c09d04f39023b7532a669"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa88d8754572c09d04f39023b7532a669">§ </a></span>mytime_now()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static uint64_t mytime_now </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current time as milliseconds. </p>
<p>It's relative to some point but not necessarily to the UNIX Epoch. </p>
<p>Referenced by <a class="el" href="mytime_8h.html#a1cbb67212ba8955425ec3ae30f854964">mytime_get_elapsed()</a>.</p>
</div>
</div>
<a id="abc987b617c3d37bb64f26e2e6a1047f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc987b617c3d37bb64f26e2e6a1047f8">§ </a></span>mytime_set_start_time()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mytime_set_start_time </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Store the time when (de)compression was started. </p>
<p>The start time is also stored as the time of the first flush. </p>
</div>
</div>
<a id="a1cbb67212ba8955425ec3ae30f854964"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1cbb67212ba8955425ec3ae30f854964">§ </a></span>mytime_get_elapsed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t mytime_get_elapsed </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of milliseconds since the operation started. </p>
<p>References <a class="el" href="mytime_8c.html#aa88d8754572c09d04f39023b7532a669">mytime_now()</a>.</p>
<p>Referenced by <a class="el" href="message_8h.html#abc7b1a649494177507246554d2d6d6ef">message_progress_update()</a>.</p>
</div>
</div>
<a id="ade93cf3cf43b05f8cb67474ad7d7589f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade93cf3cf43b05f8cb67474ad7d7589f">§ </a></span>mytime_set_flush_time()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mytime_set_flush_time </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Store the time of when compressor was flushed. </p>
</div>
</div>
<a id="ab0193efe1ad07b8eef17bbf712fbe788"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0193efe1ad07b8eef17bbf712fbe788">§ </a></span>mytime_get_flush_timeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mytime_get_flush_timeout </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of milliseconds until the next flush. </p>
<p>This returns -1 if no timed flushing is used.</p>
<p>The return value is inteded for use with poll(). </p>
<p>References <a class="el" href="mytime_8c.html#a8c313eb268d319b6a5e538628049333a">opt_flush_timeout</a>, and <a class="el" href="coder_8c.html#aed58b2945b6b414405af58615ca823b6">opt_mode</a>.</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a8c313eb268d319b6a5e538628049333a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c313eb268d319b6a5e538628049333a">§ </a></span>opt_flush_timeout</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t opt_flush_timeout = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of milliseconds to between LZMA_SYNC_FLUSHes. </p>
<p>If 0, timed flushing is disabled. Otherwise if no more input is available and not at the end of the file and at least opt_flush_timeout milliseconds has elapsed since the start of compression or the previous flushing (LZMA_SYNC_FLUSH or LZMA_FULL_FLUSH), set LZMA_SYNC_FLUSH to flush the pending data. </p>
<p>Referenced by <a class="el" href="mytime_8h.html#ab0193efe1ad07b8eef17bbf712fbe788">mytime_get_flush_timeout()</a>.</p>
</div>
</div>
<a id="ab6d388eefb45931239a4c197f6f70899"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6d388eefb45931239a4c197f6f70899">§ </a></span>flush_needed</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool flush_needed</td>
</tr>
</table>
</div><div class="memdoc">
<p>True when flushing is needed due to expired timeout. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
|