• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>OsclFileCache class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5</head><body>
6<!-- Generated by Doxygen 1.2.18 -->
7<center>
8<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
9<hr><h1>OsclFileCache Class Reference<br>
10<small>
11[<a class="el" href="group__osclio.html">OSCL IO</a>]</small>
12</h1><code>#include &lt;<a class="el" href="oscl__file__cache_8h-source.html">oscl_file_cache.h</a>&gt;</code>
13<p>
14<p>Inheritance diagram for OsclFileCache:
15<p><center><img src="classOsclFileCache.png" usemap="#OsclFileCache_map" border="0" alt=""></center>
16<map name="OsclFileCache_map">
17<area href="classHeapBase.html" alt="HeapBase" shape="rect" coords="0,56,103,80">
18<area href="class__OsclHeapBase.html" alt="_OsclHeapBase" shape="rect" coords="0,0,103,24">
19</map>
20<table border=0 cellpadding=0 cellspacing=0>
21<tr><td></td></tr>
22<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
23<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classOsclFileCache.html#a0">OsclFileCache</a> (<a class="el" href="classOscl__File.html">Oscl_File</a> &amp;aContainer)</td></tr>
24<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classOsclFileCache.html#a1">~OsclFileCache</a> ()</td></tr>
25<tr><td nowrap align=right valign=top>int32&nbsp;</td><td valign=bottom><a class="el" href="classOsclFileCache.html#a2">Open</a> (uint32 mode, uint32 cache_size)</td></tr>
26<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classOsclFileCache.html#a3">Close</a> ()</td></tr>
27<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classOsclFileCache.html#a4">Read</a> (void *outputBuffer, uint32 size, uint32 numelements)</td></tr>
28<tr><td nowrap align=right valign=top>uint32&nbsp;</td><td valign=bottom><a class="el" href="classOsclFileCache.html#a5">Write</a> (const void *inputBuffer, uint32 size, uint32 numelements)</td></tr>
29<tr><td nowrap align=right valign=top><a class="el" href="osclconfig__io_8h.html#a48">TOsclFileOffset</a>&nbsp;</td><td valign=bottom><a class="el" href="classOsclFileCache.html#a6">FileSize</a> ()</td></tr>
30<tr><td nowrap align=right valign=top>int32&nbsp;</td><td valign=bottom><a class="el" href="classOsclFileCache.html#a7">Seek</a> (<a class="el" href="osclconfig__io_8h.html#a48">TOsclFileOffset</a> offset, <a class="el" href="classOscl__File.html#s11">Oscl_File::seek_type</a> origin)</td></tr>
31<tr><td nowrap align=right valign=top><a class="el" href="osclconfig__io_8h.html#a48">TOsclFileOffset</a>&nbsp;</td><td valign=bottom><a class="el" href="classOsclFileCache.html#a8">Tell</a> ()</td></tr>
32<tr><td nowrap align=right valign=top>int32&nbsp;</td><td valign=bottom><a class="el" href="classOsclFileCache.html#a9">Flush</a> ()</td></tr>
33<tr><td nowrap align=right valign=top>int32&nbsp;</td><td valign=bottom><a class="el" href="classOsclFileCache.html#a10">EndOfFile</a> ()</td></tr>
34</table>
35<hr><h2>Constructor &amp; Destructor Documentation</h2>
36<a name="a0" doxytag="OsclFileCache::OsclFileCache"></a><p>
37<table width="100%" cellpadding="2" cellspacing="0" border="0">
38  <tr>
39    <td class="md">
40      <table cellpadding="0" cellspacing="0" border="0">
41        <tr>
42          <td class="md" nowrap valign="top"> OsclFileCache::OsclFileCache </td>
43          <td class="md" valign="top">(&nbsp;</td>
44          <td class="md" nowrap valign="top"><a class="el" href="classOscl__File.html">Oscl_File</a> &amp;&nbsp;</td>
45          <td class="mdname1" valign="top" nowrap>&nbsp; <em>aContainer</em>          </td>
46          <td class="md" valign="top">)&nbsp;</td>
47          <td class="md" nowrap></td>
48        </tr>
49
50      </table>
51    </td>
52  </tr>
53</table>
54<table cellspacing=5 cellpadding=0 border=0>
55  <tr>
56    <td>
57      &nbsp;
58    </td>
59    <td>
60
61<p>
62    </td>
63  </tr>
64</table>
65<a name="a1" doxytag="OsclFileCache::~OsclFileCache"></a><p>
66<table width="100%" cellpadding="2" cellspacing="0" border="0">
67  <tr>
68    <td class="md">
69      <table cellpadding="0" cellspacing="0" border="0">
70        <tr>
71          <td class="md" nowrap valign="top"> OsclFileCache::~OsclFileCache </td>
72          <td class="md" valign="top">(&nbsp;</td>
73          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
74          <td class="md" valign="top">)&nbsp;</td>
75          <td class="md" nowrap></td>
76        </tr>
77
78      </table>
79    </td>
80  </tr>
81</table>
82<table cellspacing=5 cellpadding=0 border=0>
83  <tr>
84    <td>
85      &nbsp;
86    </td>
87    <td>
88
89<p>
90    </td>
91  </tr>
92</table>
93<hr><h2>Member Function Documentation</h2>
94<a name="a3" doxytag="OsclFileCache::Close"></a><p>
95<table width="100%" cellpadding="2" cellspacing="0" border="0">
96  <tr>
97    <td class="md">
98      <table cellpadding="0" cellspacing="0" border="0">
99        <tr>
100          <td class="md" nowrap valign="top"> void OsclFileCache::Close </td>
101          <td class="md" valign="top">(&nbsp;</td>
102          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
103          <td class="md" valign="top">)&nbsp;</td>
104          <td class="md" nowrap></td>
105        </tr>
106
107      </table>
108    </td>
109  </tr>
110</table>
111<table cellspacing=5 cellpadding=0 border=0>
112  <tr>
113    <td>
114      &nbsp;
115    </td>
116    <td>
117
118<p>
119    </td>
120  </tr>
121</table>
122<a name="a10" doxytag="OsclFileCache::EndOfFile"></a><p>
123<table width="100%" cellpadding="2" cellspacing="0" border="0">
124  <tr>
125    <td class="md">
126      <table cellpadding="0" cellspacing="0" border="0">
127        <tr>
128          <td class="md" nowrap valign="top"> int32 OsclFileCache::EndOfFile </td>
129          <td class="md" valign="top">(&nbsp;</td>
130          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
131          <td class="md" valign="top">)&nbsp;</td>
132          <td class="md" nowrap><code> [inline]</code></td>
133        </tr>
134
135      </table>
136    </td>
137  </tr>
138</table>
139<table cellspacing=5 cellpadding=0 border=0>
140  <tr>
141    <td>
142      &nbsp;
143    </td>
144    <td>
145
146<p>
147    </td>
148  </tr>
149</table>
150<a name="a6" doxytag="OsclFileCache::FileSize"></a><p>
151<table width="100%" cellpadding="2" cellspacing="0" border="0">
152  <tr>
153    <td class="md">
154      <table cellpadding="0" cellspacing="0" border="0">
155        <tr>
156          <td class="md" nowrap valign="top"> <a class="el" href="osclconfig__io_8h.html#a48">TOsclFileOffset</a> OsclFileCache::FileSize </td>
157          <td class="md" valign="top">(&nbsp;</td>
158          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
159          <td class="md" valign="top">)&nbsp;</td>
160          <td class="md" nowrap><code> [inline]</code></td>
161        </tr>
162
163      </table>
164    </td>
165  </tr>
166</table>
167<table cellspacing=5 cellpadding=0 border=0>
168  <tr>
169    <td>
170      &nbsp;
171    </td>
172    <td>
173
174<p>
175    </td>
176  </tr>
177</table>
178<a name="a9" doxytag="OsclFileCache::Flush"></a><p>
179<table width="100%" cellpadding="2" cellspacing="0" border="0">
180  <tr>
181    <td class="md">
182      <table cellpadding="0" cellspacing="0" border="0">
183        <tr>
184          <td class="md" nowrap valign="top"> int32 OsclFileCache::Flush </td>
185          <td class="md" valign="top">(&nbsp;</td>
186          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
187          <td class="md" valign="top">)&nbsp;</td>
188          <td class="md" nowrap></td>
189        </tr>
190
191      </table>
192    </td>
193  </tr>
194</table>
195<table cellspacing=5 cellpadding=0 border=0>
196  <tr>
197    <td>
198      &nbsp;
199    </td>
200    <td>
201
202<p>
203    </td>
204  </tr>
205</table>
206<a name="a2" doxytag="OsclFileCache::Open"></a><p>
207<table width="100%" cellpadding="2" cellspacing="0" border="0">
208  <tr>
209    <td class="md">
210      <table cellpadding="0" cellspacing="0" border="0">
211        <tr>
212          <td class="md" nowrap valign="top"> int32 OsclFileCache::Open </td>
213          <td class="md" valign="top">(&nbsp;</td>
214          <td class="md" nowrap valign="top">uint32&nbsp;</td>
215          <td class="mdname" nowrap>&nbsp; <em>mode</em>, </td>
216        </tr>
217        <tr>
218          <td></td>
219          <td></td>
220          <td class="md" nowrap>uint32&nbsp;</td>
221          <td class="mdname" nowrap>&nbsp; <em>cache_size</em></td>
222        </tr>
223        <tr>
224          <td></td>
225          <td class="md">)&nbsp;</td>
226          <td class="md" colspan="2"></td>
227        </tr>
228
229      </table>
230    </td>
231  </tr>
232</table>
233<table cellspacing=5 cellpadding=0 border=0>
234  <tr>
235    <td>
236      &nbsp;
237    </td>
238    <td>
239
240<p>
241    </td>
242  </tr>
243</table>
244<a name="a4" doxytag="OsclFileCache::Read"></a><p>
245<table width="100%" cellpadding="2" cellspacing="0" border="0">
246  <tr>
247    <td class="md">
248      <table cellpadding="0" cellspacing="0" border="0">
249        <tr>
250          <td class="md" nowrap valign="top"> uint32 OsclFileCache::Read </td>
251          <td class="md" valign="top">(&nbsp;</td>
252          <td class="md" nowrap valign="top">void *&nbsp;</td>
253          <td class="mdname" nowrap>&nbsp; <em>outputBuffer</em>, </td>
254        </tr>
255        <tr>
256          <td></td>
257          <td></td>
258          <td class="md" nowrap>uint32&nbsp;</td>
259          <td class="mdname" nowrap>&nbsp; <em>size</em>, </td>
260        </tr>
261        <tr>
262          <td></td>
263          <td></td>
264          <td class="md" nowrap>uint32&nbsp;</td>
265          <td class="mdname" nowrap>&nbsp; <em>numelements</em></td>
266        </tr>
267        <tr>
268          <td></td>
269          <td class="md">)&nbsp;</td>
270          <td class="md" colspan="2"></td>
271        </tr>
272
273      </table>
274    </td>
275  </tr>
276</table>
277<table cellspacing=5 cellpadding=0 border=0>
278  <tr>
279    <td>
280      &nbsp;
281    </td>
282    <td>
283
284<p>
285    </td>
286  </tr>
287</table>
288<a name="a7" doxytag="OsclFileCache::Seek"></a><p>
289<table width="100%" cellpadding="2" cellspacing="0" border="0">
290  <tr>
291    <td class="md">
292      <table cellpadding="0" cellspacing="0" border="0">
293        <tr>
294          <td class="md" nowrap valign="top"> int32 OsclFileCache::Seek </td>
295          <td class="md" valign="top">(&nbsp;</td>
296          <td class="md" nowrap valign="top"><a class="el" href="osclconfig__io_8h.html#a48">TOsclFileOffset</a>&nbsp;</td>
297          <td class="mdname" nowrap>&nbsp; <em>offset</em>, </td>
298        </tr>
299        <tr>
300          <td></td>
301          <td></td>
302          <td class="md" nowrap><a class="el" href="classOscl__File.html#s11">Oscl_File::seek_type</a>&nbsp;</td>
303          <td class="mdname" nowrap>&nbsp; <em>origin</em></td>
304        </tr>
305        <tr>
306          <td></td>
307          <td class="md">)&nbsp;</td>
308          <td class="md" colspan="2"></td>
309        </tr>
310
311      </table>
312    </td>
313  </tr>
314</table>
315<table cellspacing=5 cellpadding=0 border=0>
316  <tr>
317    <td>
318      &nbsp;
319    </td>
320    <td>
321
322<p>
323    </td>
324  </tr>
325</table>
326<a name="a8" doxytag="OsclFileCache::Tell"></a><p>
327<table width="100%" cellpadding="2" cellspacing="0" border="0">
328  <tr>
329    <td class="md">
330      <table cellpadding="0" cellspacing="0" border="0">
331        <tr>
332          <td class="md" nowrap valign="top"> <a class="el" href="osclconfig__io_8h.html#a48">TOsclFileOffset</a> OsclFileCache::Tell </td>
333          <td class="md" valign="top">(&nbsp;</td>
334          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
335          <td class="md" valign="top">)&nbsp;</td>
336          <td class="md" nowrap><code> [inline]</code></td>
337        </tr>
338
339      </table>
340    </td>
341  </tr>
342</table>
343<table cellspacing=5 cellpadding=0 border=0>
344  <tr>
345    <td>
346      &nbsp;
347    </td>
348    <td>
349
350<p>
351    </td>
352  </tr>
353</table>
354<a name="a5" doxytag="OsclFileCache::Write"></a><p>
355<table width="100%" cellpadding="2" cellspacing="0" border="0">
356  <tr>
357    <td class="md">
358      <table cellpadding="0" cellspacing="0" border="0">
359        <tr>
360          <td class="md" nowrap valign="top"> uint32 OsclFileCache::Write </td>
361          <td class="md" valign="top">(&nbsp;</td>
362          <td class="md" nowrap valign="top">const void *&nbsp;</td>
363          <td class="mdname" nowrap>&nbsp; <em>inputBuffer</em>, </td>
364        </tr>
365        <tr>
366          <td></td>
367          <td></td>
368          <td class="md" nowrap>uint32&nbsp;</td>
369          <td class="mdname" nowrap>&nbsp; <em>size</em>, </td>
370        </tr>
371        <tr>
372          <td></td>
373          <td></td>
374          <td class="md" nowrap>uint32&nbsp;</td>
375          <td class="mdname" nowrap>&nbsp; <em>numelements</em></td>
376        </tr>
377        <tr>
378          <td></td>
379          <td class="md">)&nbsp;</td>
380          <td class="md" colspan="2"></td>
381        </tr>
382
383      </table>
384    </td>
385  </tr>
386</table>
387<table cellspacing=5 cellpadding=0 border=0>
388  <tr>
389    <td>
390      &nbsp;
391    </td>
392    <td>
393
394<p>
395    </td>
396  </tr>
397</table>
398<hr>The documentation for this class was generated from the following file:<ul>
399<li><a class="el" href="oscl__file__cache_8h-source.html">oscl_file_cache.h</a></ul>
400<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
401<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
402</small></address>
403</body>
404</html>
405