[kdbus] Add README.md file
[platform/upstream/glib.git] / gio / gsocketoutputstream.c
index b42162f..00b49ad 100644 (file)
@@ -1,6 +1,7 @@
-/* GIO - GLib Input, Output and Streaming Library
- * 
- * Copyright (C) 2006-2007 Red Hat, Inc.
+/*  GIO - GLib Input, Output and Streaming Library
+ *
+ * Copyright © 2008 Christian Kellner, Samuel Cormier-Iijima
+ *           © 2009 codethink
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General
- * Public License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  *
- * Author: Alexander Larsson <alexl@redhat.com>
+ * Authors: Christian Kellner <gicmo@gnome.org>
+ *          Samuel Cormier-Iijima <sciyoshi@gmail.com>
+ *          Ryan Lortie <desrt@desrt.ca>
  */
 
-#include <config.h>
-
-#include <sys/types.h>
-#include <sys/stat.h>
-#include <unistd.h>
-#include <errno.h>
-#include <stdio.h>
-#include <fcntl.h>
-#include <poll.h>
-
-#include <glib.h>
-#include <glib/gstdio.h>
-#include "gioerror.h"
+#include "config.h"
+#include "goutputstream.h"
 #include "gsocketoutputstream.h"
-#include "gcancellable.h"
-#include "gsimpleasyncresult.h"
-#include "gasynchelper.h"
+#include "gsocket.h"
 #include "glibintl.h"
 
-/**
- * SECTION:gsocketoutputstream
- * @short_description: Socket Output Stream
- * @see_also: #GOutputStream.
- *
- * #GSocketOutputStream implements #GOutputStream for writing to a socket, including
- * asynchronous operations.
- **/
-
-G_DEFINE_TYPE (GSocketOutputStream, g_socket_output_stream, G_TYPE_OUTPUT_STREAM);
+#include "gcancellable.h"
+#include "gpollableinputstream.h"
+#include "gpollableoutputstream.h"
+#include "gioerror.h"
+#include "glibintl.h"
+#include "gfiledescriptorbased.h"
 
