gio/gsocketinputstream.c

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright © 2008 Christian Kellner, Samuel Cormier-Iijima
   4  *           © 2009 codethink
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General
  17  * Public License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  *
  21  * Authors: Christian Kellner <gicmo@gnome.org>
  22  *          Samuel Cormier-Iijima <sciyoshi@gmail.com>
  23  *          Ryan Lortie <desrt@desrt.ca>
  24  */
  25
  26 #include "config.h"
  27 #include "gsocketinputstream.h"
  28 #include "glibintl.h"
  29
  30 #include <gio/gsimpleasyncresult.h>
  31 #include <gio/gcancellable.h>
  32
  33 #include "gioalias.h"
  34
  35 #define g_socket_input_stream_get_type _g_socket_input_stream_get_type
  36 G_DEFINE_TYPE (GSocketInputStream, g_socket_input_stream, G_TYPE_INPUT_STREAM);
  37
  38 enum
  39 {
  40   PROP_0,
  41   PROP_SOCKET
  42 };
  43
  44 struct _GSocketInputStreamPrivate
  45 {
  46   GSocket *socket;
  47
  48   /* pending operation metadata */
  49   GSimpleAsyncResult *result;
  50   GCancellable *cancellable;
  51   gboolean from_mainloop;
  52   gpointer buffer;
  53   gsize count;
  54 };
  55
  56 static void
  57 g_socket_input_stream_get_property (GObject    *object,
  58                                     guint       prop_id,
  59                                     GValue     *value,
  60                                     GParamSpec *pspec)
  61 {
  62   GSocketInputStream *stream = G_SOCKET_INPUT_STREAM (object);
  63
  64   switch (prop_id)
  65     {
  66       case PROP_SOCKET:
  67         g_value_set_object (value, stream->priv->socket);
  68         break;
  69
  70       default:
  71         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
  72     }
  73 }
  74
  75 static void
  76 g_socket_input_stream_set_property (GObject      *object,
  77                                     guint         prop_id,
  78                                     const GValue *value,
  79                                     GParamSpec   *pspec)
  80 {
  81   GSocketInputStream *stream = G_SOCKET_INPUT_STREAM (object);
  82
  83   switch (prop_id)
  84     {
  85       case PROP_SOCKET:
  86         stream->priv->socket = g_value_dup_object (value);
  87         break;
  88
  89       default:
  90         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
  91     }
  92 }
  93
  94 static void
  95 g_socket_input_stream_finalize (GObject *object)
  96 {
  97   GSocketInputStream *stream = G_SOCKET_INPUT_STREAM (object);
  98
  99   if (stream->priv->socket)
 100     g_object_unref (stream->priv->socket);
 101
 102   if (G_OBJECT_CLASS (g_socket_input_stream_parent_class)->finalize)
 103     (*G_OBJECT_CLASS (g_socket_input_stream_parent_class)->finalize) (object);
 104 }
 105
 106 static gssize
 107 g_socket_input_stream_read (GInputStream  *stream,
 108                             void          *buffer,
 109                             gsize          count,
 110                             GCancellable  *cancellable,
 111                             GError       **error)
 112 {
 113   GSocketInputStream *input_stream = G_SOCKET_INPUT_STREAM (stream);
 114
 115   return g_socket_receive (input_stream->priv->socket, buffer, count,
 116                            cancellable, error);
 117 }
 118
 119 static gboolean
 120 g_socket_input_stream_read_ready (GSocket *socket,
 121                                   GIOCondition condition,
 122                                   GSocketInputStream *stream)
 123 {
 124   GSimpleAsyncResult *simple;
 125   GError *error = NULL;
 126   gssize result;
 127
 128   simple = stream->priv->result;
 129   stream->priv->result = NULL;
 130
 131   result = g_socket_receive (stream->priv->socket,
 132                              stream->priv->buffer,
 133                              stream->priv->count,
 134                              stream->priv->cancellable,
 135                              &error);
 136   if (result >= 0)
 137     g_simple_async_result_set_op_res_gssize (simple, result);
 138
 139   if (error)
 140     {
 141       g_simple_async_result_set_from_error (simple, error);
 142       g_error_free (error);
 143     }
 144
 145   if (stream->priv->cancellable)
 146     g_object_unref (stream->priv->cancellable);
 147
 148   if (stream->priv->from_mainloop)
 149     g_simple_async_result_complete (simple);
 150   else
 151     g_simple_async_result_complete_in_idle (simple);
 152
 153   g_object_unref (simple);
 154
 155   return FALSE;
 156 }
 157
 158 static void
 159 g_socket_input_stream_read_async (GInputStream        *stream,
 160                                   void                *buffer,
 161                                   gsize                count,
 162                                   gint                 io_priority,
 163                                   GCancellable        *cancellable,
 164                                   GAsyncReadyCallback  callback,
 165                                   gpointer             user_data)
 166 {
 167   GSocketInputStream *input_stream = G_SOCKET_INPUT_STREAM (stream);
 168
 169   g_assert (input_stream->priv->result == NULL);
 170
 171   input_stream->priv->result =
 172     g_simple_async_result_new (G_OBJECT (stream), callback, user_data,
 173                                g_socket_input_stream_read_async);
 174   if (cancellable)
 175     g_object_ref (cancellable);
 176   input_stream->priv->cancellable = cancellable;
 177   input_stream->priv->buffer = buffer;
 178   input_stream->priv->count = count;
 179
 180   if (!g_socket_condition_check (input_stream->priv->socket, G_IO_IN))
 181     {
 182       GSource *source;
 183
 184       input_stream->priv->from_mainloop = TRUE;
 185       source = g_socket_create_source (input_stream->priv->socket,
 186                                        G_IO_IN | G_IO_HUP | G_IO_ERR,
 187                                        cancellable);
 188       g_source_set_callback (source,
 189                              (GSourceFunc) g_socket_input_stream_read_ready,
 190                              g_object_ref (input_stream), g_object_unref);
 191       g_source_attach (source, g_main_context_get_thread_default ());
 192       g_source_unref (source);
 193     }
 194   else
 195     {
 196       input_stream->priv->from_mainloop = FALSE;
 197       g_socket_input_stream_read_ready (input_stream->priv->socket, G_IO_IN, input_stream);
 198     }
 199 }
 200
 201 static gssize
 202 g_socket_input_stream_read_finish (GInputStream  *stream,
 203                                    GAsyncResult  *result,
 204                                    GError       **error)
 205 {
 206   GSimpleAsyncResult *simple;
 207   gssize count;
 208
 209   g_return_val_if_fail (G_IS_SOCKET_INPUT_STREAM (stream), -1);
 210
 211   simple = G_SIMPLE_ASYNC_RESULT (result);
 212
 213   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_socket_input_stream_read_async);
 214
 215   count = g_simple_async_result_get_op_res_gssize (simple);
 216
 217   return count;
 218 }
 219
 220 static void
 221 g_socket_input_stream_class_init (GSocketInputStreamClass *klass)
 222 {
 223   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 224   GInputStreamClass *ginputstream_class = G_INPUT_STREAM_CLASS (klass);
 225
 226   g_type_class_add_private (klass, sizeof (GSocketInputStreamPrivate));
 227
 228   gobject_class->finalize = g_socket_input_stream_finalize;
 229   gobject_class->get_property = g_socket_input_stream_get_property;
 230   gobject_class->set_property = g_socket_input_stream_set_property;
 231
 232   ginputstream_class->read_fn = g_socket_input_stream_read;
 233   ginputstream_class->read_async = g_socket_input_stream_read_async;
 234   ginputstream_class->read_finish = g_socket_input_stream_read_finish;
 235
 236   g_object_class_install_property (gobject_class, PROP_SOCKET,
 237                                    g_param_spec_object ("socket",
 238                                                         P_("socket"),
 239                                                         P_("The socket that this stream wraps"),
 240                                                         G_TYPE_SOCKET, G_PARAM_CONSTRUCT_ONLY |
 241                                                         G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 242 }
 243
 244 static void
 245 g_socket_input_stream_init (GSocketInputStream *stream)
 246 {
 247   stream->priv = G_TYPE_INSTANCE_GET_PRIVATE (stream, G_TYPE_SOCKET_INPUT_STREAM, GSocketInputStreamPrivate);
 248 }
 249
 250 GSocketInputStream *
 251 _g_socket_input_stream_new (GSocket *socket)
 252 {
 253   return G_SOCKET_INPUT_STREAM (g_object_new (G_TYPE_SOCKET_INPUT_STREAM, "socket", socket, NULL));
 254 }
 255
 256 #define __G_SOCKET_INPUT_STREAM_C__
 257 #include "gioaliasdef.c"