Use g_simple_async_result_{new_,}take_error
[platform/upstream/glib.git] / gio / gunixoutputstream.c
index ee02f27..5bc1918 100644 (file)
@@ -20,7 +20,7 @@
  * Author: Alexander Larsson <alexl@redhat.com>
  */
 
-#include <config.h>
+#include "config.h"
 
 #include <sys/types.h>
 #include <sys/stat.h>
@@ -28,7 +28,6 @@
 #include <errno.h>
 #include <stdio.h>
 #include <fcntl.h>
-#include <poll.h>
 
 #include <glib.h>
 #include <glib/gstdio.h>
 #include "gasynchelper.h"
 #include "glibintl.h"
 
+
 /**
  * SECTION:gunixoutputstream
- * @short_description: Unix Output Stream
- * @see_also: #GOutputStream.
+ * @short_description: Streaming output operations for UNIX file descriptors
+ * @include: gio/gunixoutputstream.h
+ * @see_also: #GOutputStream
  *
- * #GUnixOutputStream implements #GOutputStream 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.
- **/
+ * #GUnixOutputStream implements #GOutputStream for writing to a
+ * UNIX file descriptor, including asynchronous operations. The file
+ * descriptor must be selectable, so it doesn't work with opened files.
+ *
+ * Note that <filename>&lt;gio/gunixoutputstream.h&gt;</filename> belongs
+ * to the UNIX-specific GIO interfaces, thus you have to use the
+ * <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
+ */
+
+enum {
+  PROP_0,
+  PROP_FD,
+  PROP_CLOSE_FD
+};
 
 G_DEFINE_TYPE (GUnixOutputStream, g_unix_output_stream, G_TYPE_OUTPUT_STREAM);
 
 
 struct _GUnixOutputStreamPrivate {
   int fd;
-  gboolean close_fd_at_close;
+  gboolean close_fd;
 };
 
