~ubuntu-branches/ubuntu/utopic/glib2.0/utopic

<a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-get-buffer-size" title="g_buffered_input_stream_get_buffer_size ()">g_buffered_input_stream_get_buffer_size</a> ()

</tr>

<tr>

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a>

<a href="../glib/glib-Basic-Types.html#gsize">gsize</a>

</td>

<a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-get-available" title="g_buffered_input_stream_get_available ()">g_buffered_input_stream_get_available</a> ()

</tr>

<tr>

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a>

<a href="../glib/glib-Basic-Types.html#gsize">gsize</a>

</td>

<a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-peek" title="g_buffered_input_stream_peek ()">g_buffered_input_stream_peek</a> ()

</tr>

100

<tr>

101

102

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

102

<a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

103

</td>

104

105

<a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-fill" title="g_buffered_input_stream_fill ()">g_buffered_input_stream_fill</a> ()

115

</tr>

116

<tr>

117

118

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

118

<a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

119

</td>

120

121

<a class="link" href="GBufferedInputStream.html#g-buffered-input-stream-fill-finish" title="g_buffered_input_stream_fill_finish ()">g_buffered_input_stream_fill_finish</a> ()

141

142

</colgroup>

143

144

<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a></td>

144

<td class="property_type"><a href="../glib/glib-Basic-Types.html#guint">guint</a></td>

145

<td class="property_name"><a class="link" href="GBufferedInputStream.html#GBufferedInputStream--buffer-size" title="The “buffer-size” property">buffer-size</a></td>

146

<td class="property_flags">Read / Write / Construct</td>

147

</tr></tbody>

162

</div>

163

164

<a name="GBufferedInputStream.object-hierarchy"></a><h2>Object Hierarchy</h2>

165

<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>

165

<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>

166

╰── <a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a>

167

╰── <a class="link" href="GFilterInputStream.html" title="GFilterInputStream">GFilterInputStream</a>

168

╰── GBufferedInputStream

230

<a name="g-buffered-input-stream-new-sized"></a><h3>g_buffered_input_stream_new_sized ()</h3>

231

<pre class="programlisting"><a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *

232

g_buffered_input_stream_new_sized (<code><a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *base_stream</code>,

233

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> size</code>);</pre>

233

<code><a href="../glib/glib-Basic-Types.html#gsize">gsize</a> size</code>);</pre>

234

Creates a new <a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> from the given <code>base_stream</code>

235

236

with a buffer set to <code>size</code>

251

</tr>

252

<tr>

253

254

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a></td>

254

<td class="parameter_description">a <a href="../glib/glib-Basic-Types.html#gsize">gsize</a></td>

255

256

</tr>

257

</tbody>

266

<hr>

267

268

<a name="g-buffered-input-stream-get-buffer-size"></a><h3>g_buffered_input_stream_get_buffer_size ()</h3>

269

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a>

269

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gsize">gsize</a>

270

g_buffered_input_stream_get_buffer_size

271

(<code><a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream</code>);</pre>

272

Gets the size of the input buffer.

297

<pre class="programlisting">void

298

g_buffered_input_stream_set_buffer_size

299

(<code><a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream</code>,

300

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> size</code>);</pre>

300

<code><a href="../glib/glib-Basic-Types.html#gsize">gsize</a> size</code>);</pre>

301

Sets the size of the internal buffer of <code>stream</code>

302

to <code>size</code>

303

, or to the

319

</tr>

320

<tr>

321

322

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a></td>

322

<td class="parameter_description">a <a href="../glib/glib-Basic-Types.html#gsize">gsize</a></td>

323

324

</tr>

325

</tbody>

329

<hr>

330

331

<a name="g-buffered-input-stream-get-available"></a><h3>g_buffered_input_stream_get_available ()</h3>

332

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a>

332

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gsize">gsize</a>

333

g_buffered_input_stream_get_available (<code><a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream</code>);</pre>

334

Gets the size of the available data within the stream.

335

358

<a name="g-buffered-input-stream-peek-buffer"></a><h3>g_buffered_input_stream_peek_buffer ()</h3>

359

<pre class="programlisting">const void *

