glibmm  2.42.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gio::MemoryInputStream Class Reference

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

#include <giomm/memoryinputstream.h>

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

Public Types

typedef sigc::slot< void, void* > SlotDestroyData
 For example, void on_destroy_data(void* data);. More...
 
- Public Types inherited from Glib::Object
typedef void(* DestroyNotify )(gpointer data)
 

Public Member Functions

virtual ~MemoryInputStream ()
 
GMemoryInputStream* gobj ()
 Provides access to the underlying C GObject. More...
 
const GMemoryInputStream* gobj () const
 Provides access to the underlying C GObject. More...
 
GMemoryInputStream* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
void add_data (const std::string& data)
 Appends to data that can be read from the input stream. More...
 
void add_data (const void* data, gssize len)
 Appends to data that can be read from the input stream. More...
 
void add_data (const void* data, gssize len, GDestroyNotify destroy)
 Appends data to data that can be read from the input stream. More...
 
void add_data (const void* data, gssize len, const SlotDestroyData& destroy_slot)
 Appends to data that can be read from the input stream. More...
 
- Public Member Functions inherited from Gio::InputStream
virtual ~InputStream ()
 
GInputStream* gobj ()
 Provides access to the underlying C GObject. More...
 
const GInputStream* gobj () const
 Provides access to the underlying C GObject. More...
 
GInputStream* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
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. More...
 
gssize read (void* buffer, gsize count)
 A read() convenience overload. More...
 
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. More...
 
bool read_all (void* buffer, gsize count, gsize& bytes_read)
 A read_all() convenience overload. More...
 
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. More...
 
void read_bytes_async (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 a new Glib::Bytes. More...
 
void read_bytes_async (gsize count, const SlotAsyncReady& slot, int io_priority=Glib::PRIORITY_DEFAULT)
 Request an asynchronous read of count bytes from the stream into a new Glib::Bytes. More...
 
Glib::RefPtr< Glib::Bytesread_bytes_finish (const Glib::RefPtr< AsyncResult >& result)
 Finishes an asynchronous stream read-into-Bytes operation. More...
 
gssize skip (gsize count, const Glib::RefPtr< Cancellable >& cancellable)
 Tries to skip count bytes from the stream. More...
 
gssize skip (gsize count)
 A skip() convenience overload. More...
 
bool close (const Glib::RefPtr< Cancellable >& cancellable)
 Closes the stream, releasing resources related to it. More...
 
bool close ()
 A close() convenience overload. More...
 
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. More...
 
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. More...
 
gssize read_finish (const Glib::RefPtr< AsyncResult >& result)
 Finishes an asynchronous stream read operation. More...
 
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. More...
 
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. More...
 
gssize skip_finish (const Glib::RefPtr< AsyncResult >& result)
 Finishes a stream skip operation. More...
 
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. More...
 
void close_async (const SlotAsyncReady& slot, int io_priority=Glib::PRIORITY_DEFAULT)
 Requests an asynchronous closes of the stream, releasing resources related to it. More...
 
gboolean close_finish (const Glib::RefPtr< AsyncResult >& result)
 Finishes closing a stream asynchronously, started from g_input_stream_close_async(). More...
 
- 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. More...
 
void get_property_value (const Glib::ustring& property_name, Glib::ValueBase& value) const
 You probably want to use a specific property_*() accessor method instead. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
void freeze_notify ()
 Increases the freeze count on object. More...
 
void thaw_notify ()
 Reverts the effect of a previous call to freeze_notify(). More...
 
virtual void reference () const
 Increment the reference count for this object. More...
 
virtual void unreference () const
 Decrement the reference count for this object. More...
 
GObject* gobj ()
 Provides access to the underlying C GObject. More...
 
const GObject* gobj () const
 Provides access to the underlying C GObject. More...
 
GObject* gobj_copy () const
 Give a ref-ed copy to someone. Use for direct struct access. More...
 
- Public Member Functions inherited from Gio::Seekable
virtual ~Seekable ()
 
GSeekable* gobj ()
 Provides access to the underlying C GObject. More...
 
const GSeekable* gobj () const
 Provides access to the underlying C GObject. More...
 
goffset tell () const
 Tells the current position within the stream. More...
 
bool can_seek () const
 Tests if the stream supports the SeekableIface. More...
 
bool seek (goffset offset, Glib::SeekType type, const Glib::RefPtr< Cancellable >& cancellable)
 Seeks in the stream by the given offset, modified by type. More...
 
bool seek (goffset offset, Glib::SeekType type)
 A seek() convenience overload. More...
 
bool can_truncate () const
 Tests if the stream can be truncated. More...
 
bool truncate (goffset offset, const Glib::RefPtr< Cancellable >& cancellable)
 Truncates a stream with a given #offset. More...
 
bool truncate (goffset offset)
 A truncate() convenience overload. More...
 
- Public Member Functions inherited from Glib::Interface
 Interface ()
 A Default constructor. More...
 
 Interface (const Glib::Interface_Class& interface_class)
 Called by constructors of derived classes. More...
 
 Interface (GObject* castitem)
 Called by constructors of derived classes. More...
 
virtual ~Interface ()
 
GObject* gobj ()
 
const GObject* gobj () const
 

Static Public Member Functions

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

Protected Member Functions

 MemoryInputStream ()
 
- Protected Member Functions inherited from Glib::Object
 Object ()
 
 Object (const Glib::ConstructParams& construct_params)
 
 Object (GObject* castitem)
 
virtual ~Object ()
 
- Protected Member Functions inherited from Glib::ObjectBase
 ObjectBase ()
 This default constructor is called implicitly from the constructor of user-derived classes, even if, for instance, Gtk::Button calls a different ObjectBase constructor. More...
 
 ObjectBase (const char* custom_type_name)
 A derived constructor always overrides this choice. More...
 
 ObjectBase (const std::type_info& custom_type_info)
 This constructor is a special feature to allow creation of derived types on the fly, without having to use g_object_new() manually. More...
 
virtual ~ObjectBase ()=0
 
void initialize (GObject* castitem)
 
- Protected Member Functions inherited from Gio::Seekable
 Seekable ()
 You should derive from this class to use it. More...
 

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. More...
 

Detailed Description

MemoryInputStream implements InputStream for arbitrary memory chunks.

Since glibmm 2.16:

Member Typedef Documentation

For example, void on_destroy_data(void* data);.

Parameters
dataThe data to free.
Since glibmm 2.40:

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.
Deprecated:
Use add_data() with SlotDestroyData or GDestroyNotify instead.
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 be 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 add_data() with SlotDestroyData or GDestroyNotify instead.
void Gio::MemoryInputStream::add_data ( const void *  data,
gssize  len,
GDestroyNotify  destroy 
)

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

Parameters
dataInput data.
lenLength of the data, may be -1 if data is a nul-terminated string.
destroyFunction that is called to free data, or 0.
void Gio::MemoryInputStream::add_data ( const void *  data,
gssize  len,
const SlotDestroyData destroy_slot 
)

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.
destroy_slotA slot to be called to free the data when it is no longer needed.
Since glibmm 2.40:
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.

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

Provides access to the underlying C GObject.

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

Provides access to the underlying C GObject.

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.

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.