+static void     g_unix_output_stream_set_property (GObject              *object,
+                                                  guint                 prop_id,
+                                                  const GValue         *value,
+                                                  GParamSpec           *pspec);
+static void     g_unix_output_stream_get_property (GObject              *object,
+                                                  guint                 prop_id,
+                                                  GValue               *value,
+                                                  GParamSpec           *pspec);
 static gssize   g_unix_output_stream_write        (GOutputStream        *stream,
                                                   const void           *buffer,
                                                   gsize                 count,
@@ -88,12 +107,7 @@ static gboolean g_unix_output_stream_close_finish (GOutputStream        *stream,
 static void
 g_unix_output_stream_finalize (GObject *object)
 {
-  GUnixOutputStream *stream;
-  
-  stream = G_UNIX_OUTPUT_STREAM (object);
-
-  if (G_OBJECT_CLASS (g_unix_output_stream_parent_class)->finalize)
-    (*G_OBJECT_CLASS (g_unix_output_stream_parent_class)->finalize) (object);
+  G_OBJECT_CLASS (g_unix_output_stream_parent_class)->finalize (object);
 }
 
 static void
@@ -103,15 +117,94 @@ g_unix_output_stream_class_init (GUnixOutputStreamClass *klass)
   GOutputStreamClass *stream_class = G_OUTPUT_STREAM_CLASS (klass);
   
   g_type_class_add_private (klass, sizeof (GUnixOutputStreamPrivate));
-  
+
+  gobject_class->get_property = g_unix_output_stream_get_property;
+  gobject_class->set_property = g_unix_output_stream_set_property;
   gobject_class->finalize = g_unix_output_stream_finalize;
 
-  stream_class->write = g_unix_output_stream_write;
-  stream_class->close = g_unix_output_stream_close;
+  stream_class->write_fn = g_unix_output_stream_write;
+  stream_class->close_fn = g_unix_output_stream_close;
   stream_class->write_async = g_unix_output_stream_write_async;
   stream_class->write_finish = g_unix_output_stream_write_finish;
   stream_class->close_async = g_unix_output_stream_close_async;
   stream_class->close_finish = g_unix_output_stream_close_finish;
+
+   /**
+   * GUnixOutputStream:fd:
+   *
+   * The file descriptor that the stream writes to.
+   *
+   * Since: 2.20
+   */
+  g_object_class_install_property (gobject_class,
+                                  PROP_FD,
+                                  g_param_spec_int ("fd",
+                                                    P_("File descriptor"),
+                                                    P_("The file descriptor to write to"),
+                                                    G_MININT, G_MAXINT, -1,
+                                                    G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB));
+
+  /**
+   * GUnixOutputStream:close-fd:
+   *
+   * Whether to close the file descriptor when the stream is closed.
+   *
+   * Since: 2.20
+   */
+  g_object_class_install_property (gobject_class,
+                                  PROP_CLOSE_FD,
+                                  g_param_spec_boolean ("close-fd",
+                                                        P_("Close file descriptor"),
+                                                        P_("Whether to close the file descriptor when the stream is closed"),
+                                                        TRUE,
+                                                        G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB));
+}
+
+static void
+g_unix_output_stream_set_property (GObject         *object,
+                                  guint            prop_id,
+                                  const GValue    *value,
+                                  GParamSpec      *pspec)
+{
+  GUnixOutputStream *unix_stream;
+
+  unix_stream = G_UNIX_OUTPUT_STREAM (object);
+
+  switch (prop_id)
+    {
+    case PROP_FD:
+      unix_stream->priv->fd = g_value_get_int (value);
+      break;
+    case PROP_CLOSE_FD:
+      unix_stream->priv->close_fd = g_value_get_boolean (value);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+      break;
+    }
+}
+
+static void
+g_unix_output_stream_get_property (GObject    *object,
+                                  guint       prop_id,
+                                  GValue     *value,
+                                  GParamSpec *pspec)
+{
+  GUnixOutputStream *unix_stream;
+
+  unix_stream = G_UNIX_OUTPUT_STREAM (object);
+
+  switch (prop_id)
+    {
+    case PROP_FD:
+      g_value_set_int (value, unix_stream->priv->fd);
+      break;
+    case PROP_CLOSE_FD:
+      g_value_set_boolean (value, unix_stream->priv->close_fd);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
 }
 
 static void
@@ -120,70 +213,131 @@ g_unix_output_stream_init (GUnixOutputStream *unix_stream)
   unix_stream->priv = G_TYPE_INSTANCE_GET_PRIVATE (unix_stream,
                                                   G_TYPE_UNIX_OUTPUT_STREAM,
                                                   GUnixOutputStreamPrivate);
-}
 
+  unix_stream->priv->fd = -1;
+  unix_stream->priv->close_fd = TRUE;
+}
 
 /**
  * g_unix_output_stream_new:
- * @fd: unix's file descriptor.
- * @close_fd_at_close: a #gboolean.
+ * @fd: a UNIX file descriptor
+ * @close_fd: %TRUE to close the file descriptor when done
+ * 
+ * Creates a new #GUnixOutputStream for the given @fd. 
  * 
- * Creates a new unix output stream for @fd. If @close_fd_at_close
- * is %TRUE, the fd will be closed when the output stream is destroyed.
+ * If @close_fd, is %TRUE, the file descriptor will be closed when 
+ * the output stream is destroyed.
  * 
- * Returns: #GOutputStream. If @close_fd_at_close is %TRUE, then
- * @fd will be closed when the #GOutputStream is closed.
+ * Returns: a new #GOutputStream
  **/
 GOutputStream *
-g_unix_output_stream_new (int fd,
-                         gboolean close_fd_at_close)
+g_unix_output_stream_new (gint     fd,
+                         gboolean close_fd)
 {
   GUnixOutputStream *stream;
 
   g_return_val_if_fail (fd != -1, NULL);
 
-  stream = g_object_new (G_TYPE_UNIX_OUTPUT_STREAM, NULL);
-
-  stream->priv->fd = fd;
-  stream->priv->close_fd_at_close = close_fd_at_close;
+  stream = g_object_new (G_TYPE_UNIX_OUTPUT_STREAM,
+                        "fd", fd,
+                        "close-fd", close_fd,
+                        NULL);
   
   return G_OUTPUT_STREAM (stream);
 }
 
