glibmm: Gio::UnixOutputStream Class Reference

UnixOutputStream implements OutputStream for writing to a a unix file descriptor, including asynchronous operations. More...

#include <giomm/unixoutputstream.h>

Inheritance diagram for Gio::UnixOutputStream:

[legend]

List of all members.

Public Member Functions
virtual	~UnixOutputStream ()
GUnixOutputStream*	gobj ()
	Provides access to the underlying C GObject.
const GUnixOutputStream*	gobj () const
	Provides access to the underlying C GObject.
GUnixOutputStream*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
void	set_close_fd (bool close_fd=true)
	Sets whether the file descriptor of stream shall be closed when the stream is closed.
bool	get_close_fd () const
	Returns whether the file descriptor of stream will be closed when the stream is closed.
int	get_fd () const
	Return the UNIX file descriptor that the stream writes to.
Glib::PropertyProxy_ReadOnly< int >	property_fd () const
	The file descriptor to write to.
Glib::PropertyProxy< bool >	property_close_fd ()
	Whether to close the file descriptor when the stream is closed.
Glib::PropertyProxy_ReadOnly < bool >	property_close_fd () const
	Whether to close the file descriptor when the stream is closed.
Public Member Functions inherited from Gio::OutputStream
virtual	~OutputStream ()
gssize	write (const void* buffer, gsize count, const Glib::RefPtr< Cancellable >& cancellable)
	Tries to write count bytes from buffer into the stream.
gssize	write (const void* buffer, gsize count)
	Tries to write count bytes from buffer into the stream.
gssize	write (const std::string& buffer, const Glib::RefPtr< Cancellable >& cancellable)
	Tries to write count bytes from buffer into the stream.
gssize	write (const std::string& buffer)
	Tries to write count bytes from buffer into the stream.
bool	write_all (const void* buffer, gsize count, gsize& bytes_written, const Glib::RefPtr< Cancellable >& cancellable)
	Tries to write count bytes from buffer into the stream.
bool	write_all (const void* buffer, gsize count, gsize& bytes_written)
	Tries to write count bytes from buffer into the stream.
bool	write_all (const std::string& buffer, gsize& bytes_written, const Glib::RefPtr< Cancellable >& cancellable)
	Tries to write count bytes from buffer into the stream.
bool	write_all (const std::string& buffer, gsize& bytes_written)
	Tries to write count bytes from buffer into the stream.
gssize	splice (const Glib::RefPtr< InputStream >& source, const Glib::RefPtr< Cancellable >& cancellable, OutputStreamSpliceFlags flags=OUTPUT_STREAM_SPLICE_NONE)
	Splices an input stream into an output stream.
gssize	splice (const Glib::RefPtr< InputStream >& source, OutputStreamSpliceFlags flags=OUTPUT_STREAM_SPLICE_NONE)
	Splices an input stream into an output stream.
bool	flush (const Glib::RefPtr< Cancellable >& cancellable)
	Flushed any outstanding buffers in the stream.
bool	flush ()
	Flushed any outstanding buffers in the stream.
bool	close (const Glib::RefPtr< Cancellable >& cancellable)
	Closes the stream, releasing resources related to it.
bool	close ()
	Closes the stream, releasing resources related to it.
void	write_async (const void* buffer, gsize count, const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable, int io_priority=Glib::PRIORITY_DEFAULT)
	Request an asynchronous write of count bytes from buffer into the stream.
void	write_async (const void* buffer, gsize count, const SlotAsyncReady& slot, int io_priority=Glib::PRIORITY_DEFAULT)
	Request an asynchronous write of count bytes from buffer into the stream.
gssize	write_finish (const Glib::RefPtr< AsyncResult >& result)
	Finishes a stream write operation.
void	splice_async (const Glib::RefPtr< InputStream >& source, const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable, OutputStreamSpliceFlags flags=OUTPUT_STREAM_SPLICE_NONE, int io_priority=Glib::PRIORITY_DEFAULT)
	Splices a stream asynchronously.
