-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAIODiskFile_8h_source.html
More file actions
192 lines (190 loc) · 20.2 KB
/
AIODiskFile_8h_source.html
File metadata and controls
192 lines (190 loc) · 20.2 KB
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
<!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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Squid Web Cache: squid/src/DiskIO/AIO/AIODiskFile.h Source File</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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">Squid Web Cache<span id="projectnumber"> master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
</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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('AIODiskFile_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<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">AIODiskFile.h</div></div>
</div><!--header-->
<div class="contents">
<a href="AIODiskFile_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Copyright (C) 1996-2026 The Squid Software Foundation and contributors</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * Squid software is distributed under GPLv2+ license and includes</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * contributions from numerous individuals and organizations.</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * Please see the COPYING and CONTRIBUTORS files for details.</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> */</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#ifndef SQUID_SRC_DISKIO_AIO_AIODISKFILE_H</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#define SQUID_SRC_DISKIO_AIO_AIODISKFILE_H</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#if HAVE_DISKIO_MODULE_AIO</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include "<a class="code" href="cbdata_8h.html">cbdata.h</a>"</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include "<a class="code" href="async__io_8h.html">DiskIO/AIO/async_io.h</a>"</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include "<a class="code" href="DiskFile_8h.html">DiskIO/DiskFile.h</a>"</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include "<a class="code" href="SquidString_8h.html">SquidString.h</a>"</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="keyword">class </span>AIODiskIOStrategy;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keyword">class </span>AIODiskFile : <span class="keyword">public</span> <a class="code hl_class" href="classDiskFile.html">DiskFile</a></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span>{</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <a class="code hl_define" href="cbdata_8h.html#abfcdfa870c3f1e87ced73a4c5f196168">CBDATA_CLASS</a>(AIODiskFile);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">friend</span> <span class="keyword">class </span>AIODiskIOStrategy;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> AIODiskFile (<span class="keywordtype">char</span> <span class="keyword">const</span> *path, AIODiskIOStrategy *);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> ~AIODiskFile() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// XXX: the code has this as "IORequestor::Pointer callback"</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classDiskFile.html#a7f5078ec6181586251ea16253647c69b">open</a>(<span class="keywordtype">int</span> flags, <a class="code hl_typedef" href="types_8h.html#a51b5bca3280ca743227e9b07c4f839a1">mode_t</a> mode, <a class="code hl_class" href="classRefCount.html">RefCount<IORequestor></a> callback) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classDiskFile.html#af5e137fbab2e0521ce996456cab082b6">create</a> (<span class="keywordtype">int</span>, <a class="code hl_typedef" href="types_8h.html#a51b5bca3280ca743227e9b07c4f839a1">mode_t</a>, <a class="code hl_class" href="classRefCount.html">RefCount<IORequestor></a>) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classDiskFile.html#a463ab5876377af650717a5d13dc00c6d">read</a>(<a class="code hl_class" href="classReadRequest.html">ReadRequest</a> *) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classDiskFile.html#aef224bbc0a0c883b91594a2b1feaf132">write</a>(<a class="code hl_class" href="classWriteRequest.html">WriteRequest</a> *) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classDiskFile.html#a4a8f127f9ab283ff4d914419a019c7bf">close</a> () <span class="keyword">override</span>;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classDiskFile.html#a99dc1fec9d1dc2c92a1ceb6841a306f7">canRead</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classDiskFile.html#ab2ace4442a9edd04f5f50ea4a856184a">canWrite</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="comment">/* During migration only */</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">int</span> <a class="code hl_function" href="classDiskFile.html#a9880decb3ee99579386d1af011708933">getFD</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classDiskFile.html#afffecc0bd7c9a10ecb17851767cdbdd3">error</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="comment">/* Inform callers if there is IO in progress */</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classDiskFile.html#a685824a0ccacf2fad50fe36d2b35ac4b">ioInProgress</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classDiskFile.html#afffecc0bd7c9a10ecb17851767cdbdd3">error</a>(<span class="keywordtype">bool</span> <span class="keyword">const</span> &);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keywordtype">int</span> fd;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <a class="code hl_class" href="classString.html">String</a> path;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> AIODiskIOStrategy *strategy;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <a class="code hl_class" href="classRefCount.html">RefCount<IORequestor></a> ioRequestor;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordtype">bool</span> closed;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordtype">bool</span> error_;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>};</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="preprocessor">#endif </span><span class="comment">/* HAVE_DISKIO_MODULE_AIO */</span><span class="preprocessor"></span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="preprocessor">#endif </span><span class="comment">/* SQUID_SRC_DISKIO_AIO_AIODISKFILE_H */</span><span class="preprocessor"></span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="ttc" id="aDiskFile_8h_html"><div class="ttname"><a href="DiskFile_8h.html">DiskFile.h</a></div></div>
<div class="ttc" id="aSquidString_8h_html"><div class="ttname"><a href="SquidString_8h.html">SquidString.h</a></div></div>
<div class="ttc" id="aasync__io_8h_html"><div class="ttname"><a href="async__io_8h.html">async_io.h</a></div></div>
<div class="ttc" id="acbdata_8h_html"><div class="ttname"><a href="cbdata_8h.html">cbdata.h</a></div></div>
<div class="ttc" id="acbdata_8h_html_abfcdfa870c3f1e87ced73a4c5f196168"><div class="ttname"><a href="cbdata_8h.html#abfcdfa870c3f1e87ced73a4c5f196168">CBDATA_CLASS</a></div><div class="ttdeci">#define CBDATA_CLASS(type)</div><div class="ttdef"><b>Definition</b> <a href="cbdata_8h_source.html#l00289">cbdata.h:289</a></div></div>
<div class="ttc" id="aclassDiskFile_html"><div class="ttname"><a href="classDiskFile.html">DiskFile</a></div><div class="ttdef"><b>Definition</b> <a href="DiskFile_8h_source.html#l00021">DiskFile.h:22</a></div></div>
<div class="ttc" id="aclassDiskFile_html_a463ab5876377af650717a5d13dc00c6d"><div class="ttname"><a href="classDiskFile.html#a463ab5876377af650717a5d13dc00c6d">DiskFile::read</a></div><div class="ttdeci">virtual void read(ReadRequest *)=0</div></div>
<div class="ttc" id="aclassDiskFile_html_a4a8f127f9ab283ff4d914419a019c7bf"><div class="ttname"><a href="classDiskFile.html#a4a8f127f9ab283ff4d914419a019c7bf">DiskFile::close</a></div><div class="ttdeci">virtual void close()=0</div></div>
<div class="ttc" id="aclassDiskFile_html_a685824a0ccacf2fad50fe36d2b35ac4b"><div class="ttname"><a href="classDiskFile.html#a685824a0ccacf2fad50fe36d2b35ac4b">DiskFile::ioInProgress</a></div><div class="ttdeci">virtual bool ioInProgress() const =0</div></div>
<div class="ttc" id="aclassDiskFile_html_a7f5078ec6181586251ea16253647c69b"><div class="ttname"><a href="classDiskFile.html#a7f5078ec6181586251ea16253647c69b">DiskFile::open</a></div><div class="ttdeci">virtual void open(int flags, mode_t mode, RefCount< IORequestor > callback)=0</div></div>
<div class="ttc" id="aclassDiskFile_html_a9880decb3ee99579386d1af011708933"><div class="ttname"><a href="classDiskFile.html#a9880decb3ee99579386d1af011708933">DiskFile::getFD</a></div><div class="ttdeci">virtual int getFD() const</div><div class="ttdef"><b>Definition</b> <a href="DiskFile_8h_source.html#l00053">DiskFile.h:53</a></div></div>
<div class="ttc" id="aclassDiskFile_html_a99dc1fec9d1dc2c92a1ceb6841a306f7"><div class="ttname"><a href="classDiskFile.html#a99dc1fec9d1dc2c92a1ceb6841a306f7">DiskFile::canRead</a></div><div class="ttdeci">virtual bool canRead() const =0</div></div>
<div class="ttc" id="aclassDiskFile_html_ab2ace4442a9edd04f5f50ea4a856184a"><div class="ttname"><a href="classDiskFile.html#ab2ace4442a9edd04f5f50ea4a856184a">DiskFile::canWrite</a></div><div class="ttdeci">virtual bool canWrite() const</div><div class="ttdef"><b>Definition</b> <a href="DiskFile_8h_source.html#l00050">DiskFile.h:50</a></div></div>
<div class="ttc" id="aclassDiskFile_html_aef224bbc0a0c883b91594a2b1feaf132"><div class="ttname"><a href="classDiskFile.html#aef224bbc0a0c883b91594a2b1feaf132">DiskFile::write</a></div><div class="ttdeci">virtual void write(WriteRequest *)=0</div></div>
<div class="ttc" id="aclassDiskFile_html_af5e137fbab2e0521ce996456cab082b6"><div class="ttname"><a href="classDiskFile.html#af5e137fbab2e0521ce996456cab082b6">DiskFile::create</a></div><div class="ttdeci">virtual void create(int flags, mode_t mode, RefCount< IORequestor > callback)=0</div></div>
<div class="ttc" id="aclassDiskFile_html_afffecc0bd7c9a10ecb17851767cdbdd3"><div class="ttname"><a href="classDiskFile.html#afffecc0bd7c9a10ecb17851767cdbdd3">DiskFile::error</a></div><div class="ttdeci">virtual bool error() const =0</div></div>
<div class="ttc" id="aclassReadRequest_html"><div class="ttname"><a href="classReadRequest.html">ReadRequest</a></div><div class="ttdef"><b>Definition</b> <a href="ReadRequest_8h_source.html#l00015">ReadRequest.h:16</a></div></div>
<div class="ttc" id="aclassRefCount_html"><div class="ttname"><a href="classRefCount.html">RefCount</a></div><div class="ttdef"><b>Definition</b> <a href="RefCount_8h_source.html#l00027">RefCount.h:28</a></div></div>
<div class="ttc" id="aclassString_html"><div class="ttname"><a href="classString.html">String</a></div><div class="ttdef"><b>Definition</b> <a href="SquidString_8h_source.html#l00026">SquidString.h:27</a></div></div>
<div class="ttc" id="aclassWriteRequest_html"><div class="ttname"><a href="classWriteRequest.html">WriteRequest</a></div><div class="ttdef"><b>Definition</b> <a href="WriteRequest_8h_source.html#l00016">WriteRequest.h:17</a></div></div>
<div class="ttc" id="atypes_8h_html_a51b5bca3280ca743227e9b07c4f839a1"><div class="ttname"><a href="types_8h.html#a51b5bca3280ca743227e9b07c4f839a1">mode_t</a></div><div class="ttdeci">unsigned short mode_t</div><div class="ttdef"><b>Definition</b> <a href="types_8h_source.html#l00129">types.h:129</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_3c69fff7f634b97773a4d39d4565ffb4.html">squid</a></li><li class="navelem"><a class="el" href="dir_27a06220d184fcc3bd2c56b7794ae45b.html">src</a></li><li class="navelem"><a class="el" href="dir_a709f1c13cdcc3dd32e0e7a9b41904a5.html">DiskIO</a></li><li class="navelem"><a class="el" href="dir_00ac3609e649083ce7dbcd7adfb9d952.html">AIO</a></li><li class="navelem"><a class="el" href="AIODiskFile_8h.html">AIODiskFile.h</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.9.8 </li>
</ul>
</div>
</body>
</html>