+/**
+ * g_unix_output_stream_set_close_fd:
+ * @stream: a #GUnixOutputStream
+ * @close_fd: %TRUE to close the file descriptor when done
+ *
+ * Sets whether the file descriptor of @stream shall be closed
+ * when the stream is closed.
+ *
+ * Since: 2.20
+ */
+void
+g_unix_output_stream_set_close_fd (GUnixOutputStream *stream,
+                                   gboolean           close_fd)
+{
+  g_return_if_fail (G_IS_UNIX_OUTPUT_STREAM (stream));
+
+  close_fd = close_fd != FALSE;
+  if (stream->priv->close_fd != close_fd)
+    {
+      stream->priv->close_fd = close_fd;
+      g_object_notify (G_OBJECT (stream), "close-fd");
+    }
+}
+
+/**
+ * g_unix_output_stream_get_close_fd:
+ * @stream: a #GUnixOutputStream
+ *
+ * Returns whether the file descriptor of @stream will be
+ * closed when the stream is closed.
+ *
+ * Return value: %TRUE if the file descriptor is closed when done
+ *
+ * Since: 2.20
+ */
+gboolean
+g_unix_output_stream_get_close_fd (GUnixOutputStream *stream)
+{
+  g_return_val_if_fail (G_IS_UNIX_OUTPUT_STREAM (stream), FALSE);
+
+  return stream->priv->close_fd;
+}
+
+/**
+ * g_unix_output_stream_get_fd:
+ * @stream: a #GUnixOutputStream
+ *
+ * Return the UNIX file descriptor that the stream writes to.
+ *
+ * Return value: The file descriptor of @stream
+ *
+ * Since: 2.20
+ */
+gint
+g_unix_output_stream_get_fd (GUnixOutputStream *stream)
+{
+  g_return_val_if_fail (G_IS_UNIX_OUTPUT_STREAM (stream), -1);
+
+  return stream->priv->fd;
+}
+
 static gssize
-g_unix_output_stream_write (GOutputStream *stream,
-                           const void    *buffer,
-                           gsize          count,
-                           GCancellable  *cancellable,
-                           GError       **error)
+g_unix_output_stream_write (GOutputStream  *stream,
+                           const void     *buffer,
+                           gsize           count,
+                           GCancellable   *cancellable,
+                           GError        **error)
 {
   GUnixOutputStream *unix_stream;
   gssize res;
-  struct pollfd poll_fds[2];
+  GPollFD poll_fds[2];
   int poll_ret;
-  int cancel_fd;
 
   unix_stream = G_UNIX_OUTPUT_STREAM (stream);
 
-  cancel_fd = g_cancellable_get_fd (cancellable);
-  if (cancel_fd != -1)
+  if (g_cancellable_make_pollfd (cancellable, &poll_fds[1]))
     {
+      poll_fds[0].fd = unix_stream->priv->fd;
+      poll_fds[0].events = G_IO_OUT;
       do
-       {
-         poll_fds[0].events = POLLOUT;
-         poll_fds[0].fd = unix_stream->priv->fd;
-         poll_fds[1].events = POLLIN;
-         poll_fds[1].fd = cancel_fd;
-         poll_ret = poll (poll_fds, 2, -1);
-       }
+       poll_ret = g_poll (poll_fds, 2, -1);
       while (poll_ret == -1 && errno == EINTR);
+      g_cancellable_release_fd (cancellable);
       
       if (poll_ret == -1)
        {
+          int errsv = errno;
+
          g_set_error (error, G_IO_ERROR,
-                      g_io_error_from_errno (errno),
+                      g_io_error_from_errno (errsv),
                       _("Error writing to unix: %s"),
-                      g_strerror (errno));
+                      g_strerror (errsv));
          return -1;
        }
     }
