glibmm  2.33.13
Public Member Functions | Static Public Member Functions | Related Functions
Gio::FilterInputStream Class Reference

Filter Input Stream. More...

#include <giomm/filterinputstream.h>

Inheritance diagram for Gio::FilterInputStream:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~FilterInputStream ()
GFilterInputStream* gobj ()
 Provides access to the underlying C GObject.
const GFilterInputStream* gobj () const
 Provides access to the underlying C GObject.
GFilterInputStream* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::RefPtr< InputStreamget_base_stream ()
 Gets the base stream for the filter stream.
Glib::RefPtr< const InputStreamget_base_stream () const
 Gets the base stream for the filter stream.
bool get_close_base_stream () const
 Returns whether the base stream will be closed when stream is closed.
void set_close_base_stream (bool close_base=true)
 Sets whether the base stream will be closed when stream is closed.
Glib::PropertyProxy_ReadOnly
< Glib::RefPtr< InputStream > > 
property_base_stream () const
 The underlying base stream on which the io ops will be done.
Glib::PropertyProxy< bool > property_close_base_stream ()
 If the base stream should be closed when the filter stream is closed.
Glib::PropertyProxy_ReadOnly
< bool > 
property_close_base_stream () const
 If the base stream should be closed when the filter stream is closed.
- Public Member Functions inherited from Gio::InputStream
virtual ~InputStream ()
gssize read (void* buffer, gsize count, const Glib::RefPtr< Cancellable >& cancellable)
 Tries to read count bytes from the stream into the buffer starting at buffer.
gssize read (void* buffer, gsize count)
 A read() convenience overload.
bool read_all (void* buffer, gsize count, gsize& bytes_read, const Glib::RefPtr< Cancellable >& cancellable)
 Tries to read count bytes from the stream into the buffer starting at buffer.
bool read_all (void* buffer, gsize count, gsize& bytes_read)
 A read_all() convenience overload.
Glib::RefPtr< Glib::Bytesread_bytes (gsize count, const Glib::RefPtr< Cancellable >& cancellable)
 Like g_input_stream_read(), this tries to read count bytes from the stream in a blocking fashion.
void read_bytes_async (gsize count, const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable, int io_priority=Glib::PRIORITY_DEFAULT)
void read_bytes_async (gsize count, const SlotAsyncReady& slot, int io_priority=Glib::PRIORITY_DEFAULT)
Glib::RefPtr< Glib::Bytesread_bytes_finish (const Glib::RefPtr< AsyncResult >& result)
 Finishes an asynchronous stream read-into-Bytes operation.
gssize skip (gsize count, const Glib::RefPtr< Cancellable >& cancellable)
 Tries to skip count bytes from the stream.
gssize skip (gsize count)
 A skip() convenience overload.
bool close (const Glib::RefPtr< Cancellable >& cancellable)
 Closes the stream, releasing resources related to it.
bool close ()
 A close() convenience overload.
void read_async (void* buffer, gsize count, const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable, int io_priority=Glib::PRIORITY_DEFAULT)
 Request an asynchronous read of count bytes from the stream into the buffer starting at buffer.
void read_async (void* buffer, gsize count, const SlotAsyncReady& slot, int io_priority=Glib::PRIORITY_DEFAULT)
 Request an asynchronous read of count bytes from the stream into the buffer starting at buffer.
gssize read_finish (const Glib::RefPtr< AsyncResult >& result)
 Finishes an asynchronous stream read operation.
void skip_async (gsize count, const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable, int io_priority=Glib::PRIORITY_DEFAULT)
 Request an asynchronous skip of count bytes from the stream into the buffer starting at buffer.
void skip_async (gsize count, const SlotAsyncReady& slot, int io_priority=Glib::PRIORITY_DEFAULT)
 Request an asynchronous skip of count bytes from the stream into the buffer starting at buffer.
gssize skip_finish (const Glib::RefPtr< AsyncResult >& result)
 Finishes a stream skip operation.
void close_async (const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable, int io_priority=Glib::PRIORITY_DEFAULT)
 Requests an asynchronous closes of the stream, releasing resources related to it.
void close_async (const SlotAsyncReady& slot, int io_priority=Glib::PRIORITY_DEFAULT)
 Requests an asynchronous closes of the stream, releasing resources related to it.
gboolean close_finish (const Glib::RefPtr< AsyncResult >& result)
 Finishes closing a stream asynchronously, started from g_input_stream_close_async().