360

g_buffered_input_stream_peek_buffer (<code><a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream</code>,

361

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> *count</code>);</pre>

361

<code><a href="../glib/glib-Basic-Types.html#gsize">gsize</a> *count</code>);</pre>

362

Returns the buffer with the currently available bytes. The returned

363

buffer must not be modified and will become invalid when reading from

364

the stream or filling the buffer.

378

</tr>

379

<tr>

380

<td class="parameter_name">count</td>

381

<td class="parameter_description"> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> to get the number of bytes available in the buffer. </td>

381

<td class="parameter_description"> a <a href="../glib/glib-Basic-Types.html#gsize">gsize</a> to get the number of bytes available in the buffer. </td>

382

383

</tr>

384

</tbody>

393

<hr>

394

395

<a name="g-buffered-input-stream-peek"></a><h3>g_buffered_input_stream_peek ()</h3>

396

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a>

396

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gsize">gsize</a>

397

g_buffered_input_stream_peek (<code><a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream</code>,

398

<code>void *buffer</code>,

399

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> offset</code>,

400

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> count</code>);</pre>

399

<code><a href="../glib/glib-Basic-Types.html#gsize">gsize</a> offset</code>,

400

<code><a href="../glib/glib-Basic-Types.html#gsize">gsize</a> count</code>);</pre>

401

Peeks in the buffer, copying data of size <code>count</code>

402

into <code>buffer</code>

403

425

</tr>

426

<tr>

427

<td class="parameter_name">offset</td>

428

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a></td>

428

<td class="parameter_description">a <a href="../glib/glib-Basic-Types.html#gsize">gsize</a></td>

429

430

</tr>

431

<tr>

432

<td class="parameter_name">count</td>

433

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a></td>

433

<td class="parameter_description">a <a href="../glib/glib-Basic-Types.html#gsize">gsize</a></td>

434

435

</tr>

436

</tbody>

438

</div>

439

440

<a name="id-1.4.7.14.10.8.6"></a><h4>Returns</h4>

441

a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> of the number of bytes peeked, or -1 on error.

441

a <a href="../glib/glib-Basic-Types.html#gsize">gsize</a> of the number of bytes peeked, or -1 on error.

442

443

</div>

444

</div>

445

<hr>

446

447

<a name="g-buffered-input-stream-fill"></a><h3>g_buffered_input_stream_fill ()</h3>

448

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

448

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

449