@@ -196,13 +350,15 @@ g_unix_output_stream_write (GOutputStream *stream,
       res = write (unix_stream->priv->fd, buffer, count);
       if (res == -1)
        {
-         if (errno == EINTR)
+          int errsv = errno;
+
+         if (errsv == EINTR)
            continue;
          
          g_set_error (error, G_IO_ERROR,
-                      g_io_error_from_errno (errno),
+                      g_io_error_from_errno (errsv),
                       _("Error writing to unix: %s"),
-                      g_strerror (errno));
+                      g_strerror (errsv));
        }
       
       break;
@@ -212,16 +368,16 @@ g_unix_output_stream_write (GOutputStream *stream,
 }
 
 static gboolean
-g_unix_output_stream_close (GOutputStream *stream,
-                           GCancellable  *cancellable,
-                           GError       **error)
+g_unix_output_stream_close (GOutputStream  *stream,
+                           GCancellable   *cancellable,
+                           GError        **error)
 {
   GUnixOutputStream *unix_stream;
   int res;
 
   unix_stream = G_UNIX_OUTPUT_STREAM (stream);
 
-  if (!unix_stream->priv->close_fd_at_close)
+  if (!unix_stream->priv->close_fd)
     return TRUE;
   
   while (1)
@@ -230,10 +386,12 @@ g_unix_output_stream_close (GOutputStream *stream,
       res = close (unix_stream->priv->fd);
       if (res == -1)
        {
+          int errsv = errno;
+
          g_set_error (error, G_IO_ERROR,
-                      g_io_error_from_errno (errno),
+                      g_io_error_from_errno (errsv),
                       _("Error closing unix: %s"),
-                      g_strerror (errno));
+                      g_strerror (errsv));
        }
       break;
     }
@@ -252,8 +410,8 @@ typedef struct {
 
 static gboolean
 write_async_cb (WriteAsyncData *data,
-               GIOCondition condition,
-               int fd)
+               GIOCondition    condition,
+               int             fd)
 {
   GSimpleAsyncResult *simple;
   GError *error = NULL;
@@ -270,13 +428,15 @@ write_async_cb (WriteAsyncData *data,
       count_written = write (data->stream->priv->fd, data->buffer, data->count);
       if (count_written == -1)
        {
-         if (errno == EINTR)
+          int errsv = errno;
+
+         if (errsv == EINTR)
            continue;
          
          g_set_error (&error, G_IO_ERROR,
-                      g_io_error_from_errno (errno),
-                      _("Error reading from unix: %s"),
-                      g_strerror (errno));
+                      g_io_error_from_errno (errsv),
+                      _("Error writing to unix: %s"),
+                      g_strerror (errsv));
        }
       break;
     }
