aboutsummaryrefslogtreecommitdiff
path: root/doc/oscl_html/oscl__file__io_8h_source.html
blob: 9134b4b4621ae0edbfa8ad7be615e948f05ed2f2 (plain)
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
<!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"/>
<title>oscl: oscl_file_io.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<h1>oscl_file_io.h</h1><a href="oscl__file__io_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// -*- c++ -*-</span>
<a name="l00002"></a>00002 <span class="comment">// = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =</span>
<a name="l00003"></a>00003 
<a name="l00004"></a>00004 <span class="comment">//                     O S C L _ F I L E  _ I O</span>
<a name="l00005"></a>00005 
<a name="l00006"></a>00006 <span class="comment">// = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =</span>
<a name="l00007"></a>00007 
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef OSCL_FILE_IO_H_INCLUDED</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define OSCL_FILE_IO_H_INCLUDED</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024 <span class="preprocessor">#ifndef OSCLCONFIG_IO_H_INCLUDED</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="osclconfig__io_8h.html" title="This file contains common typedefs based on the ANSI C limits.h header.">osclconfig_io.h</a>&quot;</span>
<a name="l00026"></a>00026 <span class="preprocessor">#endif</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef OSCL_BASE_H_INCLUDED</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="oscl__base_8h.html" title="The file oscl_base.h is the public header that should be included to pick up the...">oscl_base.h</a>&quot;</span>
<a name="l00030"></a>00030 <span class="preprocessor">#endif</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span>
<a name="l00032"></a>00032 <span class="preprocessor">#ifndef OSCL_MEM_H_INCLUDED</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="oscl__mem_8h.html" title="This file contains basic memory definitions for common use across platforms.">oscl_mem.h</a>&quot;</span>
<a name="l00034"></a>00034 <span class="preprocessor">#endif</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span>
<a name="l00036"></a>00036 <span class="preprocessor">#ifndef OSCL_VECTOR_H_INCLUDED</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="oscl__vector_8h.html" title="The file oscl_vector.h defines the template class Oscl_Vector which has a very similar...">oscl_vector.h</a>&quot;</span>
<a name="l00038"></a>00038 <span class="preprocessor">#endif</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span>
<a name="l00047"></a>00047 <span class="keyword">class </span><a class="code" href="classPVLogger.html">PVLogger</a>;
<a name="l00048"></a>00048 <span class="keyword">class </span><a class="code" href="classOsclFileCache.html">OsclFileCache</a>;
<a name="l00049"></a>00049 <span class="keyword">class </span><a class="code" href="classOsclFileCacheBuffer.html">OsclFileCacheBuffer</a>;
<a name="l00050"></a>00050 <span class="keyword">class </span><a class="code" href="classOscl__FileServer.html">Oscl_FileServer</a>;
<a name="l00051"></a>00051 <span class="keyword">class </span><a class="code" href="classOsclFileHandle.html">OsclFileHandle</a>;
<a name="l00052"></a>00052 <span class="keyword">class </span><a class="code" href="classOsclNativeFile.html">OsclNativeFile</a>;
<a name="l00053"></a>00053 <span class="keyword">class </span><a class="code" href="classOsclFileStats.html">OsclFileStats</a>;
<a name="l00054"></a>00054 <span class="keyword">class </span><a class="code" href="classOsclNativeFileParams.html">OsclNativeFileParams</a>;
<a name="l00055"></a>00055 <span class="keyword">class </span><a class="code" href="classOsclAsyncFile.html">OsclAsyncFile</a>;
<a name="l00056"></a><a class="code" href="group__osclio.html#ga32797bf7b13b0e5a52c356af13a4eebb">00056</a> <span class="preprocessor">#define TOsclFileOffsetInt32 int32</span>
<a name="l00057"></a>00057 <span class="preprocessor"></span>
<a name="l00058"></a><a class="code" href="classOscl__File.html">00058</a> <span class="keyword">class </span><a class="code" href="classOscl__File.html">Oscl_File</a> : <span class="keyword">public</span> <a class="code" href="classHeapBase.html">HeapBase</a>
<a name="l00059"></a>00059 {
<a name="l00060"></a>00060     <span class="keyword">public</span>:
<a name="l00061"></a>00061 
<a name="l00062"></a><a class="code" href="classOscl__File.html#a9e509e827a54ae70ad3d37b3ae16b50a">00062</a>         <span class="keyword">typedef</span> <span class="keyword">enum</span>
<a name="l00063"></a>00063         {
<a name="l00067"></a><a class="code" href="classOscl__File.html#a9e509e827a54ae70ad3d37b3ae16b50aa186a2a425873e92f88575a13b512b5cc">00067</a>             <a class="code" href="classOscl__File.html#a9e509e827a54ae70ad3d37b3ae16b50aa186a2a425873e92f88575a13b512b5cc">SEEKSET</a>,
<a name="l00071"></a><a class="code" href="classOscl__File.html#a9e509e827a54ae70ad3d37b3ae16b50aa3fda0c4ebcb3a7d27a53087695c7dd3a">00071</a>             <a class="code" href="classOscl__File.html#a9e509e827a54ae70ad3d37b3ae16b50aa3fda0c4ebcb3a7d27a53087695c7dd3a">SEEKCUR</a>,
<a name="l00075"></a><a class="code" href="classOscl__File.html#a9e509e827a54ae70ad3d37b3ae16b50aa8745fb1400220dfc9ecfa89b80961546">00075</a>             <a class="code" href="classOscl__File.html#a9e509e827a54ae70ad3d37b3ae16b50aa8745fb1400220dfc9ecfa89b80961546">SEEKEND</a>
<a name="l00076"></a>00076         } <a class="code" href="classOscl__File.html#a9e509e827a54ae70ad3d37b3ae16b50a">seek_type</a>;
<a name="l00077"></a>00077 
<a name="l00078"></a><a class="code" href="classOscl__File.html#aa1f38baa9835f88b8809a51938eb12e6">00078</a>         <span class="keyword">typedef</span> <span class="keyword">enum</span>
<a name="l00079"></a>00079         {
<a name="l00083"></a><a class="code" href="classOscl__File.html#aa1f38baa9835f88b8809a51938eb12e6ac2a9ebf09a860ff5b360fc27dc0a4293">00083</a>             <a class="code" href="classOscl__File.html#aa1f38baa9835f88b8809a51938eb12e6ac2a9ebf09a860ff5b360fc27dc0a4293">MODE_READ</a> =      0x0001,
<a name="l00089"></a><a class="code" href="classOscl__File.html#aa1f38baa9835f88b8809a51938eb12e6a8b3b0eee9bb361f645f21690aa40a800">00089</a>             <a class="code" href="classOscl__File.html#aa1f38baa9835f88b8809a51938eb12e6a8b3b0eee9bb361f645f21690aa40a800">MODE_READWRITE</a> = 0x0002,
<a name="l00096"></a><a class="code" href="classOscl__File.html#aa1f38baa9835f88b8809a51938eb12e6a7c9e793f1b01931a736be0dc12cf7154">00096</a>             <a class="code" href="classOscl__File.html#aa1f38baa9835f88b8809a51938eb12e6a7c9e793f1b01931a736be0dc12cf7154">MODE_APPEND</a> =    0x0004,
<a name="l00100"></a><a class="code" href="classOscl__File.html#aa1f38baa9835f88b8809a51938eb12e6a844af4467981a9be9a270dd650473193">00100</a>             <a class="code" href="classOscl__File.html#aa1f38baa9835f88b8809a51938eb12e6a844af4467981a9be9a270dd650473193">MODE_BINARY</a> =    0x0008,
<a name="l00104"></a><a class="code" href="classOscl__File.html#aa1f38baa9835f88b8809a51938eb12e6a043cb6084fb21ce421590eccafd8420c">00104</a>             <a class="code" href="classOscl__File.html#aa1f38baa9835f88b8809a51938eb12e6a043cb6084fb21ce421590eccafd8420c">MODE_TEXT</a> =      0x0010,
<a name="l00109"></a><a class="code" href="classOscl__File.html#aa1f38baa9835f88b8809a51938eb12e6a0872c09961c1a38f17e54228ea76914b">00109</a>             <a class="code" href="classOscl__File.html#aa1f38baa9835f88b8809a51938eb12e6a0872c09961c1a38f17e54228ea76914b">MODE_READ_PLUS</a> =  0x0020
<a name="l00110"></a>00110 
<a name="l00111"></a>00111         } <a class="code" href="classOscl__File.html#aa1f38baa9835f88b8809a51938eb12e6">mode_type</a>;
<a name="l00112"></a>00112 
<a name="l00116"></a>00116         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <a class="code" href="classOscl__File.html#a58c4e248d7b63a35c7520c692dd04ac9">Oscl_File</a>();
<a name="l00117"></a>00117 
<a name="l00123"></a>00123         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <a class="code" href="classOscl__File.html#a58c4e248d7b63a35c7520c692dd04ac9">Oscl_File</a>(uint32 aCacheSize);
<a name="l00130"></a>00130         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <a class="code" href="classOscl__File.html#a58c4e248d7b63a35c7520c692dd04ac9">Oscl_File</a>(uint32 aCacheSize, <a class="code" href="classOsclFileHandle.html">OsclFileHandle</a>* aFileHandle);
<a name="l00131"></a>00131 
<a name="l00135"></a>00135         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <a class="code" href="classOscl__File.html#a173e4b7f4aa33438c7cb60c919c20183">~Oscl_File</a>();
<a name="l00136"></a>00136 
<a name="l00146"></a>00146         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <span class="keywordtype">void</span> <a class="code" href="classOscl__File.html#ae678d5468807fd32304d89641acc3614">SetPVCacheSize</a>(uint32 aSize);
<a name="l00147"></a>00147 
<a name="l00151"></a><a class="code" href="classOscl__File_1_1OsclFixedCacheParam.html">00151</a>         <span class="keyword">class </span><a class="code" href="classOscl__File_1_1OsclFixedCacheParam.html">OsclFixedCacheParam</a>
<a name="l00152"></a>00152         {
<a name="l00153"></a>00153             <span class="keyword">public</span>:
<a name="l00154"></a>00154                 <span class="comment">/*</span>
<a name="l00155"></a>00155 <span class="comment">                ** File position where the fixed cache is located.</span>
<a name="l00156"></a>00156 <span class="comment">                */</span>
<a name="l00157"></a><a class="code" href="classOscl__File_1_1OsclFixedCacheParam.html#ac08d15990a91ee4c741651b52c2975f9">00157</a>                 <a class="code" href="osclconfig__io_8h.html#a97cda56383fc49167372a11658c80483">TOsclFileOffset</a> <a class="code" href="classOscl__File_1_1OsclFixedCacheParam.html#ac08d15990a91ee4c741651b52c2975f9">iFilePosition</a>;
<a name="l00158"></a>00158                 <span class="comment">/*</span>
<a name="l00159"></a>00159 <span class="comment">                ** Fixed cache size in bytes.</span>
<a name="l00160"></a>00160 <span class="comment">                */</span>
<a name="l00161"></a><a class="code" href="classOscl__File_1_1OsclFixedCacheParam.html#a494a13288a8b90c10047f3f877ef21ed">00161</a>                 uint32 <a class="code" href="classOscl__File_1_1OsclFixedCacheParam.html#a494a13288a8b90c10047f3f877ef21ed">iSize</a>;
<a name="l00162"></a>00162 
<a name="l00163"></a><a class="code" href="classOscl__File_1_1OsclFixedCacheParam.html#a542a1e4d2c665c9cc1a70547cf88ba5e">00163</a>                 <span class="keywordtype">bool</span> <a class="code" href="classOscl__File_1_1OsclFixedCacheParam.html#a542a1e4d2c665c9cc1a70547cf88ba5e">Contains</a>(<a class="code" href="osclconfig__io_8h.html#a97cda56383fc49167372a11658c80483">TOsclFileOffset</a> pos)<span class="keyword"> const</span>
<a name="l00164"></a>00164 <span class="keyword">                </span>{
<a name="l00165"></a>00165                     <span class="keywordflow">return</span> (<a class="code" href="classOscl__File_1_1OsclFixedCacheParam.html#ac08d15990a91ee4c741651b52c2975f9">iFilePosition</a> &lt;= pos &amp;&amp; pos &lt; <a class="code" href="classOscl__File_1_1OsclFixedCacheParam.html#ac08d15990a91ee4c741651b52c2975f9">iFilePosition</a> + (<a class="code" href="osclconfig__io_8h.html#a97cda56383fc49167372a11658c80483">TOsclFileOffset</a>)<a class="code" href="classOscl__File_1_1OsclFixedCacheParam.html#a494a13288a8b90c10047f3f877ef21ed">iSize</a>);
<a name="l00166"></a>00166                 }
<a name="l00167"></a>00167         };
<a name="l00168"></a>00168 
<a name="l00176"></a><a class="code" href="classOscl__File.html#a23abfd1e69524fb867168cf2d60c38ca">00176</a>         <span class="keywordtype">void</span> <a class="code" href="classOscl__File.html#a23abfd1e69524fb867168cf2d60c38ca">AddFixedCache</a>(<span class="keyword">const</span> <a class="code" href="classOscl__File_1_1OsclFixedCacheParam.html">OsclFixedCacheParam</a>&amp; aParam)
<a name="l00177"></a>00177         {
<a name="l00178"></a>00178             iAddFixedCache.<a class="code" href="classOscl__Vector.html#a1db6a9793976d83483ced5b5eda5ca24">push_back</a>(aParam);
<a name="l00179"></a>00179         }
<a name="l00180"></a>00180 
<a name="l00186"></a><a class="code" href="classOscl__File.html#a568e3c5660ddbb10f697a266b5a67451">00186</a>         <span class="keywordtype">void</span> <a class="code" href="classOscl__File.html#a568e3c5660ddbb10f697a266b5a67451">RemoveFixedCache</a>(<span class="keyword">const</span> <a class="code" href="osclconfig__io_8h.html#a97cda56383fc49167372a11658c80483">TOsclFileOffset</a> &amp;aPos)
<a name="l00187"></a>00187         {
<a name="l00188"></a>00188             iRemoveFixedCache.<a class="code" href="classOscl__Vector.html#a1db6a9793976d83483ced5b5eda5ca24">push_back</a>(aPos);
<a name="l00189"></a>00189         }
<a name="l00190"></a>00190 
<a name="l00196"></a><a class="code" href="classOscl__File_1_1OsclCacheObserver.html">00196</a>         <span class="keyword">class </span><a class="code" href="classOscl__File_1_1OsclCacheObserver.html">OsclCacheObserver</a>
<a name="l00197"></a>00197         {
<a name="l00198"></a>00198             <span class="keyword">public</span>:
<a name="l00199"></a><a class="code" href="classOscl__File_1_1OsclCacheObserver.html#ac18930d925eebe01d00fff198f594ce3">00199</a>                 <span class="keyword">virtual</span> <a class="code" href="classOscl__File_1_1OsclCacheObserver.html#ac18930d925eebe01d00fff198f594ce3">~OsclCacheObserver</a>() {};
<a name="l00200"></a>00200                 <span class="keyword">virtual</span> <a class="code" href="classOsclFileCacheBuffer.html">OsclFileCacheBuffer</a>* <a class="code" href="classOscl__File_1_1OsclCacheObserver.html#adb88886f61bb7211311ac2576aaa59a7">ChooseCurCache</a>(<a class="code" href="classOsclFileCache.html">OsclFileCache</a>&amp; aContext, <a class="code" href="osclconfig__io_8h.html#a97cda56383fc49167372a11658c80483">TOsclFileOffset</a> aPos) = 0;
<a name="l00201"></a>00201         };
<a name="l00202"></a><a class="code" href="classOscl__File.html#ab15bacc61dd296fa5ada30f3b759854a">00202</a>         <span class="keywordtype">void</span> <a class="code" href="classOscl__File.html#ab15bacc61dd296fa5ada30f3b759854a">SetCacheObserver</a>(<a class="code" href="classOscl__File_1_1OsclCacheObserver.html">OsclCacheObserver</a>* aObs)
<a name="l00203"></a>00203         {
<a name="l00204"></a>00204             iCacheObserver = aObs;
<a name="l00205"></a>00205         }
<a name="l00206"></a>00206 
<a name="l00217"></a>00217         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <span class="keywordtype">void</span> <a class="code" href="classOscl__File.html#ad3fa6811ad0b59416de866ef2d56c7ba">SetNativeAccessMode</a>(uint32 aMode);
<a name="l00218"></a>00218 
<a name="l00222"></a><a class="code" href="classOscl__File.html#af8b4b6cb3af7dec6e7bb4508665fdb2a">00222</a>         <span class="keyword">enum</span> <a class="code" href="classOscl__File.html#af8b4b6cb3af7dec6e7bb4508665fdb2a">TSymbianAccessMode</a>
<a name="l00223"></a>00223         {
<a name="l00224"></a><a class="code" href="classOscl__File.html#af8b4b6cb3af7dec6e7bb4508665fdb2aa9981a5194070f05653f036f057fc61ac">00224</a>             <a class="code" href="classOscl__File.html#af8b4b6cb3af7dec6e7bb4508665fdb2aa9981a5194070f05653f036f057fc61ac">ESymbianAccessMode_Rfile</a> = 0
<a name="l00225"></a><a class="code" href="classOscl__File.html#af8b4b6cb3af7dec6e7bb4508665fdb2aad44f547c7d8f85b68769db29cdf80dd4">00225</a>             , <a class="code" href="classOscl__File.html#af8b4b6cb3af7dec6e7bb4508665fdb2aad44f547c7d8f85b68769db29cdf80dd4">ESymbianAccessMode_RfileBuf</a> = 1
<a name="l00226"></a>00226         };
<a name="l00227"></a>00227 
<a name="l00242"></a>00242         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <span class="keywordtype">void</span> <a class="code" href="classOscl__File.html#a577917216edda4416812d1fdd64ef064">SetNativeBufferSize</a>(int32 aSize);
<a name="l00243"></a>00243 
<a name="l00257"></a>00257         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <span class="keywordtype">void</span> <a class="code" href="classOscl__File.html#a612296ca4c9219c0c38099900013d81a">SetAsyncReadBufferSize</a>(uint32 aSize);
<a name="l00258"></a>00258 
<a name="l00281"></a>00281         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> int32 <a class="code" href="classOscl__File.html#a89098b1b65a5da1430e6bc590ccdd13c">SetFileHandle</a>(<a class="code" href="classOsclFileHandle.html">OsclFileHandle</a>* aHandle);
<a name="l00282"></a>00282 
<a name="l00296"></a>00296         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> int32 <a class="code" href="classOscl__File.html#a5d56c687e9a6bbe1576cdd295e2a5d91">Open</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename, uint32 mode, <a class="code" href="classOscl__FileServer.html">Oscl_FileServer</a>&amp; fileserv);
<a name="l00297"></a>00297 
<a name="l00310"></a>00310         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> int32 <a class="code" href="classOscl__File.html#a5d56c687e9a6bbe1576cdd295e2a5d91">Open</a>(<span class="keyword">const</span> <a class="code" href="group__osclbase.html#gad3f9ec9db55ebd4760c877b17eb596ec">oscl_wchar</a> *filename, uint32 mode, <a class="code" href="classOscl__FileServer.html">Oscl_FileServer</a>&amp; fileserv);
<a name="l00311"></a>00311 
<a name="l00328"></a>00328         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> uint32 <a class="code" href="classOscl__File.html#a09d883055b78c2242edbeacb6bef733e">Read</a>(<a class="code" href="group__osclbase.html#ga3bac54662348f5e6c08b97ca97066b89" title="The OsclAny is meant to be used the context of a generic pointer (i.e., no specific...">OsclAny</a> *buffer,
<a name="l00329"></a>00329                                     uint32 size,
<a name="l00330"></a>00330                                     uint32 numelements);
<a name="l00331"></a>00331 
<a name="l00343"></a>00343         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> uint32 <a class="code" href="classOscl__File.html#ae5d950464f48f48112d940f57484cddd">Write</a>(<span class="keyword">const</span> <a class="code" href="group__osclbase.html#ga3bac54662348f5e6c08b97ca97066b89" title="The OsclAny is meant to be used the context of a generic pointer (i.e., no specific...">OsclAny</a> *buffer,
<a name="l00344"></a>00344                                      uint32 size,
<a name="l00345"></a>00345                                      uint32 numelements);
<a name="l00346"></a>00346 
<a name="l00347"></a>00347 
<a name="l00357"></a>00357         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> int32 <a class="code" href="classOscl__File.html#a90ce56c21c6ce8cc4cafb32649fd3b19">Seek</a>(<a class="code" href="osclconfig__io_8h.html#a97cda56383fc49167372a11658c80483">TOsclFileOffset</a> offset,
<a name="l00358"></a>00358                                    <a class="code" href="classOscl__File.html#a9e509e827a54ae70ad3d37b3ae16b50a">seek_type</a> origin);
<a name="l00359"></a>00359 
<a name="l00364"></a>00364         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <a class="code" href="osclconfig__io_8h.html#a97cda56383fc49167372a11658c80483">TOsclFileOffset</a> <a class="code" href="classOscl__File.html#a567ef18b2d1c414e8c323bf153484289">Tell</a>();
<a name="l00365"></a>00365 
<a name="l00366"></a>00366 
<a name="l00377"></a>00377         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> int32 <a class="code" href="classOscl__File.html#a805e133f8c000e4d9254e33843a3236e">Close</a>();
<a name="l00378"></a>00378 
<a name="l00379"></a>00379 
<a name="l00388"></a>00388         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> int32 <a class="code" href="classOscl__File.html#afc1510c0935bd15ea99a2d7057eb4f70">Flush</a>();
<a name="l00389"></a>00389 
<a name="l00397"></a>00397         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> int32 <a class="code" href="classOscl__File.html#a39bf816d413513da73822733dc20a65f">SetSize</a>(uint32 size);
<a name="l00398"></a>00398 
<a name="l00406"></a>00406         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> int32 <a class="code" href="classOscl__File.html#abdada8915300bd4fe7d4404700a891c5">EndOfFile</a>();
<a name="l00407"></a>00407 
<a name="l00408"></a>00408 
<a name="l00416"></a>00416         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> int32 <a class="code" href="classOscl__File.html#adfe81d14690750373f5981f891656066">GetError</a>();
<a name="l00417"></a>00417 
<a name="l00423"></a><a class="code" href="classOscl__File.html#a36db82341a736dff1004cb5c920b5d71">00423</a>         <a class="code" href="classOsclFileHandle.html">OsclFileHandle</a>* <a class="code" href="classOscl__File.html#a36db82341a736dff1004cb5c920b5d71">Handle</a>()
<a name="l00424"></a>00424         {
<a name="l00425"></a>00425             <span class="keywordflow">return</span> iOpenFileHandle;
<a name="l00426"></a>00426         }
<a name="l00427"></a>00427 
<a name="l00433"></a>00433         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <a class="code" href="osclconfig__io_8h.html#a97cda56383fc49167372a11658c80483">TOsclFileOffset</a> <a class="code" href="classOscl__File.html#a2bc1c775ab39f263a07f3d0546a47283">Size</a>();
<a name="l00434"></a>00434 
<a name="l00443"></a>00443         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <span class="keywordtype">void</span> <a class="code" href="classOscl__File.html#ad4569610376d98df86381ccad8292054">SetLoggingEnable</a>(<span class="keywordtype">bool</span> aEnable);
<a name="l00444"></a>00444 
<a name="l00452"></a>00452         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> <span class="keywordtype">void</span> <a class="code" href="classOscl__File.html#a6a34ed61375c8ce75809850d79ff051a">SetSummaryStatsLoggingEnable</a>(<span class="keywordtype">bool</span> aEnable);
<a name="l00453"></a>00453 
<a name="l00454"></a>00454 
<a name="l00455"></a>00455     <span class="keyword">private</span>:
<a name="l00456"></a><a class="code" href="classOscl__File.html#a62aa991048252de41fbef49be841185f">00456</a>         <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classOsclFileCache.html">OsclFileCache</a>;
<a name="l00457"></a><a class="code" href="classOscl__File.html#a3280256c019228f75b99499164ba9d24">00457</a>         <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classOsclFileCacheBuffer.html">OsclFileCacheBuffer</a>;
<a name="l00458"></a><a class="code" href="classOscl__File.html#a3834fa882aeebc1fdf8e9a531c707441">00458</a>         <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classOscl__File.html#a3834fa882aeebc1fdf8e9a531c707441">asyncfilereadwrite_test</a>;
<a name="l00459"></a><a class="code" href="classOscl__File.html#a2e6d1f88cc1f3b76e72143258c7d291c">00459</a>         <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classOscl__File.html#a2e6d1f88cc1f3b76e72143258c7d291c">largeasyncfilereadwrite_test</a>;
<a name="l00460"></a><a class="code" href="classOscl__File.html#a0559f823b0d918962f053b5710aa5aef">00460</a>         <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classOscl__File.html#a0559f823b0d918962f053b5710aa5aef">asyncfilereadcancel_test</a>;
<a name="l00461"></a>00461 
<a name="l00462"></a>00462         <span class="keywordtype">void</span> Construct();
<a name="l00463"></a>00463         <span class="keywordtype">void</span> OldCacheDefaults();
<a name="l00464"></a>00464         <span class="keywordtype">void</span> OldCacheSelect(uint32);
<a name="l00465"></a>00465 
<a name="l00466"></a>00466         <span class="comment">//state info</span>
<a name="l00467"></a>00467         <span class="keywordtype">bool</span> iIsOpen;
<a name="l00468"></a>00468 
<a name="l00469"></a>00469         <span class="comment">//For Logging</span>
<a name="l00470"></a>00470         <a class="code" href="classPVLogger.html">PVLogger</a>* iLogger;
<a name="l00471"></a>00471         <a class="code" href="classPVLogger.html">PVLogger</a>* iStatsLogger;
<a name="l00472"></a>00472         <a class="code" href="classPVLogger.html">PVLogger</a>* iNativeLogger;
<a name="l00473"></a>00473         <a class="code" href="classPVLogger.html">PVLogger</a>* iAsyncLogger;
<a name="l00474"></a>00474         <a class="code" href="classOsclFileStats.html">OsclFileStats</a>* iFileStats;
<a name="l00475"></a>00475         <span class="keywordtype">void</span> CreateFileStats();
<a name="l00476"></a>00476 
<a name="l00477"></a>00477         <span class="comment">//External file handle.</span>
<a name="l00478"></a>00478         <a class="code" href="classOsclFileHandle.html">OsclFileHandle</a>* iOpenFileHandle;
<a name="l00479"></a>00479 
<a name="l00480"></a>00480         <span class="comment">//For PV File Cache</span>
<a name="l00481"></a>00481         uint32 iPVCacheSize;
<a name="l00482"></a>00482         <a class="code" href="classOsclFileCache.html">OsclFileCache</a>* iFileCache;
<a name="l00483"></a>00483         <a class="code" href="classOscl__Vector.html">Oscl_Vector&lt;OsclFixedCacheParam, OsclMemAllocator&gt;</a> iAddFixedCache;
<a name="l00484"></a>00484         <a class="code" href="classOscl__Vector.html">Oscl_Vector&lt;TOsclFileOffset, OsclMemAllocator&gt;</a> iRemoveFixedCache;
<a name="l00485"></a>00485         <a class="code" href="classOscl__File_1_1OsclCacheObserver.html">OsclCacheObserver</a>* iCacheObserver;
<a name="l00486"></a>00486 
<a name="l00487"></a>00487         int32 OpenFileCacheOrAsyncBuffer(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename
<a name="l00488"></a>00488                                          , <span class="keyword">const</span> <a class="code" href="group__osclbase.html#gad3f9ec9db55ebd4760c877b17eb596ec">oscl_wchar</a>* wfilename
<a name="l00489"></a>00489                                          , uint32 mode
<a name="l00490"></a>00490                                          , <span class="keyword">const</span> <a class="code" href="classOsclNativeFileParams.html">OsclNativeFileParams</a>&amp; params
<a name="l00491"></a>00491                                          , <a class="code" href="classOscl__FileServer.html">Oscl_FileServer</a>&amp; fileserv) ;
<a name="l00492"></a>00492 
<a name="l00493"></a>00493         <span class="comment">//For native file I/O.</span>
<a name="l00494"></a>00494         <a class="code" href="classOsclNativeFile.html">OsclNativeFile</a>* iNativeFile;
<a name="l00495"></a>00495         int32 iNativeBufferSize;
<a name="l00496"></a>00496         uint32 iNativeAccessMode;
<a name="l00497"></a>00497 
<a name="l00498"></a>00498         <span class="comment">//For async read feature</span>
<a name="l00499"></a>00499         uint32 iAsyncReadBufferSize;
<a name="l00500"></a>00500         <a class="code" href="classOsclAsyncFile.html">OsclAsyncFile</a>* iAsyncFile;
<a name="l00501"></a>00501 
<a name="l00502"></a>00502         <span class="comment">// These are wrappers to call the Native OS File IO calls with</span>
<a name="l00503"></a>00503         <span class="comment">// stats and logging.</span>
<a name="l00504"></a>00504 
<a name="l00505"></a>00505         int32  CallNativeOpen(<span class="keyword">const</span> <a class="code" href="classOsclFileHandle.html">OsclFileHandle</a>&amp;, uint32 mode
<a name="l00506"></a>00506                               , <span class="keyword">const</span> <a class="code" href="classOsclNativeFileParams.html">OsclNativeFileParams</a>&amp; params
<a name="l00507"></a>00507                               , <a class="code" href="classOscl__FileServer.html">Oscl_FileServer</a>&amp; fileserv);
<a name="l00508"></a>00508         int32  CallNativeOpen(<span class="keyword">const</span> <a class="code" href="group__osclbase.html#gad3f9ec9db55ebd4760c877b17eb596ec">oscl_wchar</a> *filename, uint32 mode
<a name="l00509"></a>00509                               , <span class="keyword">const</span> <a class="code" href="classOsclNativeFileParams.html">OsclNativeFileParams</a>&amp; params
<a name="l00510"></a>00510                               , <a class="code" href="classOscl__FileServer.html">Oscl_FileServer</a>&amp; fileserv);
<a name="l00511"></a>00511         int32  CallNativeOpen(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename, uint32 mode
<a name="l00512"></a>00512                               , <span class="keyword">const</span> <a class="code" href="classOsclNativeFileParams.html">OsclNativeFileParams</a>&amp; params
<a name="l00513"></a>00513                               , <a class="code" href="classOscl__FileServer.html">Oscl_FileServer</a>&amp; fileserv);
<a name="l00514"></a>00514         uint32 CallNativeRead(<a class="code" href="group__osclbase.html#ga3bac54662348f5e6c08b97ca97066b89" title="The OsclAny is meant to be used the context of a generic pointer (i.e., no specific...">OsclAny</a> *buffer, uint32 size, uint32 numelements);
<a name="l00515"></a>00515         uint32 CallNativeWrite(<span class="keyword">const</span> <a class="code" href="group__osclbase.html#ga3bac54662348f5e6c08b97ca97066b89" title="The OsclAny is meant to be used the context of a generic pointer (i.e., no specific...">OsclAny</a> *buffer, uint32 size, uint32 numelements);
<a name="l00516"></a>00516         int32  CallNativeSeek(<a class="code" href="osclconfig__io_8h.html#a97cda56383fc49167372a11658c80483">TOsclFileOffset</a> offset, <a class="code" href="classOscl__File.html#a9e509e827a54ae70ad3d37b3ae16b50a">Oscl_File::seek_type</a> origin);
<a name="l00517"></a>00517         int32  CallNativeSetSize(uint32 size);
<a name="l00518"></a>00518         <a class="code" href="osclconfig__io_8h.html#a97cda56383fc49167372a11658c80483">TOsclFileOffset</a>  CallNativeTell();
<a name="l00519"></a>00519         int32  CallNativeFlush();
<a name="l00520"></a>00520         int32  CallNativeEndOfFile();
<a name="l00521"></a>00521         <a class="code" href="osclconfig__io_8h.html#a97cda56383fc49167372a11658c80483">TOsclFileOffset</a> CallNativeSize();
<a name="l00522"></a>00522         int32 CallNativeClose();
<a name="l00523"></a>00523         uint32 CallNativeMode();
<a name="l00524"></a>00524         int32 CallNativeGetError();
<a name="l00525"></a>00525         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> uint32 GetAsyncFileNumOfRun();
<a name="l00526"></a>00526         <a class="code" href="osclconfig_8h.html#a6de0f53c5c11f8f53ce72c70d74d9abc">OSCL_IMPORT_REF</a> uint32 GetAsyncFileNumOfRunError();
<a name="l00527"></a>00527 
<a name="l00528"></a>00528 };
<a name="l00529"></a>00529 
<a name="l00530"></a>00530 
<a name="l00531"></a>00531 <span class="comment">//Include all public file apis for convenience here.</span>
<a name="l00532"></a>00532 <span class="preprocessor">#include &quot;<a class="code" href="oscl__file__server_8h.html" title="The file oscl_file_server.h defines the class Oscl_FileServer. This is the porting...">oscl_file_server.h</a>&quot;</span>
<a name="l00533"></a>00533 <span class="preprocessor">#include &quot;<a class="code" href="oscl__file__find_8h.html" title="The file oscl_file_find.h defines the class Oscl_FileFind.">oscl_file_find.h</a>&quot;</span>
<a name="l00534"></a>00534 <span class="preprocessor">#include &quot;<a class="code" href="oscl__file__dir__utils_8h.html" title="The file oscl_file_dir_utils.h defines some unix-style directory ops.">oscl_file_dir_utils.h</a>&quot;</span>
<a name="l00535"></a>00535 <span class="preprocessor">#include &quot;<a class="code" href="oscl__file__handle_8h.html" title="The file oscl_file_handle.h defines the class OsclFileHandle.">oscl_file_handle.h</a>&quot;</span>
<a name="l00536"></a>00536 
<a name="l00537"></a>00537 <span class="preprocessor">#endif // OSCL_FILE_IO_H_INCLUDED</span>
<a name="l00538"></a>00538 <span class="preprocessor"></span>
</pre></div></div>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
<address style="align: left;"><small>Posting Version: CORE_9.004.1.1 </small>
</small></address>
</body>
</html>