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

UnixInputStream implements InputStream for reading from a unix file descriptor, including asynchronous operations. More...

#include <giomm/unixinputstream.h>

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

Public Member Functions

virtual ~UnixInputStream ()
 
GUnixInputStream* gobj ()
 Provides access to the underlying C GObject. More...
 
const GUnixInputStream* gobj () const
 Provides access to the underlying C GObject. More...
 
GUnixInputStream* 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 set_close_fd (bool close_fd=true)
 Sets whether the file descriptor of stream shall be closed when the stream is closed. More...
 
bool get_close_fd () const
 Returns whether the file descriptor of stream will be closed when the stream is closed. More...
 
int get_fd () const
 Return the UNIX file descriptor that the stream reads from. More...
 
Glib::PropertyProxy_ReadOnly< int > property_fd () const
 The file descriptor to read from. More...
 
Glib::PropertyProxy< bool > property_close_fd ()
 Whether to close the file descriptor when the stream is closed. More...
 
Glib::PropertyProxy_ReadOnly
< bool > 
property_close_fd () const
 Whether to close the file descriptor when the stream is closed. 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...
 

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
< UnixInputStream
create (int fd, bool close_fd)
 
- 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...
 

Protected Member Functions

 UnixInputStream (int fd, bool close_fd)
 
- 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)
 

Related Functions

(Note that these are not member functions.)

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

Additional Inherited Members

- Public Types inherited from Glib::Object
typedef void(* DestroyNotify )(gpointer data)
 

Detailed Description

UnixInputStream implements InputStream for reading from a unix file descriptor, including asynchronous operations.

The file descriptor must be selectable, so it doesn't work with opened files.

Since glibmm 2.16:

Constructor & Destructor Documentation

virtual Gio::UnixInputStream::~UnixInputStream ( )
virtual
Gio::UnixInputStream::UnixInputStream ( int  fd,
bool  close_fd 
)
explicitprotected

Member Function Documentation

static Glib::RefPtr<UnixInputStream> Gio::UnixInputStream::create ( int  fd,
bool  close_fd 
)
static
bool Gio::UnixInputStream::get_close_fd ( ) const

Returns whether the file descriptor of stream will be closed when the stream is closed.

Since glibmm 2.20:
Returns
true if the file descriptor is closed when done.
int Gio::UnixInputStream::get_fd ( ) const

Return the UNIX file descriptor that the stream reads from.

Since glibmm 2.20:
Returns
The file descriptor of stream.
static GType Gio::UnixInputStream::get_type ( )
static

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

GUnixInputStream* Gio::UnixInputStream::gobj ( )
inline

Provides access to the underlying C GObject.

const GUnixInputStream* Gio::UnixInputStream::gobj ( ) const
inline

Provides access to the underlying C GObject.

GUnixInputStream* Gio::UnixInputStream::gobj_copy ( )

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

Glib::PropertyProxy< bool > Gio::UnixInputStream::property_close_fd ( )

Whether to close the file descriptor when the 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 value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gio::UnixInputStream::property_close_fd ( ) const

Whether to close the file descriptor when the stream is closed.

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

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gio::UnixInputStream::property_fd ( ) const

The file descriptor to read from.

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

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Gio::UnixInputStream::set_close_fd ( bool  close_fd = true)

Sets whether the file descriptor of stream shall be closed when the stream is closed.

Since glibmm 2.20:
Parameters
close_fdtrue to close the file descriptor when done.

Friends And Related Function Documentation

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