@@ -289,10 +449,7 @@ write_async_cb (WriteAsyncData *data,
   g_simple_async_result_set_op_res_gssize (simple, count_written);
 
   if (count_written == -1)
-    {
-      g_simple_async_result_set_from_error (simple, error);
-      g_error_free (error);
-    }
+    g_simple_async_result_take_error (simple, error);
 
   /* Complete immediately, not in idle, since we're already in a mainloop callout */
   g_simple_async_result_complete (simple);
@@ -302,13 +459,13 @@ write_async_cb (WriteAsyncData *data,
 }
 
 static void
-g_unix_output_stream_write_async (GOutputStream      *stream,
-                                 const void         *buffer,
-                                 gsize               count,
-                                 int                 io_priority,
-                                 GCancellable       *cancellable,
-                                 GAsyncReadyCallback callback,
-                                 gpointer            user_data)
+g_unix_output_stream_write_async (GOutputStream       *stream,
+                                 const void          *buffer,
+                                 gsize                count,
+                                 int                  io_priority,
+                                 GCancellable        *cancellable,
+                                 GAsyncReadyCallback  callback,
+                                 gpointer             user_data)
 {
   GSource *source;
   GUnixOutputStream *unix_stream;
@@ -325,25 +482,26 @@ g_unix_output_stream_write_async (GOutputStream      *stream,
   data->stream = unix_stream;
 
   source = _g_fd_source_new (unix_stream->priv->fd,
-                            POLLOUT,
+                            G_IO_OUT,
                             cancellable);
+  g_source_set_name (source, "GUnixOutputStream");
   
   g_source_set_callback (source, (GSourceFunc)write_async_cb, data, g_free);
-  g_source_attach (source, NULL);
+  g_source_attach (source, g_main_context_get_thread_default ());
   
   g_source_unref (source);
 }
 
 static gssize
-g_unix_output_stream_write_finish (GOutputStream *stream,
-                                  GAsyncResult *result,
-                                  GError **error)
+g_unix_output_stream_write_finish (GOutputStream  *stream,
+                                  GAsyncResult   *result,
+                                  GError        **error)
 {
   GSimpleAsyncResult *simple;
   gssize nwritten;
 
   simple = G_SIMPLE_ASYNC_RESULT (result);
-  g_assert (g_simple_async_result_get_source_tag (simple) == g_unix_output_stream_write_async);
+  g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_unix_output_stream_write_async);
   
   nwritten = g_simple_async_result_get_op_res_gssize (simple);
   return nwritten;
@@ -366,7 +524,7 @@ close_async_cb (CloseAsyncData *data)
 
   unix_stream = G_UNIX_OUTPUT_STREAM (data->stream);
 
-  if (!unix_stream->priv->close_fd_at_close)
+  if (!unix_stream->priv->close_fd)
     {
       result = TRUE;
       goto out;
@@ -377,10 +535,12 @@ close_async_cb (CloseAsyncData *data)
       res = close (unix_stream->priv->fd);
       if (res == -1)
        {
+          int errsv = errno;
+
          g_set_error (&error, G_IO_ERROR,
-                      g_io_error_from_errno (errno),
+                      g_io_error_from_errno (errsv),
                       _("Error closing unix: %s"),
-                      g_strerror (errno));
+                      g_strerror (errsv));
        }
       break;
     }
@@ -394,10 +554,7 @@ close_async_cb (CloseAsyncData *data)
                                      g_unix_output_stream_close_async);
 
   if (!result)
-    {
-      g_simple_async_result_set_from_error (simple, error);
-      g_error_free (error);
-    }
+    g_simple_async_result_take_error (simple, error);
 
   /* Complete immediately, not in idle, since we're already in a mainloop callout */
   g_simple_async_result_complete (simple);
@@ -407,11 +564,11 @@ close_async_cb (CloseAsyncData *data)
 }
 
 static void
-g_unix_output_stream_close_async (GOutputStream       *stream,
-                                 int                 io_priority,
-                                 GCancellable       *cancellable,
-                                 GAsyncReadyCallback callback,
-                                 gpointer            user_data)
+g_unix_output_stream_close_async (GOutputStream        *stream,
+                                 int                  io_priority,
+                                 GCancellable        *cancellable,
+                                 GAsyncReadyCallback  callback,
+                                 gpointer             user_data)
 {
   GSource *idle;
   CloseAsyncData *data;
@@ -424,14 +581,14 @@ g_unix_output_stream_close_async (GOutputStream       *stream,
   
   idle = g_idle_source_new ();
   g_source_set_callback (idle, (GSourceFunc)close_async_cb, data, g_free);
-  g_source_attach (idle, NULL);
+  g_source_attach (idle, g_main_context_get_thread_default ());
   g_source_unref (idle);
 }
 
 static gboolean
-g_unix_output_stream_close_finish (GOutputStream              *stream,
-                                  GAsyncResult              *result,
-                                  GError                   **error)
+g_unix_output_stream_close_finish (GOutputStream  *stream,
+                                  GAsyncResult   *result,
+                                  GError        **error)
 {
   /* Failures handled in generic close_finish code */
   return TRUE;