g_buffered_input_stream_fill (<code><a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream</code>,

450

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a> count</code>,

450

<code><a href="../glib/glib-Basic-Types.html#gssize">gssize</a> count</code>,

451

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

452

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

452

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

453

Tries to read <code>count</code>

454

bytes from the stream into the buffer.

455

Will block during this read.

456

If <code>count</code>

457

is zero, returns zero and does nothing. A value of <code>count</code>

458

459

larger than <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#G-MAXSSIZE:CAPS"><code class="literal">G_MAXSSIZE</code></a> will cause a <a class="link" href="gio-GIOError.html#G-IO-ERROR-INVALID-ARGUMENT:CAPS"><code class="literal">G_IO_ERROR_INVALID_ARGUMENT</code></a> error.

459

larger than <a href="../glib/glib-Basic-Types.html#G-MAXSSIZE:CAPS"><code class="literal">G_MAXSSIZE</code></a> will cause a <a class="link" href="gio-GIOError.html#G-IO-ERROR-INVALID-ARGUMENT:CAPS"><code class="literal">G_IO_ERROR_INVALID_ARGUMENT</code></a> error.

460

On success, the number of bytes read into the buffer is returned.

461

It is not an error if this is not the same as the requested size, as it

462

can happen e.g. near the end of a file. Zero is returned on end of file

466

is -1 then the attempted read size is equal to the number of

467

bytes that are required to fill the buffer.

468

If <code>cancellable</code>

469

is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by

469

is not <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by

470

triggering the cancellable object from another thread. If the operation

471

was cancelled, the error <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be returned. If an

472

operation was partially finished when the operation was cancelled the

496

</tr>

497

<tr>

498

<td class="parameter_name">cancellable</td>

499

<td class="parameter_description"> optional <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> object, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </td>

499

<td class="parameter_description"> optional <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> object, <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </td>

500

<td class="parameter_annotations">[<acronym title="NULL is OK, both for passing and for returning.">allow-none</acronym>]</td>

501

</tr>

502

<tr>

503

<td class="parameter_name">error</td>

504

<td class="parameter_description">location to store the error occurring, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</td>

504

<td class="parameter_description">location to store the error occurring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</td>

505

506

</tr>

507

</tbody>

521

<a name="g-buffered-input-stream-fill-async"></a><h3>g_buffered_input_stream_fill_async ()</h3>

522

<pre class="programlisting">void

523

g_buffered_input_stream_fill_async (<code><a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream</code>,

524

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a> count</code>,

524

<code><a href="../glib/glib-Basic-Types.html#gssize">gssize</a> count</code>,

525

<code>int io_priority</code>,

526

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

527

<code><a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a> callback</code>,

528

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

528

<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

529

Reads data into <code>stream</code>

530

's buffer asynchronously, up to <code>count</code>

531

size.

571

</tr>

572

<tr>

573

574

<td class="parameter_description"> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a>. </td>

574

<td class="parameter_description"> a <a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a>. </td>

575

<td class="parameter_annotations">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here.">closure</acronym>]</td>

576

</tr>

577

</tbody>

581

<hr>

582

583

<a name="g-buffered-input-stream-fill-finish"></a><h3>g_buffered_input_stream_fill_finish ()</h3>

584

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

584

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

585

g_buffered_input_stream_fill_finish (<code><a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream</code>,

586

<code><a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result</code>,

587

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

587

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

588

Finishes an asynchronous read.

589

590

<a name="id-1.4.7.14.10.11.5"></a><h4>Parameters</h4>

607

</tr>

608

<tr>

609

<td class="parameter_name">error</td>

610

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a></td>

610

<td class="parameter_description">a <a href="../glib/glib-Error-Reporting.html#GError">GError</a></td>

611

612

</tr>

613

</tbody>

615

</div>

616

617

<a name="id-1.4.7.14.10.11.6"></a><h4>Returns</h4>

618

a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a> of the read stream, or <code class="literal">-1</code> on an error.

618

a <a href="../glib/glib-Basic-Types.html#gssize">gssize</a> of the read stream, or <code class="literal">-1</code> on an error.

619

620

</div>

621

</div>

625

<pre class="programlisting">int

626

g_buffered_input_stream_read_byte (<code><a class="link" href="GBufferedInputStream.html" title="GBufferedInputStream">GBufferedInputStream</a> *stream</code>,

627

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

628

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

628

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

629

Tries to read a single byte from the stream or the buffer. Will block

630

during this read.

631

On success, the byte read from the stream is returned. On end of stream

632

-1 is returned but it's not an exceptional error and <code>error</code>

633

is not set.

634

If <code>cancellable</code>

635

is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by

635

is not <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by

636

triggering the cancellable object from another thread. If the operation

637

was cancelled, the error <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be returned. If an

638

operation was partially finished when the operation was cancelled the

655

</tr>

656

<tr>

657

<td class="parameter_name">cancellable</td>

658

<td class="parameter_description"> optional <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> object, <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </td>

659

<td class="parameter_annotations">[<acronym title="NULL is OK, both for passing and for returning.">allow-none</acronym>]</td>

660

</tr>

661

<tr>

662

<td class="parameter_name">error</td>

663

<td class="parameter_description">location to store the error occurring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</td>

664

665

</tr>

666

</tbody>

686

<a name="GBufferedInputStream.property-details"></a><h2>Property Details</h2>

687

688

<a name="GBufferedInputStream--buffer-size"></a><h3>The <code class="literal">“buffer-size”</code> property</h3>

689

<pre class="programlisting"> “buffer-size” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint">guint</a></pre>

689

<pre class="programlisting"> “buffer-size” <a href="../glib/glib-Basic-Types.html#guint">guint</a></pre>

690

The size of the backend buffer.

691

Flags: Read / Write / Construct

692

Allowed values: >= 1

Older »