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>OsclAsyncFileBuffer 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> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> 9<hr><h1>OsclAsyncFileBuffer Class Reference</h1><code>#include <<a class="el" href="oscl__file__async__read_8h-source.html">oscl_file_async_read.h</a>></code> 10<p> 11<p>Inheritance diagram for OsclAsyncFileBuffer: 12<p><center><img src="classOsclAsyncFileBuffer.png" usemap="#OsclAsyncFileBuffer_map" border="0" alt=""></center> 13<map name="OsclAsyncFileBuffer_map"> 14<area href="classHeapBase.html" alt="HeapBase" shape="rect" coords="0,56,130,80"> 15<area href="class__OsclHeapBase.html" alt="_OsclHeapBase" shape="rect" coords="0,0,130,24"> 16</map> 17<table border=0 cellpadding=0 cellspacing=0> 18<tr><td></td></tr> 19<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> 20<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOsclAsyncFileBuffer.html#a0">~OsclAsyncFileBuffer</a> ()</td></tr> 21<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOsclAsyncFileBuffer.html#a1">CleanInUse</a> ()</td></tr> 22<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOsclAsyncFileBuffer.html#a2">SetInUse</a> ()</td></tr> 23<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOsclAsyncFileBuffer.html#a3">IsInUse</a> ()</td></tr> 24<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOsclAsyncFileBuffer.html#a4">IsValid</a> ()</td></tr> 25<tr><td nowrap align=right valign=top><a class="el" href="osclconfig__io_8h.html#a48">TOsclFileOffset</a> </td><td valign=bottom><a class="el" href="classOsclAsyncFileBuffer.html#a5">Offset</a> ()</td></tr> 26<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOsclAsyncFileBuffer.html#a6">SetOffset</a> (<a class="el" href="osclconfig__io_8h.html#a48">TOsclFileOffset</a> aOffset)</td></tr> 27<tr><td nowrap align=right valign=top>int32 </td><td valign=bottom><a class="el" href="classOsclAsyncFileBuffer.html#a7">Length</a> ()</td></tr> 28<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOsclAsyncFileBuffer.html#a8">HasThisOffset</a> (<a class="el" href="osclconfig__io_8h.html#a48">TOsclFileOffset</a> aOffset)</td></tr> 29<tr><td nowrap align=right valign=top>int32 </td><td valign=bottom><a class="el" href="classOsclAsyncFileBuffer.html#a9">Id</a> ()</td></tr> 30<tr><td nowrap align=right valign=top><a class="el" href="classOsclBuf.html">OsclBuf</a> * </td><td valign=bottom><a class="el" href="classOsclAsyncFileBuffer.html#a10">Buffer</a> ()</td></tr> 31<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOsclAsyncFileBuffer.html#a11">UpdateData</a> ()</td></tr> 32<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOsclAsyncFileBuffer.html#a12">StartAsyncRead</a> (bool aStartAsyncRead)</td></tr> 33<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> 34<tr><td nowrap align=right valign=top>OsclAsyncFileBuffer * </td><td valign=bottom><a class="el" href="classOsclAsyncFileBuffer.html#d0">NewL</a> (int32 aBufferSize, int32 aId)</td></tr> 35</table> 36<hr><a name="_details"></a><h2>Detailed Description</h2> 37Buffer class used with async read. We keep an array of these, covering consecutive areas of the file. This allows for some seeking without requiring a full flush & refill each time. 38<p> 39<hr><h2>Constructor & Destructor Documentation</h2> 40<a name="a0" doxytag="OsclAsyncFileBuffer::~OsclAsyncFileBuffer"></a><p> 41<table width="100%" cellpadding="2" cellspacing="0" border="0"> 42 <tr> 43 <td class="md"> 44 <table cellpadding="0" cellspacing="0" border="0"> 45 <tr> 46 <td class="md" nowrap valign="top"> OsclAsyncFileBuffer::~OsclAsyncFileBuffer </td> 47 <td class="md" valign="top">( </td> 48 <td class="mdname1" valign="top" nowrap> </td> 49 <td class="md" valign="top">) </td> 50 <td class="md" nowrap></td> 51 </tr> 52 53 </table> 54 </td> 55 </tr> 56</table> 57<table cellspacing=5 cellpadding=0 border=0> 58 <tr> 59 <td> 60 61 </td> 62 <td> 63 64<p> 65 </td> 66 </tr> 67</table> 68<hr><h2>Member Function Documentation</h2> 69<a name="a10" doxytag="OsclAsyncFileBuffer::Buffer"></a><p> 70<table width="100%" cellpadding="2" cellspacing="0" border="0"> 71 <tr> 72 <td class="md"> 73 <table cellpadding="0" cellspacing="0" border="0"> 74 <tr> 75 <td class="md" nowrap valign="top"> <a class="el" href="classOsclBuf.html">OsclBuf</a>* OsclAsyncFileBuffer::Buffer </td> 76 <td class="md" valign="top">( </td> 77 <td class="mdname1" valign="top" nowrap> </td> 78 <td class="md" valign="top">) </td> 79 <td class="md" nowrap></td> 80 </tr> 81 82 </table> 83 </td> 84 </tr> 85</table> 86<table cellspacing=5 cellpadding=0 border=0> 87 <tr> 88 <td> 89 90 </td> 91 <td> 92 93<p> 94 </td> 95 </tr> 96</table> 97<a name="a1" doxytag="OsclAsyncFileBuffer::CleanInUse"></a><p> 98<table width="100%" cellpadding="2" cellspacing="0" border="0"> 99 <tr> 100 <td class="md"> 101 <table cellpadding="0" cellspacing="0" border="0"> 102 <tr> 103 <td class="md" nowrap valign="top"> void OsclAsyncFileBuffer::CleanInUse </td> 104 <td class="md" valign="top">( </td> 105 <td class="mdname1" valign="top" nowrap> </td> 106 <td class="md" valign="top">) </td> 107 <td class="md" nowrap><code> [inline]</code></td> 108 </tr> 109 110 </table> 111 </td> 112 </tr> 113</table> 114<table cellspacing=5 cellpadding=0 border=0> 115 <tr> 116 <td> 117 118 </td> 119 <td> 120 121<p> 122 </td> 123 </tr> 124</table> 125<a name="a8" doxytag="OsclAsyncFileBuffer::HasThisOffset"></a><p> 126<table width="100%" cellpadding="2" cellspacing="0" border="0"> 127 <tr> 128 <td class="md"> 129 <table cellpadding="0" cellspacing="0" border="0"> 130 <tr> 131 <td class="md" nowrap valign="top"> bool OsclAsyncFileBuffer::HasThisOffset </td> 132 <td class="md" valign="top">( </td> 133 <td class="md" nowrap valign="top"><a class="el" href="osclconfig__io_8h.html#a48">TOsclFileOffset</a> </td> 134 <td class="mdname1" valign="top" nowrap> <em>aOffset</em> </td> 135 <td class="md" valign="top">) </td> 136 <td class="md" nowrap></td> 137 </tr> 138 139 </table> 140 </td> 141 </tr> 142</table> 143<table cellspacing=5 cellpadding=0 border=0> 144 <tr> 145 <td> 146 147 </td> 148 <td> 149 150<p> 151 </td> 152 </tr> 153</table> 154<a name="a9" doxytag="OsclAsyncFileBuffer::Id"></a><p> 155<table width="100%" cellpadding="2" cellspacing="0" border="0"> 156 <tr> 157 <td class="md"> 158 <table cellpadding="0" cellspacing="0" border="0"> 159 <tr> 160 <td class="md" nowrap valign="top"> int32 OsclAsyncFileBuffer::Id </td> 161 <td class="md" valign="top">( </td> 162 <td class="mdname1" valign="top" nowrap> </td> 163 <td class="md" valign="top">) </td> 164 <td class="md" nowrap><code> [inline]</code></td> 165 </tr> 166 167 </table> 168 </td> 169 </tr> 170</table> 171<table cellspacing=5 cellpadding=0 border=0> 172 <tr> 173 <td> 174 175 </td> 176 <td> 177 178<p> 179 </td> 180 </tr> 181</table> 182<a name="a3" doxytag="OsclAsyncFileBuffer::IsInUse"></a><p> 183<table width="100%" cellpadding="2" cellspacing="0" border="0"> 184 <tr> 185 <td class="md"> 186 <table cellpadding="0" cellspacing="0" border="0"> 187 <tr> 188 <td class="md" nowrap valign="top"> bool OsclAsyncFileBuffer::IsInUse </td> 189 <td class="md" valign="top">( </td> 190 <td class="mdname1" valign="top" nowrap> </td> 191 <td class="md" valign="top">) </td> 192 <td class="md" nowrap><code> [inline]</code></td> 193 </tr> 194 195 </table> 196 </td> 197 </tr> 198</table> 199<table cellspacing=5 cellpadding=0 border=0> 200 <tr> 201 <td> 202 203 </td> 204 <td> 205 206<p> 207 </td> 208 </tr> 209</table> 210<a name="a4" doxytag="OsclAsyncFileBuffer::IsValid"></a><p> 211<table width="100%" cellpadding="2" cellspacing="0" border="0"> 212 <tr> 213 <td class="md"> 214 <table cellpadding="0" cellspacing="0" border="0"> 215 <tr> 216 <td class="md" nowrap valign="top"> bool OsclAsyncFileBuffer::IsValid </td> 217 <td class="md" valign="top">( </td> 218 <td class="mdname1" valign="top" nowrap> </td> 219 <td class="md" valign="top">) </td> 220 <td class="md" nowrap><code> [inline]</code></td> 221 </tr> 222 223 </table> 224 </td> 225 </tr> 226</table> 227<table cellspacing=5 cellpadding=0 border=0> 228 <tr> 229 <td> 230 231 </td> 232 <td> 233 234<p> 235 </td> 236 </tr> 237</table> 238<a name="a7" doxytag="OsclAsyncFileBuffer::Length"></a><p> 239<table width="100%" cellpadding="2" cellspacing="0" border="0"> 240 <tr> 241 <td class="md"> 242 <table cellpadding="0" cellspacing="0" border="0"> 243 <tr> 244 <td class="md" nowrap valign="top"> int32 OsclAsyncFileBuffer::Length </td> 245 <td class="md" valign="top">( </td> 246 <td class="mdname1" valign="top" nowrap> </td> 247 <td class="md" valign="top">) </td> 248 <td class="md" nowrap><code> [inline]</code></td> 249 </tr> 250 251 </table> 252 </td> 253 </tr> 254</table> 255<table cellspacing=5 cellpadding=0 border=0> 256 <tr> 257 <td> 258 259 </td> 260 <td> 261 262<p> 263 </td> 264 </tr> 265</table> 266<a name="d0" doxytag="OsclAsyncFileBuffer::NewL"></a><p> 267<table width="100%" cellpadding="2" cellspacing="0" border="0"> 268 <tr> 269 <td class="md"> 270 <table cellpadding="0" cellspacing="0" border="0"> 271 <tr> 272 <td class="md" nowrap valign="top"> OsclAsyncFileBuffer* OsclAsyncFileBuffer::NewL </td> 273 <td class="md" valign="top">( </td> 274 <td class="md" nowrap valign="top">int32 </td> 275 <td class="mdname" nowrap> <em>aBufferSize</em>, </td> 276 </tr> 277 <tr> 278 <td></td> 279 <td></td> 280 <td class="md" nowrap>int32 </td> 281 <td class="mdname" nowrap> <em>aId</em></td> 282 </tr> 283 <tr> 284 <td></td> 285 <td class="md">) </td> 286 <td class="md" colspan="2"><code> [static]</code></td> 287 </tr> 288 289 </table> 290 </td> 291 </tr> 292</table> 293<table cellspacing=5 cellpadding=0 border=0> 294 <tr> 295 <td> 296 297 </td> 298 <td> 299 300<p> 301 </td> 302 </tr> 303</table> 304<a name="a5" doxytag="OsclAsyncFileBuffer::Offset"></a><p> 305<table width="100%" cellpadding="2" cellspacing="0" border="0"> 306 <tr> 307 <td class="md"> 308 <table cellpadding="0" cellspacing="0" border="0"> 309 <tr> 310 <td class="md" nowrap valign="top"> <a class="el" href="osclconfig__io_8h.html#a48">TOsclFileOffset</a> OsclAsyncFileBuffer::Offset </td> 311 <td class="md" valign="top">( </td> 312 <td class="mdname1" valign="top" nowrap> </td> 313 <td class="md" valign="top">) </td> 314 <td class="md" nowrap><code> [inline]</code></td> 315 </tr> 316 317 </table> 318 </td> 319 </tr> 320</table> 321<table cellspacing=5 cellpadding=0 border=0> 322 <tr> 323 <td> 324 325 </td> 326 <td> 327 328<p> 329 </td> 330 </tr> 331</table> 332<a name="a2" doxytag="OsclAsyncFileBuffer::SetInUse"></a><p> 333<table width="100%" cellpadding="2" cellspacing="0" border="0"> 334 <tr> 335 <td class="md"> 336 <table cellpadding="0" cellspacing="0" border="0"> 337 <tr> 338 <td class="md" nowrap valign="top"> void OsclAsyncFileBuffer::SetInUse </td> 339 <td class="md" valign="top">( </td> 340 <td class="mdname1" valign="top" nowrap> </td> 341 <td class="md" valign="top">) </td> 342 <td class="md" nowrap><code> [inline]</code></td> 343 </tr> 344 345 </table> 346 </td> 347 </tr> 348</table> 349<table cellspacing=5 cellpadding=0 border=0> 350 <tr> 351 <td> 352 353 </td> 354 <td> 355 356<p> 357 </td> 358 </tr> 359</table> 360<a name="a6" doxytag="OsclAsyncFileBuffer::SetOffset"></a><p> 361<table width="100%" cellpadding="2" cellspacing="0" border="0"> 362 <tr> 363 <td class="md"> 364 <table cellpadding="0" cellspacing="0" border="0"> 365 <tr> 366 <td class="md" nowrap valign="top"> void OsclAsyncFileBuffer::SetOffset </td> 367 <td class="md" valign="top">( </td> 368 <td class="md" nowrap valign="top"><a class="el" href="osclconfig__io_8h.html#a48">TOsclFileOffset</a> </td> 369 <td class="mdname1" valign="top" nowrap> <em>aOffset</em> </td> 370 <td class="md" valign="top">) </td> 371 <td class="md" nowrap><code> [inline]</code></td> 372 </tr> 373 374 </table> 375 </td> 376 </tr> 377</table> 378<table cellspacing=5 cellpadding=0 border=0> 379 <tr> 380 <td> 381 382 </td> 383 <td> 384 385<p> 386 </td> 387 </tr> 388</table> 389<a name="a12" doxytag="OsclAsyncFileBuffer::StartAsyncRead"></a><p> 390<table width="100%" cellpadding="2" cellspacing="0" border="0"> 391 <tr> 392 <td class="md"> 393 <table cellpadding="0" cellspacing="0" border="0"> 394 <tr> 395 <td class="md" nowrap valign="top"> void OsclAsyncFileBuffer::StartAsyncRead </td> 396 <td class="md" valign="top">( </td> 397 <td class="md" nowrap valign="top">bool </td> 398 <td class="mdname1" valign="top" nowrap> <em>aStartAsyncRead</em> </td> 399 <td class="md" valign="top">) </td> 400 <td class="md" nowrap></td> 401 </tr> 402 403 </table> 404 </td> 405 </tr> 406</table> 407<table cellspacing=5 cellpadding=0 border=0> 408 <tr> 409 <td> 410 411 </td> 412 <td> 413 414<p> 415 </td> 416 </tr> 417</table> 418<a name="a11" doxytag="OsclAsyncFileBuffer::UpdateData"></a><p> 419<table width="100%" cellpadding="2" cellspacing="0" border="0"> 420 <tr> 421 <td class="md"> 422 <table cellpadding="0" cellspacing="0" border="0"> 423 <tr> 424 <td class="md" nowrap valign="top"> void OsclAsyncFileBuffer::UpdateData </td> 425 <td class="md" valign="top">( </td> 426 <td class="mdname1" valign="top" nowrap> </td> 427 <td class="md" valign="top">) </td> 428 <td class="md" nowrap></td> 429 </tr> 430 431 </table> 432 </td> 433 </tr> 434</table> 435<table cellspacing=5 cellpadding=0 border=0> 436 <tr> 437 <td> 438 439 </td> 440 <td> 441 442<p> 443 </td> 444 </tr> 445</table> 446<hr>The documentation for this class was generated from the following file:<ul> 447<li><a class="el" href="oscl__file__async__read_8h-source.html">oscl_file_async_read.h</a></ul> 448<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small> 449<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small> 450</small></address> 451</body> 452</html> 453
