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

MemoryInputStream implements InputStream for arbitrary memory chunks. More...

#include <giomm/memoryinputstream.h>

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

List of all members.

Public Member Functions

virtual ~MemoryInputStream ()
GMemoryInputStream* gobj ()
 Provides access to the underlying C GObject.
const GMemoryInputStream* gobj () const
 Provides access to the underlying C GObject.
GMemoryInputStream* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
void add_data (const std::string& data)
 Appends to data that can be read from the input stream.
void add_data (const void* data, gssize len)
 Appends to data that can be read from the input stream.
void add_data (const void* data, gssize len, GDestroyNotify destroy)
 Appends to data that can be read from the input stream.
- 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.
- Public Member Functions inherited from Gio::Seekable
virtual ~Seekable ()
goffset tell () const
 Tells the current position within the stream.
bool can_seek () const
 Tests if the stream supports the SeekableIface.
bool seek (goffset offset, Glib::SeekType type, const Glib::RefPtr< Cancellable >& cancellable)
 Seeks in the stream by the given offset, modified by type.
bool seek (goffset offset, Glib::SeekType type)
 A seek() convenience overload.
bool can_truncate () const
 Tests if the stream can be truncated.
bool truncate (goffset offset, const Glib::RefPtr< Cancellable >& cancellable)
 Truncates a stream with a given #offset.
bool truncate (goffset offset)
 A truncate() convenience overload.
- Public Member Functions inherited from Glib::Interface
 Interface (const Glib::Interface_Class& interface_class)
 Called by constructors of derived classes.
 Interface (GObject* castitem)
 Called by constructors of derived classes.
virtual ~Interface ()

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.
static Glib::RefPtr
< MemoryInputStream
create ()
- Static Public Member Functions inherited from Gio::Seekable
static void add_interface (GType gtype_implementer)

Protected Member Functions

 MemoryInputStream ()
- Protected Member Functions inherited from Gio::Seekable
 Seekable ()
 You should derive from this class to use it.

Related Functions

(Note that these are not member functions.)

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

Detailed Description

MemoryInputStream implements InputStream for arbitrary memory chunks.

Since glibmm 2.16:

Constructor & Destructor Documentation

virtual Gio::MemoryInputStream::~MemoryInputStream ( )
virtual
Gio::MemoryInputStream::MemoryInputStream ( )
protected

Member Function Documentation

void Gio::MemoryInputStream::add_data ( const std::string data)

Appends to data that can be read from the input stream.

Parameters:
dataInput data.
void Gio::MemoryInputStream::add_data ( const void *  data,
gssize  len 
)

Appends to data that can be read from the input stream.

Note that the data will copied internally and freed when no longer needed.

Parameters:
dataInput data.
lenLength of the data, may be -1 if data is a null-terminated string.
Deprecated:
Use version with destroy notification
void Gio::MemoryInputStream::add_data ( const void *  data,
gssize  len,
GDestroyNotify  destroy 
)

Appends to data that can be read from the input stream.

Parameters:
dataInput data.
lenLength of the data, may be -1 if data is a null-terminated string.
destroyA function to be called to free the data when it is no longer needed
static Glib::RefPtr<MemoryInputStream> Gio::MemoryInputStream::create ( )
static
static GType Gio::MemoryInputStream::get_type ( )
static

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

Reimplemented from Gio::InputStream.

GMemoryInputStream* Gio::MemoryInputStream::gobj ( )
inline

Provides access to the underlying C GObject.

Reimplemented from Gio::InputStream.

const GMemoryInputStream* Gio::MemoryInputStream::gobj ( ) const
inline

Provides access to the underlying C GObject.

Reimplemented from Gio::InputStream.

GMemoryInputStream* Gio::MemoryInputStream::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.


Friends And Related Function Documentation

Glib::RefPtr< Gio::MemoryInputStream > wrap ( GMemoryInputStream *  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.