Blame docs/reference/gio/html/GBufferedOutputStream.html

Packit ae235b
Packit ae235b
<html>
Packit ae235b
<head>
Packit ae235b
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit ae235b
<title>GBufferedOutputStream: GIO Reference Manual</title>
Packit ae235b
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit ae235b
<link rel="home" href="index.html" title="GIO Reference Manual">
Packit ae235b
<link rel="up" href="streaming.html" title="Streaming I/O">
Packit ae235b
<link rel="prev" href="GBufferedInputStream.html" title="GBufferedInputStream">
Packit ae235b
<link rel="next" href="GDataInputStream.html" title="GDataInputStream">
Packit ae235b
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
Packit ae235b
<link rel="stylesheet" href="style.css" type="text/css">
Packit ae235b
</head>
Packit ae235b
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit ae235b
Packit ae235b
Packit ae235b
Top  | 
Packit ae235b
                  Description  | 
Packit ae235b
                  Object Hierarchy  | 
Packit ae235b
                  Implemented Interfaces  | 
Packit ae235b
                  Properties
Packit ae235b
Packit ae235b
Home
Packit ae235b
Up
Packit ae235b
Prev
Packit ae235b
Next
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

GBufferedOutputStream

Packit ae235b

GBufferedOutputStream — Buffered Output Stream

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Functions

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
GOutputStream *
Packit ae235b
Packit ae235b
Packit ae235b
g_buffered_output_stream_new ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
GOutputStream *
Packit ae235b
Packit ae235b
Packit ae235b
g_buffered_output_stream_new_sized ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
gsize
Packit ae235b
Packit ae235b
Packit ae235b
g_buffered_output_stream_get_buffer_size ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_buffered_output_stream_set_buffer_size ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
gboolean
Packit ae235b
Packit ae235b
Packit ae235b
g_buffered_output_stream_get_auto_grow ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
void
Packit ae235b
Packit ae235b
Packit ae235b
g_buffered_output_stream_set_auto_grow ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Properties

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
gboolean
Packit ae235b
auto-grow
Packit ae235b
Read / Write
Packit ae235b
Packit ae235b
Packit ae235b
guint
Packit ae235b
buffer-size
Packit ae235b
Read / Write / Construct
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Types and Values

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
 
Packit ae235b
GBufferedOutputStream
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Object Hierarchy

Packit ae235b
    GObject
Packit ae235b
    ╰── GOutputStream
Packit ae235b
        ╰── GFilterOutputStream
Packit ae235b
            ╰── GBufferedOutputStream
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Implemented Interfaces

Packit ae235b

Packit ae235b
GBufferedOutputStream implements
Packit ae235b
 GSeekable.

Packit ae235b
Packit ae235b
Packit ae235b

Includes

Packit ae235b
#include <gio/gio.h>
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Description

Packit ae235b

Buffered output stream implements GFilterOutputStream and provides

Packit ae235b
for buffered writes. 

Packit ae235b

By default, GBufferedOutputStream's buffer size is set at 4 kilobytes.

Packit ae235b

To create a buffered output stream, use g_buffered_output_stream_new(),

Packit ae235b
or g_buffered_output_stream_new_sized() to specify the buffer's size 
Packit ae235b
at construction.

Packit ae235b

To get the size of a buffer within a buffered input stream, use

Packit ae235b
g_buffered_output_stream_get_buffer_size(). To change the size of a 
Packit ae235b
buffered output stream's buffer, use 
Packit ae235b
g_buffered_output_stream_set_buffer_size(). Note that the buffer's 
Packit ae235b
size cannot be reduced below the size of the data within the buffer.

Packit ae235b
Packit ae235b
Packit ae235b

Functions

Packit ae235b
Packit ae235b

g_buffered_output_stream_new ()

Packit ae235b
GOutputStream *
Packit ae235b
g_buffered_output_stream_new (GOutputStream *base_stream);
Packit ae235b

Creates a new buffered output stream for a base stream.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

base_stream

Packit ae235b

a GOutputStream.

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

a GOutputStream for the given base_stream

Packit ae235b
.

Packit ae235b
Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_buffered_output_stream_new_sized ()

Packit ae235b
GOutputStream *
Packit ae235b
g_buffered_output_stream_new_sized (GOutputStream *base_stream,
Packit ae235b
                                    gsize size);
Packit ae235b

Creates a new buffered output stream with a given buffer size.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

base_stream

Packit ae235b

a GOutputStream.

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

size

Packit ae235b

a gsize.

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

a GOutputStream with an internal buffer set to size

Packit ae235b
.

Packit ae235b
Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_buffered_output_stream_get_buffer_size ()

Packit ae235b
gsize
Packit ae235b
g_buffered_output_stream_get_buffer_size
Packit ae235b
                               (GBufferedOutputStream *stream);
Packit ae235b

Gets the size of the buffer in the stream

Packit ae235b
.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

stream

Packit ae235b

a GBufferedOutputStream.

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

the current size of the buffer.

Packit ae235b
Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_buffered_output_stream_set_buffer_size ()

Packit ae235b
void
Packit ae235b
g_buffered_output_stream_set_buffer_size
Packit ae235b
                               (GBufferedOutputStream *stream,
Packit ae235b
                                gsize size);
Packit ae235b

Sets the size of the internal buffer to size

Packit ae235b
.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

stream

Packit ae235b

a GBufferedOutputStream.

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

size

Packit ae235b

a gsize.

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_buffered_output_stream_get_auto_grow ()

Packit ae235b
gboolean
Packit ae235b
g_buffered_output_stream_get_auto_grow
Packit ae235b
                               (GBufferedOutputStream *stream);
Packit ae235b

Checks if the buffer automatically grows as data is added.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

stream

Packit ae235b

a GBufferedOutputStream.

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

TRUE if the stream

Packit ae235b
's buffer automatically grows,
Packit ae235b
FALSE otherwise.

Packit ae235b
Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_buffered_output_stream_set_auto_grow ()

Packit ae235b
void
Packit ae235b
g_buffered_output_stream_set_auto_grow
Packit ae235b
                               (GBufferedOutputStream *stream,
Packit ae235b
                                gboolean auto_grow);
Packit ae235b

Sets whether or not the stream

Packit ae235b
's buffer should automatically grow.
Packit ae235b
If auto_grow
Packit ae235b
 is true, then each write will just make the buffer
Packit ae235b
larger, and you must manually flush the buffer to actually write out
Packit ae235b
the data to the underlying stream.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

stream

Packit ae235b

a GBufferedOutputStream.

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

auto_grow

Packit ae235b

a gboolean.

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Types and Values

Packit ae235b
Packit ae235b

GBufferedOutputStream

Packit ae235b
typedef struct _GBufferedOutputStream GBufferedOutputStream;
Packit ae235b

An implementation of GFilterOutputStream with a sized buffer.

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Property Details

Packit ae235b
Packit ae235b

The “auto-grow” property

Packit ae235b
  “auto-grow”                gboolean
Packit ae235b

Whether the buffer should automatically grow.

Packit ae235b

Flags: Read / Write

Packit ae235b

Default value: FALSE

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

The “buffer-size” property

Packit ae235b
  “buffer-size”              guint
Packit ae235b

The size of the backend buffer.

Packit ae235b

Flags: Read / Write / Construct

Packit ae235b

Allowed values: >= 1

Packit ae235b

Default value: 4096

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

See Also

Packit ae235b

GFilterOutputStream, GOutputStream

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Generated by GTK-Doc V1.27
Packit ae235b
</body>
Packit ae235b
</html>