/* GIO - GLib Input, Output and Streaming Library
- *
- * Copyright (C) 2006-2007 Red Hat, Inc.
+ *
+ * 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 "gsimpleasyncresult.h"
+#include "config.h"
#include "gsocketinputstream.h"
-#include "gcancellable.h"
-#include "gasynchelper.h"
-
#include "glibintl.h"
-G_DEFINE_TYPE (GSocketInputStream, g_socket_input_stream, G_TYPE_INPUT_STREAM);
+#include "gcancellable.h"
+#include "gpollableinputstream.h"
+#include "gioerror.h"
+#include "gfiledescriptorbased.h"
+
+struct _GSocketInputStreamPrivate
+{
+ GSocket *socket;
-struct _GSocketInputStreamPrivate {
- int fd;
- gboolean close_fd_at_close;
+ /* pending operation metadata */
+ gpointer buffer;
+ gsize count;
};
-static gssize g_socket_input_stream_read (GInputStream *stream,
- void *buffer,
- gsize count,
- GCancellable *cancellable,
- GError **error);
-static gboolean g_socket_input_stream_close (GInputStream *stream,
- GCancellable *cancellable,
- GError **error);
-static void g_socket_input_stream_read_async (GInputStream *stream,
- void *buffer,
- gsize count,
- int io_priority,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer data);
-static gssize g_socket_input_stream_read_finish (GInputStream *stream,
- GAsyncResult *result,
- GError **error);
-static void g_socket_input_stream_skip_async (GInputStream *stream,
- gsize count,
- int io_priority,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer data);
-static gssize g_socket_input_stream_skip_finish (GInputStream *stream,
- GAsyncResult *result,
- GError **error);
-static void g_socket_input_stream_close_async (GInputStream *stream,
- int io_priority,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer data);
-static gboolean g_socket_input_stream_close_finish (GInputStream *stream,
- GAsyncResult *result,
- GError **error);
+static void g_socket_input_stream_pollable_iface_init (GPollableInputStreamInterface *iface);
+#ifdef G_OS_UNIX
+static void g_socket_input_stream_file_descriptor_based_iface_init (GFileDescriptorBasedIface *iface);
+#endif
+
+#define g_socket_input_stream_get_type _g_socket_input_stream_get_type
+
+#ifdef G_OS_UNIX
+G_DEFINE_TYPE_WITH_CODE (GSocketInputStream, g_socket_input_stream, G_TYPE_INPUT_STREAM,
+ G_ADD_PRIVATE (GSocketInputStream)
+ G_IMPLEMENT_INTERFACE (G_TYPE_POLLABLE_INPUT_STREAM, g_socket_input_stream_pollable_iface_init)
+ G_IMPLEMENT_INTERFACE (G_TYPE_FILE_DESCRIPTOR_BASED, g_socket_input_stream_file_descriptor_based_iface_init)
+ )
+#else
+G_DEFINE_TYPE_WITH_CODE (GSocketInputStream, g_socket_input_stream, G_TYPE_INPUT_STREAM,
+ G_ADD_PRIVATE (GSocketInputStream)
+ G_IMPLEMENT_INTERFACE (G_TYPE_POLLABLE_INPUT_STREAM, g_socket_input_stream_pollable_iface_init)
+ )
+#endif
+
+enum
+{
+ PROP_0,
+ PROP_SOCKET
+};
static void
-g_socket_input_stream_finalize (GObject *object)
+g_socket_input_stream_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec)
{
- GSocketInputStream *stream;
-
- stream = G_SOCKET_INPUT_STREAM (object);
+ GSocketInputStream *stream = G_SOCKET_INPUT_STREAM (object);
- if (G_OBJECT_CLASS (g_socket_input_stream_parent_class)->finalize)
- (*G_OBJECT_CLASS (g_socket_input_stream_parent_class)->finalize) (object);
+ switch (prop_id)
+ {
+ case PROP_SOCKET:
+ g_value_set_object (value, stream->priv->socket);
+ break;
+
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ }
}
static void
-g_socket_input_stream_class_init (GSocketInputStreamClass *klass)
+g_socket_input_stream_set_property (GObject *object,
+ guint prop_id,
+ const GValue *value,
+ GParamSpec *pspec)
{
- GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
- GInputStreamClass *stream_class = G_INPUT_STREAM_CLASS (klass);
-
- g_type_class_add_private (klass, sizeof (GSocketInputStreamPrivate));
-
- gobject_class->finalize = g_socket_input_stream_finalize;
+ GSocketInputStream *stream = G_SOCKET_INPUT_STREAM (object);
- stream_class->read = g_socket_input_stream_read;
- stream_class->close = g_socket_input_stream_close;
- stream_class->read_async = g_socket_input_stream_read_async;
- stream_class->read_finish = g_socket_input_stream_read_finish;
- if (0)
+ switch (prop_id)
{
- /* TODO: Implement instead of using fallbacks */
- stream_class->skip_async = g_socket_input_stream_skip_async;
- stream_class->skip_finish = g_socket_input_stream_skip_finish;
+ case PROP_SOCKET:
+ stream->priv->socket = g_value_dup_object (value);
+ break;
+
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
}
- stream_class->close_async = g_socket_input_stream_close_async;
- stream_class->close_finish = g_socket_input_stream_close_finish;
}
static void
-g_socket_input_stream_init (GSocketInputStream *socket)
-{
- socket->priv = G_TYPE_INSTANCE_GET_PRIVATE (socket,
- G_TYPE_SOCKET_INPUT_STREAM,
- GSocketInputStreamPrivate);
-}
-
-/**
- * g_socket_input_stream_new:
- * @fd: file descriptor.
- * @close_fd_at_close: boolean value
- *
- *
- * Returns: new #GInputStream. If @close_fd_at_close is %TRUE,
- * @fd will be closed when the #GInputStream is closed.
- **/
-GInputStream *
-g_socket_input_stream_new (int fd,
- gboolean close_fd_at_close)
+g_socket_input_stream_finalize (GObject *object)
{
- GSocketInputStream *stream;
-
- g_return_val_if_fail (fd != -1, NULL);
+ GSocketInputStream *stream = G_SOCKET_INPUT_STREAM (object);
- stream = g_object_new (G_TYPE_SOCKET_INPUT_STREAM, NULL);
+ if (stream->priv->socket)
+ g_object_unref (stream->priv->socket);
- stream->priv->fd = fd;
- stream->priv->close_fd_at_close = close_fd_at_close;
-
- return G_INPUT_STREAM (stream);
+ G_OBJECT_CLASS (g_socket_input_stream_parent_class)->finalize (object);
}
static gssize
-g_socket_input_stream_read (GInputStream *stream,
- void *buffer,
- gsize count,
- GCancellable *cancellable,
- GError **error)
+g_socket_input_stream_read (GInputStream *stream,
+ void *buffer,
+ gsize count,
+ GCancellable *cancellable,
+ GError **error)
{
- GSocketInputStream *socket_stream;
- gssize res;
- struct pollfd poll_fds[2];
- int poll_ret;
- int cancel_fd;
-
- socket_stream = G_SOCKET_INPUT_STREAM (stream);
+ GSocketInputStream *input_stream = G_SOCKET_INPUT_STREAM (stream);
- cancel_fd = g_cancellable_get_fd (cancellable);
- if (cancel_fd != -1)
- {
- do
- {
- poll_fds[0].events = POLLIN;
- 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 reading from socket: %s"),
- g_strerror (errno));
- return -1;
- }
- }
-
- while (1)
- {
- if (g_cancellable_set_error_if_cancelled (cancellable, error))
- break;
- res = read (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 reading from socket: %s"),
- g_strerror (errno));
- }
-
- break;
- }
-
- return res;
+ return g_socket_receive_with_blocking (input_stream->priv->socket,
+ buffer, count, TRUE,
+ cancellable, error);
}
static gboolean
-g_socket_input_stream_close (GInputStream *stream,
- GCancellable *cancellable,
- GError **error)
+g_socket_input_stream_pollable_is_readable (GPollableInputStream *pollable)
{
- GSocketInputStream *socket_stream;
- int res;
-
- socket_stream = G_SOCKET_INPUT_STREAM (stream);
+ GSocketInputStream *input_stream = G_SOCKET_INPUT_STREAM (pollable);
- 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;
- }
-
- return res != -1;
+ return g_socket_condition_check (input_stream->priv->socket, G_IO_IN);
}
-typedef struct {
- gsize count;
- void *buffer;
- GAsyncReadyCallback callback;
- gpointer user_data;
- GCancellable *cancellable;
- GSocketInputStream *stream;
-} ReadAsyncData;
-
-static gboolean
-read_async_cb (ReadAsyncData *data,
- GIOCondition condition,
- int fd)
+static GSource *
+g_socket_input_stream_pollable_create_source (GPollableInputStream *pollable,
+ GCancellable *cancellable)
{
- GSimpleAsyncResult *simple;
- GError *error = NULL;
- gssize count_read;
-
- /* We know that we can read from fd once without blocking */
- while (1)
- {
- if (g_cancellable_set_error_if_cancelled (data->cancellable, &error))
- {
- count_read = -1;
- break;
- }
- count_read = read (data->stream->priv->fd, data->buffer, data->count);
- if (count_read == -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;
- }
-
- simple = g_simple_async_result_new (G_OBJECT (data->stream),
- data->callback,
- data->user_data,
- g_socket_input_stream_read_async);
+ GSocketInputStream *input_stream = G_SOCKET_INPUT_STREAM (pollable);
+ GSource *socket_source, *pollable_source;
- g_simple_async_result_set_op_res_gssize (simple, count_read);
+ pollable_source = g_pollable_source_new (G_OBJECT (input_stream));
+ socket_source = g_socket_create_source (input_stream->priv->socket,
+ G_IO_IN, cancellable);
+ g_source_set_dummy_callback (socket_source);
+ g_source_add_child_source (pollable_source, socket_source);
+ g_source_unref (socket_source);
- if (count_read == -1)
- {
- 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;
+ return pollable_source;
}
-static void
-g_socket_input_stream_read_async (GInputStream *stream,
- void *buffer,
- gsize count,
- int io_priority,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer user_data)
+static gssize
+g_socket_input_stream_pollable_read_nonblocking (GPollableInputStream *pollable,
+ void *buffer,
+ gsize size,
+ GError **error)
{
- GSource *source;
- GSocketInputStream *socket_stream;
- ReadAsyncData *data;
-
- socket_stream = G_SOCKET_INPUT_STREAM (stream);
-
- data = g_new0 (ReadAsyncData, 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,
- POLLIN,
- cancellable);
-
- g_source_set_callback (source, (GSourceFunc)read_async_cb, data, g_free);
- g_source_attach (source, NULL);
-
- g_source_unref (source);
+ GSocketInputStream *input_stream = G_SOCKET_INPUT_STREAM (pollable);
+
+ return g_socket_receive_with_blocking (input_stream->priv->socket,
+ buffer, size, FALSE,
+ NULL, error);
}
-static gssize
-g_socket_input_stream_read_finish (GInputStream *stream,
- GAsyncResult *result,
- GError **error)
+#ifdef G_OS_UNIX
+static int
+g_socket_input_stream_get_fd (GFileDescriptorBased *fd_based)
{
- GSimpleAsyncResult *simple;
- gssize nread;
-
- simple = G_SIMPLE_ASYNC_RESULT (result);
- g_assert (g_simple_async_result_get_source_tag (simple) == g_socket_input_stream_read_async);
-
- nread = g_simple_async_result_get_op_res_gssize (simple);
- return nread;
+ GSocketInputStream *input_stream = G_SOCKET_INPUT_STREAM (fd_based);
+
+ return g_socket_get_fd (input_stream->priv->socket);
}
+#endif
static void
-g_socket_input_stream_skip_async (GInputStream *stream,
- gsize count,
- int io_priority,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer data)
+g_socket_input_stream_class_init (GSocketInputStreamClass *klass)
{
- g_assert_not_reached ();
- /* TODO: Not implemented */
-}
+ GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
+ GInputStreamClass *ginputstream_class = G_INPUT_STREAM_CLASS (klass);
-static gssize
-g_socket_input_stream_skip_finish (GInputStream *stream,
- GAsyncResult *result,
- GError **error)
-{
- g_assert_not_reached ();
- /* TODO: Not implemented */
-}
+ gobject_class->finalize = g_socket_input_stream_finalize;
+ gobject_class->get_property = g_socket_input_stream_get_property;
+ gobject_class->set_property = g_socket_input_stream_set_property;
+ ginputstream_class->read_fn = g_socket_input_stream_read;
-typedef struct {
- GInputStream *stream;
- GAsyncReadyCallback callback;
- gpointer user_data;
-} CloseAsyncData;
+ 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));
+}
+#ifdef G_OS_UNIX
static void
-close_async_data_free (gpointer _data)
+g_socket_input_stream_file_descriptor_based_iface_init (GFileDescriptorBasedIface *iface)
{
- CloseAsyncData *data = _data;
-
- g_free (data);
+ iface->get_fd = g_socket_input_stream_get_fd;
}
+#endif
-static gboolean
-close_async_cb (CloseAsyncData *data)
+static void
+g_socket_input_stream_pollable_iface_init (GPollableInputStreamInterface *iface)
{
- GSocketInputStream *socket_stream;
- GSimpleAsyncResult *simple;
- GError *error = NULL;
- gboolean result;
- int res;
-
- socket_stream = G_SOCKET_INPUT_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_input_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_readable = g_socket_input_stream_pollable_is_readable;
+ iface->create_source = g_socket_input_stream_pollable_create_source;
+ iface->read_nonblocking = g_socket_input_stream_pollable_read_nonblocking;
}
static void
-g_socket_input_stream_close_async (GInputStream *stream,
- int io_priority,
- GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer user_data)
+g_socket_input_stream_init (GSocketInputStream *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, close_async_data_free);
- g_source_attach (idle, NULL);
- g_source_unref (idle);
+ stream->priv = g_socket_input_stream_get_instance_private (stream);
}
-static gboolean
-g_socket_input_stream_close_finish (GInputStream *stream,
- GAsyncResult *result,
- GError **error)
+GSocketInputStream *
+_g_socket_input_stream_new (GSocket *socket)
{
- /* Failures handled in generic close_finish code */
- return TRUE;
+ return g_object_new (G_TYPE_SOCKET_INPUT_STREAM, "socket", socket, NULL);
}
-