+struct _GSocketOutputStreamPrivate
+{
+  GSocket *socket;
 
-struct _GSocketOutputStreamPrivate {
-  int fd;
-  gboolean close_fd_at_close;
+  /* pending operation metadata */
+  gconstpointer buffer;
+  gsize count;
 };
 
-static gssize   g_socket_output_stream_write        (GOutputStream              *stream,
-                                                    const void                 *buffer,
-                                                    gsize                       count,
-                                                    GCancellable               *cancellable,
-                                                    GError                    **error);
-static gboolean g_socket_output_stream_close        (GOutputStream              *stream,
-                                                    GCancellable               *cancellable,
-                                                    GError                    **error);
-static void     g_socket_output_stream_write_async  (GOutputStream              *stream,
-                                                    const void                 *buffer,
-                                                    gsize                       count,
-                                                    int                         io_priority,
-                                                    GCancellable               *cancellable,
-                                                    GAsyncReadyCallback         callback,
-                                                    gpointer                    data);
-static gssize   g_socket_output_stream_write_finish (GOutputStream              *stream,
-                                                    GAsyncResult               *result,
-                                                    GError                    **error);
-static void     g_socket_output_stream_close_async  (GOutputStream              *stream,
-                                                    int                         io_priority,
-                                                    GCancellable               *cancellable,
-                                                    GAsyncReadyCallback         callback,
-                                                    gpointer                    data);
-static gboolean g_socket_output_stream_close_finish (GOutputStream              *stream,
-                                                    GAsyncResult               *result,
-                                                    GError                    **error);
-
+static void g_socket_output_stream_pollable_iface_init (GPollableOutputStreamInterface *iface);
+#ifdef G_OS_UNIX
+static void g_socket_output_stream_file_descriptor_based_iface_init (GFileDescriptorBasedIface *iface);
+#endif
+
+#define g_socket_output_stream_get_type _g_socket_output_stream_get_type
+
+#ifdef G_OS_UNIX
+G_DEFINE_TYPE_WITH_CODE (GSocketOutputStream, g_socket_output_stream, G_TYPE_OUTPUT_STREAM,
+                         G_ADD_PRIVATE (GSocketOutputStream)
+                        G_IMPLEMENT_INTERFACE (G_TYPE_POLLABLE_OUTPUT_STREAM, g_socket_output_stream_pollable_iface_init)
+                        G_IMPLEMENT_INTERFACE (G_TYPE_FILE_DESCRIPTOR_BASED, g_socket_output_stream_file_descriptor_based_iface_init)
+                        )
+#else
+G_DEFINE_TYPE_WITH_CODE (GSocketOutputStream, g_socket_output_stream, G_TYPE_OUTPUT_STREAM,
+                         G_ADD_PRIVATE (GSocketOutputStream)
+                        G_IMPLEMENT_INTERFACE (G_TYPE_POLLABLE_OUTPUT_STREAM, g_socket_output_stream_pollable_iface_init)
+                        )
+#endif
+
+enum
+{
+  PROP_0,
+  PROP_SOCKET
+};
 
 static void
-g_socket_output_stream_finalize (GObject *object)
+g_socket_output_stream_get_property (GObject    *object,
+                                     guint       prop_id,
+                                     GValue     *value,
+                                     GParamSpec *pspec)
 {
-  GSocketOutputStream *stream;
-  
-  stream = G_SOCKET_OUTPUT_STREAM (object);
+  GSocketOutputStream *stream = G_SOCKET_OUTPUT_STREAM (object);
+
+  switch (prop_id)
+    {
+      case PROP_SOCKET:
+        g_value_set_object (value, stream->priv->socket);
+        break;
 
-  if (G_OBJECT_CLASS (g_socket_output_stream_parent_class)->finalize)
-    (*G_OBJECT_CLASS (g_socket_output_stream_parent_class)->finalize) (object);
+      default:
+        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
 }
 
 static void
-g_socket_output_stream_class_init (GSocketOutputStreamClass *klass)
+g_socket_output_stream_set_property (GObject      *object,
+                                     guint         prop_id,
+                                     const GValue *value,
+                                     GParamSpec   *pspec)
 {
-  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
-  GOutputStreamClass *stream_class = G_OUTPUT_STREAM_CLASS (klass);
-  
-  g_type_class_add_private (klass, sizeof (GSocketOutputStreamPrivate));
-  
-  gobject_class->finalize = g_socket_output_stream_finalize;
+  GSocketOutputStream *stream = G_SOCKET_OUTPUT_STREAM (object);
 
-  stream_class->write = g_socket_output_stream_write;
-  stream_class->close = g_socket_output_stream_close;
-  stream_class->write_async = g_socket_output_stream_write_async;
-  stream_class->write_finish = g_socket_output_stream_write_finish;
-  stream_class->close_async = g_socket_output_stream_close_async;
-  stream_class->close_finish = g_socket_output_stream_close_finish;
-}
+  switch (prop_id)
+    {
+      case PROP_SOCKET:
+        stream->priv->socket = g_value_dup_object (value);
+        break;
 
-static void
-g_socket_output_stream_init (GSocketOutputStream *socket)
-{
-  socket->priv = G_TYPE_INSTANCE_GET_PRIVATE (socket,
-                                             G_TYPE_SOCKET_OUTPUT_STREAM,
-                                             GSocketOutputStreamPrivate);
+      default:
+        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
 }
 
-
-/**
- * g_socket_output_stream_new:
- * @fd: socket's file descriptor.
- * @close_fd_at_close: a #gboolean.
- * 
- * Creates a new socket output stream for @fd. If @close_fd_at_close
- * is %TRUE, the socket 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.
- **/
-GOutputStream *
-g_socket_output_stream_new (int fd,
-                          gboolean close_fd_at_close)
+static void
+g_socket_output_stream_finalize (GObject *object)
 {
-  GSocketOutputStream *stream;
+  GSocketOutputStream *stream = G_SOCKET_OUTPUT_STREAM (object);
 
-  g_return_val_if_fail (fd != -1, NULL);
+  if (stream->priv->socket)
+    g_object_unref (stream->priv->socket);
 
-  stream = g_object_new (G_TYPE_SOCKET_OUTPUT_STREAM, NULL);
-
-  stream->priv->fd = fd;
-  stream->priv->close_fd_at_close = close_fd_at_close;
-  
-  return G_OUTPUT_STREAM (stream);
+  G_OBJECT_CLASS (g_socket_output_stream_parent_class)->finalize (object);
 }
 
 static gssize
-g_socket_output_stream_write (GOutputStream *stream,
-                             const void    *buffer,
-                             gsize          count,
-                             GCancellable  *cancellable,
-                             GError       **error)
+g_socket_output_stream_write (GOutputStream  *stream,
+                              const void     *buffer,
+                              gsize           count,
+                              GCancellable   *cancellable,
+                              GError        **error)
 {
-  GSocketOutputStream *socket_stream;
-  gssize res;
-  struct pollfd poll_fds[2];
-  int poll_ret;
-  int cancel_fd;
-
-  socket_stream = G_SOCKET_OUTPUT_STREAM (stream);
+  GSocketOutputStream *onput_stream = G_SOCKET_OUTPUT_STREAM (stream);
 
-  cancel_fd = g_cancellable_get_fd (cancellable);
-  if (cancel_fd != -1)
-    {
-      do
-       {
-         poll_fds[0].events = POLLOUT;
-         poll_fds[0].fd = socket_stream->priv->fd;
-         poll_fds[1].events = POLLIN;
-         poll_fds[1].fd = cancel_fd;
-         poll_ret = poll (poll_fds, 2, -1);
-       }
-      while (poll_ret == -1 && errno == EINTR);
-      
-      if (poll_ret == -1)
-       {
-         g_set_error (error, G_IO_ERROR,
-                      g_io_error_from_errno (errno),
-                      _("Error writing to socket: %s"),
-                      g_strerror (errno));
-         return -1;
-       }
-    }
-      
-  while (1)
-    {
-      if (g_cancellable_set_error_if_cancelled (cancellable, error))
-       return -1;
-
-      res = write (socket_stream->priv->fd, buffer, count);
-      if (res == -1)
-       {
-         if (errno == EINTR)
-           continue;
-         
-         g_set_error (error, G_IO_ERROR,
-                      g_io_error_from_errno (errno),
-                      _("Error writing to socket: %s"),
-                      g_strerror (errno));
-       }
-      
-      break;
-    }
-  
-  return res;
+  return g_socket_send_with_blocking (onput_stream->priv->socket,
+                                     buffer, count, TRUE,
+                                     cancellable, error);
 }
 
 static gboolean
-g_socket_output_stream_close (GOutputStream *stream,
-                             GCancellable  *cancellable,
-                             GError       **error)
+g_socket_output_stream_pollable_is_writable (GPollableOutputStream *pollable)
 {
-  GSocketOutputStream *socket_stream;
-  int res;
+  GSocketOutputStream *output_stream = G_SOCKET_OUTPUT_STREAM (pollable);
 
-  socket_stream = G_SOCKET_OUTPUT_STREAM (stream);
+  return g_socket_condition_check (output_stream->priv->socket, G_IO_OUT);
+}
 
-  if (!socket_stream->priv->close_fd_at_close)
-    return TRUE;
-  
-  while (1)
-    {
-      /* This might block during the close. Doesn't seem to be a way to avoid it though. */
-      res = close (socket_stream->priv->fd);
-      if (res == -1)
-       {
-         g_set_error (error, G_IO_ERROR,
-                      g_io_error_from_errno (errno),
-                      _("Error closing socket: %s"),
-                      g_strerror (errno));
-       }
-      break;
-    }
+static gssize
+g_socket_output_stream_pollable_write_nonblocking (GPollableOutputStream  *pollable,
+                                                  const void             *buffer,
+                                                  gsize                   size,
+                                                  GError                **error)
+{
+  GSocketOutputStream *output_stream = G_SOCKET_OUTPUT_STREAM (pollable);
 
-  return res != -1;
+  return g_socket_send_with_blocking (output_stream->priv->socket,
+                                     buffer, size, FALSE,
+                                     NULL, error);
 }
 
-typedef struct {
-  gsize count;
-  const void *buffer;
-  GAsyncReadyCallback callback;
-  gpointer user_data;
-  GCancellable *cancellable;
-  GSocketOutputStream *stream;
-} WriteAsyncData;
-
-static gboolean
-write_async_cb (WriteAsyncData *data,
-               GIOCondition condition,
-               int fd)
+static GSource *
+g_socket_output_stream_pollable_create_source (GPollableOutputStream *pollable,
+                                              GCancellable          *cancellable)
 {
-  GSimpleAsyncResult *simple;
-  GError *error = NULL;
-  gssize count_written;
-
-  while (1)
-    {
-      if (g_cancellable_set_error_if_cancelled (data->cancellable, &error))
-       {
-         count_written = -1;
-         break;
-       }
-      
-      count_written = write (data->stream->priv->fd, data->buffer, data->count);
-      if (count_written == -1)
-       {
-         if (errno == EINTR)
-           continue;
-         
-         g_set_error (&error, G_IO_ERROR,
-                      g_io_error_from_errno (errno),
-                      _("Error reading from socket: %s"),
-                      g_strerror (errno));
-       }
-      break;
-    }
+  GSocketOutputStream *output_stream = G_SOCKET_OUTPUT_STREAM (pollable);
+  GSource *socket_source, *pollable_source;
 
-  simple = g_simple_async_result_new (G_OBJECT (data->stream),
-                                     data->callback,
-                                     data->user_data,
-                                     g_socket_output_stream_write_async);
-  
-  g_simple_async_result_set_op_res_gssize (simple, count_written);
+  pollable_source = g_pollable_source_new (G_OBJECT (output_stream));
+  socket_source = g_socket_create_source (output_stream->priv->socket,
+                                         G_IO_OUT, cancellable);
+  g_source_set_dummy_callback (socket_source);
+  g_source_add_child_source (pollable_source, socket_source);
+  g_source_unref (socket_source);
 
-  if (count_written == -1)
-    {
-      g_simple_async_result_set_from_error (simple, error);
-      g_error_free (error);
-    }
+  return pollable_source;
+}
 
-  /* Complete immediately, not in idle, since we're already in a mainloop callout */
-  g_simple_async_result_complete (simple);
-  g_object_unref (simple);
+#ifdef G_OS_UNIX
+static int
+g_socket_output_stream_get_fd (GFileDescriptorBased *fd_based)
+{
+  GSocketOutputStream *output_stream = G_SOCKET_OUTPUT_STREAM (fd_based);
 
-  return FALSE;
+  return g_socket_get_fd (output_stream->priv->socket);
 }
+#endif
 
 static void
-g_socket_output_stream_write_async (GOutputStream      *stream,
-                                   const void         *buffer,
-                                   gsize               count,
-                                   int                 io_priority,
-                                   GCancellable       *cancellable,
-                                   GAsyncReadyCallback callback,
-                                   gpointer            user_data)
+g_socket_output_stream_class_init (GSocketOutputStreamClass *klass)
 {
-  GSource *source;
-  GSocketOutputStream *socket_stream;
-  WriteAsyncData *data;
-
-  socket_stream = G_SOCKET_OUTPUT_STREAM (stream);
-
-  data = g_new0 (WriteAsyncData, 1);
-  data->count = count;
-  data->buffer = buffer;
-  data->callback = callback;
-  data->user_data = user_data;
-  data->cancellable = cancellable;
-  data->stream = socket_stream;
-
-  source = _g_fd_source_new (socket_stream->priv->fd,
-                            POLLOUT,
-                            cancellable);
-  
-  g_source_set_callback (source, (GSourceFunc)write_async_cb, data, g_free);
-  g_source_attach (source, NULL);
-  
-  g_source_unref (source);
+  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
+  GOutputStreamClass *goutputstream_class = G_OUTPUT_STREAM_CLASS (klass);
+
+  gobject_class->finalize = g_socket_output_stream_finalize;
+  gobject_class->get_property = g_socket_output_stream_get_property;
+  gobject_class->set_property = g_socket_output_stream_set_property;
+
+  goutputstream_class->write_fn = g_socket_output_stream_write;
+
+  g_object_class_install_property (gobject_class, PROP_SOCKET,
+                                  g_param_spec_object ("socket",
+                                                       P_("socket"),
+                                                       P_("The socket that this stream wraps"),
+                                                       G_TYPE_SOCKET, G_PARAM_CONSTRUCT_ONLY |
+                                                       G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 }
 
-static gssize
-g_socket_output_stream_write_finish (GOutputStream *stream,
-                                    GAsyncResult *result,
-                                    GError **error)
+#ifdef G_OS_UNIX
+static void
+g_socket_output_stream_file_descriptor_based_iface_init (GFileDescriptorBasedIface *iface)
 {
-  GSimpleAsyncResult *simple;
-  gssize nwritten;
-
-  simple = G_SIMPLE_ASYNC_RESULT (result);
-  g_assert (g_simple_async_result_get_source_tag (simple) == g_socket_output_stream_write_async);
-  
-  nwritten = g_simple_async_result_get_op_res_gssize (simple);
-  return nwritten;
+  iface->get_fd = g_socket_output_stream_get_fd;
 }
+#endif
 
-typedef struct {
-  GOutputStream *stream;
-  GAsyncReadyCallback callback;
-  gpointer user_data;
-} CloseAsyncData;
-
-static gboolean
-close_async_cb (CloseAsyncData *data)
+static void
+g_socket_output_stream_pollable_iface_init (GPollableOutputStreamInterface *iface)
 {
-  GSocketOutputStream *socket_stream;
-  GSimpleAsyncResult *simple;
-  GError *error = NULL;
-  gboolean result;
-  int res;
-
-  socket_stream = G_SOCKET_OUTPUT_STREAM (data->stream);
-
-  if (!socket_stream->priv->close_fd_at_close)
-    {
-      result = TRUE;
-      goto out;
-    }
-  
-  while (1)
-    {
-      res = close (socket_stream->priv->fd);
-      if (res == -1)
-       {
-         g_set_error (&error, G_IO_ERROR,
-                      g_io_error_from_errno (errno),
-                      _("Error closing socket: %s"),
-                      g_strerror (errno));
-       }
-      break;
-    }
-  
-  result = res != -1;
-  
- out:
-  simple = g_simple_async_result_new (G_OBJECT (data->stream),
-                                     data->callback,
-                                     data->user_data,
-                                     g_socket_output_stream_close_async);
-
-  if (!result)
-    {
-      g_simple_async_result_set_from_error (simple, error);
-      g_error_free (error);
-    }
-
-  /* Complete immediately, not in idle, since we're already in a mainloop callout */
-  g_simple_async_result_complete (simple);
-  g_object_unref (simple);
-  
-  return FALSE;
+  iface->is_writable = g_socket_output_stream_pollable_is_writable;
+  iface->create_source = g_socket_output_stream_pollable_create_source;
+  iface->write_nonblocking = g_socket_output_stream_pollable_write_nonblocking;
 }
 
 static void
-g_socket_output_stream_close_async (GOutputStream       *stream,
-                                   int                 io_priority,
-                                   GCancellable       *cancellable,
-                                   GAsyncReadyCallback callback,
-                                   gpointer            user_data)
+g_socket_output_stream_init (GSocketOutputStream *stream)
 {
-  GSource *idle;
-  CloseAsyncData *data;
-
-  data = g_new0 (CloseAsyncData, 1);
-
-  data->stream = stream;
-  data->callback = callback;
-  data->user_data = user_data;
-  
-  idle = g_idle_source_new ();
-  g_source_set_callback (idle, (GSourceFunc)close_async_cb, data, g_free);
-  g_source_attach (idle, NULL);
-  g_source_unref (idle);
+  stream->priv = g_socket_output_stream_get_instance_private (stream);
 }
 
-static gboolean
-g_socket_output_stream_close_finish (GOutputStream              *stream,
-                                    GAsyncResult              *result,
-                                    GError                   **error)
+GSocketOutputStream *
+_g_socket_output_stream_new (GSocket *socket)
 {
-  /* Failures handled in generic close_finish code */
-  return TRUE;
+  return g_object_new (G_TYPE_SOCKET_OUTPUT_STREAM, "socket", socket, NULL);
 }