void	splice_async (const Glib::RefPtr< InputStream >& source, const SlotAsyncReady& slot, OutputStreamSpliceFlags flags=OUTPUT_STREAM_SPLICE_NONE, int io_priority=Glib::PRIORITY_DEFAULT)
	Splices a stream asynchronously.
gssize	splice_finish (const Glib::RefPtr< AsyncResult >& result)
	Finishes an asynchronous stream splice operation.
void	flush_async (const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable, int io_priority=Glib::PRIORITY_DEFAULT)
	Flushes a stream asynchronously.
void	flush_async (const SlotAsyncReady& slot, int io_priority=Glib::PRIORITY_DEFAULT)
	Flushes a stream asynchronously.
bool	flush_finish (const Glib::RefPtr< AsyncResult >& result)
	Finishes flushing an output stream.
void	close_async (const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable, int io_priority=Glib::PRIORITY_DEFAULT)
	Requests an asynchronous close of the stream, releasing resources related to it.
void	close_async (const SlotAsyncReady& slot, int io_priority=Glib::PRIORITY_DEFAULT)
	Requests an asynchronous close of the stream, releasing resources related to it.
bool	close_finish (const Glib::RefPtr< AsyncResult >& result)
	Closes an output stream.
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 sigc::trackable
	trackable (const trackable &src)
trackable &	operator= (const trackable &src)
void	add_destroy_notify_callback (void *data, func_destroy_notify func) const
void	remove_destroy_notify_callback (void *data) const
void	notify_callbacks ()

Static Public Member Functions
static Glib::RefPtr < UnixOutputStream >	create (int fd, bool close_fd)

Protected Member Functions
	UnixOutputStream (int fd, bool close_fd)

Related Functions
(Note that these are not member functions.)
Glib::RefPtr < Gio::UnixOutputStream >	wrap (GUnixOutputStream* object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Functions inherited from Gio::OutputStream
Glib::RefPtr< Gio::OutputStream >	wrap (GOutputStream* object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Functions inherited from Glib::Object
Glib::RefPtr< Glib::Object >	wrap (GObject* object, bool take_copy=false)

Detailed Description

UnixOutputStream implements OutputStream for writing to a a unix file descriptor, including asynchronous operations.

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

Since glibmm 2.16:

Constructor & Destructor Documentation

virtual Gio::UnixOutputStream::~UnixOutputStream ( )

virtual

Gio::UnixOutputStream::UnixOutputStream	(	int	fd,
		bool	close_fd
	)

explicitprotected

Member Function Documentation

static Glib::RefPtr<UnixOutputStream> Gio::UnixOutputStream::create	(	int	fd,
		bool	close_fd
	)

static

bool Gio::UnixOutputStream::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::UnixOutputStream::get_fd ( ) const

Return the UNIX file descriptor that the stream writes to.

Since glibmm 2.20:

Returns:: The file descriptor of stream.

GUnixOutputStream* Gio::UnixOutputStream::gobj ( )

inline

Provides access to the underlying C GObject.

Reimplemented from Gio::OutputStream.

const GUnixOutputStream* Gio::UnixOutputStream::gobj ( ) const

inline

Provides access to the underlying C GObject.

Reimplemented from Gio::OutputStream.

GUnixOutputStream* Gio::UnixOutputStream::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::OutputStream.

Glib::PropertyProxy< bool > Gio::UnixOutputStream::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 property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly< bool > Gio::UnixOutputStream::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 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< int > Gio::UnixOutputStream::property_fd ( ) const

The file descriptor to write to.

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::UnixOutputStream::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_fd true to close the file descriptor when done.

Friends And Related Function Documentation

Glib::RefPtr< Gio::UnixOutputStream > wrap	(	GUnixOutputStream *	object,
		bool	take_copy = `false`
	)

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

Parameters:

object	The C instance.
take_copy	False 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.

glibmm: Gio::UnixOutputStream Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation