This file is indexed.

/usr/share/doc/libucommon-dev/a00054.html is in libucommon-doc 3.2.0-0ubuntu1.

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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
<!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>UCommon: ucc::fbuf Class Reference</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="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&nbsp;Structure&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00054.html">fbuf</a>
  </div>
</div>
<div class="contents">
<h1>ucc::fbuf Class Reference</h1><!-- doxytag: class="ucc::fbuf" --><!-- doxytag: inherits="ucc::IOBuffer,ucc::fsys" -->
<p>A generic file streaming class built from the I/O buffer.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00189_source.html">buffer.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ucc::fbuf:</div>
<div class="dynsection">
<div class="center"><img src="a00393.png" border="0" usemap="#ucc_1_1fbuf_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1fbuf_inherit__map" id="ucc_1_1fbuf_inherit__map">
<area shape="rect" id="node2" href="a00057.html" title="Common buffered I/O class." alt="" coords="5,5,107,35"/><area shape="rect" id="node4" href="a00056.html" title="A container for generic and o/s portable threadsafe file system functions." alt="" coords="131,5,208,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::fbuf:</div>
<div class="dynsection">
<div class="center"><img src="a00394.png" border="0" usemap="#ucc_1_1fbuf_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1fbuf_coll__map" id="ucc_1_1fbuf_coll__map">
<area shape="rect" id="node2" href="a00057.html" title="Common buffered I/O class." alt="" coords="5,5,107,35"/><area shape="rect" id="node4" href="a00056.html" title="A container for generic and o/s portable threadsafe file system functions." alt="" coords="131,5,208,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73f692afc01ef8eb11ad13e04ba00302"></a><!-- doxytag: member="ucc::fbuf::close" ref="a73f692afc01ef8eb11ad13e04ba00302" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a73f692afc01ef8eb11ad13e04ba00302">close</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Close the file, flush buffers. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#aaff0843a4f0883c07d48509172c1d2d9">create</a> (const char *path, <a class="el" href="a00056.html#a5e886a4f005b2a2948d2a3fb4e9f0deb">fsys::access_t</a> access=fsys::ACCESS_APPEND, unsigned permissions=0640, size_t size=512)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create and open the specified file.  <a href="#aaff0843a4f0883c07d48509172c1d2d9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a3db10b790956a1196367f9a6c5e14947">fbuf</a> (const char *path, <a class="el" href="a00056.html#a5e886a4f005b2a2948d2a3fb4e9f0deb">fsys::access_t</a> access, size_t size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct a file buffer that opens an existing file.  <a href="#a3db10b790956a1196367f9a6c5e14947"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a2832b4dc3ad1c0a5ead3e4d0ffe06642">fbuf</a> (const char *path, <a class="el" href="a00056.html#a5e886a4f005b2a2948d2a3fb4e9f0deb">fsys::access_t</a> access, unsigned permissions, size_t size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct a file buffer that creates and opens a specific file.  <a href="#a2832b4dc3ad1c0a5ead3e4d0ffe06642"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acba071f964888390400cf0aedf58949b"></a><!-- doxytag: member="ucc::fbuf::fbuf" ref="acba071f964888390400cf0aedf58949b" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#acba071f964888390400cf0aedf58949b">fbuf</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct an unopened file buffer. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a079696d95987700062e332333a459147">open</a> (const char *path, <a class="el" href="a00056.html#a5e886a4f005b2a2948d2a3fb4e9f0deb">fsys::access_t</a> access=fsys::ACCESS_RDWR, size_t size=512)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct a file buffer that opens an existing file.  <a href="#a079696d95987700062e332333a459147"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#affe16ef4d154e6b4de1203cbf6f6a300">seek</a> (<a class="el" href="a00056.html#acd8d82ddbf77b2c44371f3bf19746f60">offset_t</a> offset)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Seek specific offset in open file and reset I/O buffers.  <a href="#affe16ef4d154e6b4de1203cbf6f6a300"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00056.html#acd8d82ddbf77b2c44371f3bf19746f60">offset_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#abc4559a73cb9e1ccf011cc58a8107dd1">tell</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Give the current position in the currently open file.  <a href="#abc4559a73cb9e1ccf011cc58a8107dd1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a1d548d9babb9c5494018ff0f01c10505">trunc</a> (<a class="el" href="a00056.html#acd8d82ddbf77b2c44371f3bf19746f60">offset_t</a> offset)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Truncate the currently open file to a specific position.  <a href="#a1d548d9babb9c5494018ff0f01c10505"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ebe270e40bc52acb625b2c3173f4527"></a><!-- doxytag: member="ucc::fbuf::~fbuf" ref="a0ebe270e40bc52acb625b2c3173f4527" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a0ebe270e40bc52acb625b2c3173f4527">~fbuf</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy object and release all resources. <br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#ada6eeafad94f859fea178e502935af8f">_pull</a> (char *address, size_t size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method to pull buffer from physical i/o (read).  <a href="#ada6eeafad94f859fea178e502935af8f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00054.html#a6633944cf18140194347af2c0c342ca5">_push</a> (const char *address, size_t size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method to push buffer into physical i/o (write).  <a href="#a6633944cf18140194347af2c0c342ca5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4b8cf4d4be27160649b059b124a9634"></a><!-- doxytag: member="ucc::fbuf::getfile" ref="ab4b8cf4d4be27160649b059b124a9634" args="(void)" -->
fd_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>getfile</b> (void)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A generic file streaming class built from the I/O buffer. </p>
<p>This can be used in place of fopen based file operations and does not require libstdc++. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar &lt;<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>&gt; </dd></dl>

<p>Definition at line <a class="el" href="a00189_source.html#l00374">374</a> of file <a class="el" href="a00189_source.html">buffer.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2832b4dc3ad1c0a5ead3e4d0ffe06642"></a><!-- doxytag: member="ucc::fbuf::fbuf" ref="a2832b4dc3ad1c0a5ead3e4d0ffe06642" args="(const char *path, fsys::access_t access, unsigned permissions, size_t size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ucc::fbuf::fbuf </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>path</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00056.html#a5e886a4f005b2a2948d2a3fb4e9f0deb">fsys::access_t</a>&nbsp;</td>
          <td class="paramname"> <em>access</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&nbsp;</td>
          <td class="paramname"> <em>permissions</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Construct a file buffer that creates and opens a specific file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>of file to create. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>access</em>&nbsp;</td><td>mode of file (rw, rdonly, etc). </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>permissions</em>&nbsp;</td><td>of the newly created file. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of the stream buffer. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a3db10b790956a1196367f9a6c5e14947"></a><!-- doxytag: member="ucc::fbuf::fbuf" ref="a3db10b790956a1196367f9a6c5e14947" args="(const char *path, fsys::access_t access, size_t size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ucc::fbuf::fbuf </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>path</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00056.html#a5e886a4f005b2a2948d2a3fb4e9f0deb">fsys::access_t</a>&nbsp;</td>
          <td class="paramname"> <em>access</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Construct a file buffer that opens an existing file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>of existing file to open. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>access</em>&nbsp;</td><td>mode of file (rw, rdonly, etc). </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of the stream buffer. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ada6eeafad94f859fea178e502935af8f"></a><!-- doxytag: member="ucc::fbuf::_pull" ref="ada6eeafad94f859fea178e502935af8f" args="(char *address, size_t size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t ucc::fbuf::_pull </td>
          <td>(</td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>address</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Method to pull buffer from physical i/o (read). </p>
<p>The address is passed to this virtual since it is hidden as private. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>address</em>&nbsp;</td><td>of buffer to pull data into. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of buffer area being pulled.. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of read written, 0 on error or end of data. </dd></dl>

<p>Reimplemented from <a class="el" href="a00057.html#ad6089d06f36137661b2f0c37943a4187">ucc::IOBuffer</a>.</p>

</div>
</div>
<a class="anchor" id="a6633944cf18140194347af2c0c342ca5"></a><!-- doxytag: member="ucc::fbuf::_push" ref="a6633944cf18140194347af2c0c342ca5" args="(const char *address, size_t size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t ucc::fbuf::_push </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>address</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Method to push buffer into physical i/o (write). </p>
<p>The address is passed to this virtual since it is hidden as private. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>address</em>&nbsp;</td><td>of data to push. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of data to push. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes written, 0 on error. </dd></dl>

<p>Reimplemented from <a class="el" href="a00057.html#abe10b39c40a9cc0ba70b9e025dec072a">ucc::IOBuffer</a>.</p>

</div>
</div>
<a class="anchor" id="aaff0843a4f0883c07d48509172c1d2d9"></a><!-- doxytag: member="ucc::fbuf::create" ref="aaff0843a4f0883c07d48509172c1d2d9" args="(const char *path, fsys::access_t access=fsys::ACCESS_APPEND, unsigned permissions=0640, size_t size=512)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ucc::fbuf::create </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>path</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00056.html#a5e886a4f005b2a2948d2a3fb4e9f0deb">fsys::access_t</a>&nbsp;</td>
          <td class="paramname"> <em>access</em> = <code>fsys::ACCESS_APPEND</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&nbsp;</td>
          <td class="paramname"> <em>permissions</em> = <code>0640</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em> = <code>512</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Create and open the specified file. </p>
<p>If a file is currently open, it is closed first. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>of file to create. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>access</em>&nbsp;</td><td>mode of file (rw, rdonly, etc). </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>permissions</em>&nbsp;</td><td>of the newly created file. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of the stream buffer. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a079696d95987700062e332333a459147"></a><!-- doxytag: member="ucc::fbuf::open" ref="a079696d95987700062e332333a459147" args="(const char *path, fsys::access_t access=fsys::ACCESS_RDWR, size_t size=512)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ucc::fbuf::open </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>path</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00056.html#a5e886a4f005b2a2948d2a3fb4e9f0deb">fsys::access_t</a>&nbsp;</td>
          <td class="paramname"> <em>access</em> = <code>fsys::ACCESS_RDWR</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em> = <code>512</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Construct a file buffer that opens an existing file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>of existing file to open. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>access</em>&nbsp;</td><td>mode of file (rw, rdonly, etc). </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of the stream buffer. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="affe16ef4d154e6b4de1203cbf6f6a300"></a><!-- doxytag: member="ucc::fbuf::seek" ref="affe16ef4d154e6b4de1203cbf6f6a300" args="(offset_t offset)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ucc::fbuf::seek </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00056.html#acd8d82ddbf77b2c44371f3bf19746f60">offset_t</a>&nbsp;</td>
          <td class="paramname"> <em>offset</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Seek specific offset in open file and reset I/O buffers. </p>
<p>If the file is opened for both read and write, both the read and write position will be reset. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>offset</em>&nbsp;</td><td>to seek. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful. </dd></dl>

<p>Reimplemented from <a class="el" href="a00056.html#a7625032c1759131bd42309491bc32bab">ucc::fsys</a>.</p>

</div>
</div>
<a class="anchor" id="abc4559a73cb9e1ccf011cc58a8107dd1"></a><!-- doxytag: member="ucc::fbuf::tell" ref="abc4559a73cb9e1ccf011cc58a8107dd1" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00056.html#acd8d82ddbf77b2c44371f3bf19746f60">offset_t</a> ucc::fbuf::tell </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Give the current position in the currently open file. </p>
<p>If we are appending, this is alwayus seek::end. If we have a file opened for both read and write, this gives the read offset. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>file offset of current i/o operations. </dd></dl>

</div>
</div>
<a class="anchor" id="a1d548d9babb9c5494018ff0f01c10505"></a><!-- doxytag: member="ucc::fbuf::trunc" ref="a1d548d9babb9c5494018ff0f01c10505" args="(offset_t offset)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ucc::fbuf::trunc </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00056.html#acd8d82ddbf77b2c44371f3bf19746f60">offset_t</a>&nbsp;</td>
          <td class="paramname"> <em>offset</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Truncate the currently open file to a specific position. </p>
<p>All I/O buffers are reset and the file pointer is set to the end. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>offset</em>&nbsp;</td><td>to truncate. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful. </dd></dl>

<p>Reimplemented from <a class="el" href="a00056.html#a238fa44a3eb9c6f37f0ceede3f0234a4">ucc::fsys</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00189_source.html">buffer.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:29 2010 for UCommon by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>