- Public Member Functions inherited from Glib::Object
void* get_data (const QueryQuark& key)
void set_data (const Quark& key, void* data)
void set_data (const Quark& key, void* data, DestroyNotify notify)
void remove_data (const QueryQuark& quark)
void* steal_data (const QueryQuark& quark)
- Public Member Functions inherited from Glib::ObjectBase
void set_property_value (const Glib::ustring& property_name, const Glib::ValueBase&value)
 You probably want to use a specific property_*() accessor method instead.
void get_property_value (const Glib::ustring& property_name, Glib::ValueBase&value) const
 You probably want to use a specific property_*() accessor method instead.
template<class PropertyType >
void set_property (const Glib::ustring& property_name, const PropertyType&value)
 You probably want to use a specific property_*() accessor method instead.
template<class PropertyType >
void get_property (const Glib::ustring& property_name, PropertyType&value) const
 You probably want to use a specific property_*() accessor method instead.
void connect_property_changed (const Glib::ustring& property_name, const sigc::slot< void >& slot)
 You can use the signal_changed() signal of the property proxy instead, but this is necessary when using the reduced API.
sigc::connection connect_property_changed_with_return (const Glib::ustring& property_name, const sigc::slot< void >& slot)
 You can use the signal_changed() signal of the property proxy instead, but this is necessary when using the reduced API.
void freeze_notify ()
 Increases the freeze count on object.
void thaw_notify ()
 Reverts the effect of a previous call to freeze_notify().
virtual void reference () const
 Increment the reference count for this object.
virtual void unreference () const
 Decrement the reference count for this object.
GObject* gobj_copy () const
 Give a ref-ed copy to someone. Use for direct struct access.

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.

Related Functions

(Note that these are not member functions.)

Glib::RefPtr
< Gio::FilterInputStream
wrap (GFilterInputStream* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Detailed Description

Filter Input Stream.

This is a base class for input stream implementations that perform some kind of filtering operation on a base stream. & Typical examples of filtering operations are character set conversion, compression and byte order flipping.

Since glibmm 2.16:

Constructor & Destructor Documentation

virtual Gio::FilterInputStream::~FilterInputStream ( )
virtual

Member Function Documentation

Glib::RefPtr<InputStream> Gio::FilterInputStream::get_base_stream ( )

Gets the base stream for the filter stream.

Returns:
A InputStream.
Glib::RefPtr<const InputStream> Gio::FilterInputStream::get_base_stream ( ) const

Gets the base stream for the filter stream.

Returns:
A InputStream.
bool Gio::FilterInputStream::get_close_base_stream ( ) const

Returns whether the base stream will be closed when stream is closed.

Returns:
true if the base stream will be closed.
static GType Gio::FilterInputStream::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

Reimplemented from Gio::InputStream.

Reimplemented in Gio::BufferedInputStream, Gio::ConverterInputStream, and Gio::DataInputStream.

GFilterInputStream* Gio::FilterInputStream::gobj ( )
inline

Provides access to the underlying C GObject.

Reimplemented from Gio::InputStream.

Reimplemented in Gio::BufferedInputStream, Gio::ConverterInputStream, and Gio::DataInputStream.

const GFilterInputStream* Gio::FilterInputStream::gobj ( ) const
inline

Provides access to the underlying C GObject.

Reimplemented from Gio::InputStream.

Reimplemented in Gio::BufferedInputStream, Gio::ConverterInputStream, and Gio::DataInputStream.

GFilterInputStream* Gio::FilterInputStream::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

Reimplemented from Gio::InputStream.

Reimplemented in Gio::BufferedInputStream, Gio::ConverterInputStream, and Gio::DataInputStream.

Glib::PropertyProxy_ReadOnly< Glib::RefPtr<InputStream> > Gio::FilterInputStream::property_base_stream ( ) const

The underlying base stream on which the io ops will be done.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gio::FilterInputStream::property_close_base_stream ( )

If the base stream should be closed when the filter stream is closed.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gio::FilterInputStream::property_close_base_stream ( ) const

If the base stream should be closed when the filter stream is closed.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
void Gio::FilterInputStream::set_close_base_stream ( bool  close_base = true)

Sets whether the base stream will be closed when stream is closed.

Parameters:
close_basetrue to close the base stream.

Friends And Related Function Documentation

Glib::RefPtr< Gio::FilterInputStream > wrap ( GFilterInputStream *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters:
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.