GNOME Bugzilla – Bug 627071
g_output_stream_write() clarification
Last modified: 2010-08-16 19:39:08 UTC
Hi, This patch guarantees that g_output_stream_write() can never fail with G_IO_ERROR_WOULD_BLOCK. Without such a guarantee, we would need some kind of GIOPollable interface or some way to get an event when the stream is writable again. Which is mostly useless considering that this method is asynchronous anyway. Note: this patch just codifies existing behavior - GUnixOutputStream, GSocketOutputStream and other implementations already work this way. See also bug 626748 comment 5 for how the GDBus code relies on this guarantee. Thanks. diff --git a/gio/goutputstream.c b/gio/goutputstream.c index 1115599..c4c7502 100644 --- a/gio/goutputstream.c +++ b/gio/goutputstream.c @@ -673,6 +673,10 @@ async_ready_close_flushed_callback_wrapper (GObject *s * requested size, as it can happen e.g. on a partial I/O error, * but generally we try to write as many bytes as requested. * + * You are guaranteed that this method will never fail with + * %G_IO_ERROR_WOULD_BLOCK - if no space is left in @stream, the + * method will just wait until space becomes available. + * * Any outstanding I/O request with higher priority (lower numerical * value) will be executed before an outstanding request with lower * priority. Default priority is %G_PRIORITY_DEFAULT.
(In reply to comment #0) > + * You are guaranteed that this method will never fail with > + * %G_IO_ERROR_WOULD_BLOCK - if no space is left in @stream, the > + * method will just wait until space becomes available. "no space is left" isn't necessarily the problem. I'd say something more generic like "if @stream can't accept more data". But yeah, the clarification is good.
Yeah, this sounds good to me.
Committed, thanks! http://git.gnome.org/browse/glib/commit/?id=b8e7ef6e90512999be0340a6ef3f20e1783647c4