gio/gasynchelper.c

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #include "config.h"
  24
  25 #include "gasynchelper.h"
  26
  27
  28 /**
  29  * SECTION:gasynchelper
  30  * @short_description: Asynchronous Helper Functions
  31  * @include: gio/gio.h
  32  * @see_also: #GAsyncReady
  33  *
  34  * Provides helper functions for asynchronous operations.
  35  *
  36  **/
  37
  38 /*************************************************************************
  39  *             fd source                                                 *
  40  ************************************************************************/
  41
  42 typedef struct
  43 {
  44   GSource source;
  45   GPollFD pollfd;
  46   GCancellable *cancellable;
  47   gulong cancelled_tag;
  48 } FDSource;
  49
  50 static gboolean
  51 fd_source_prepare (GSource *source,
  52                    gint    *timeout)
  53 {
  54   FDSource *fd_source = (FDSource *)source;
  55   *timeout = -1;
  56
  57   return g_cancellable_is_cancelled (fd_source->cancellable);
  58 }
  59
  60 static gboolean
  61 fd_source_check (GSource *source)
  62 {
  63   FDSource *fd_source = (FDSource *)source;
  64
  65   return
  66     g_cancellable_is_cancelled  (fd_source->cancellable) ||
  67     fd_source->pollfd.revents != 0;
  68 }
  69
  70 static gboolean
  71 fd_source_dispatch (GSource     *source,
  72                     GSourceFunc  callback,
  73                     gpointer     user_data)
  74
  75 {
  76   GFDSourceFunc func = (GFDSourceFunc)callback;
  77   FDSource *fd_source = (FDSource *)source;
  78
  79   g_warn_if_fail (func != NULL);
  80
  81   return (*func) (user_data, fd_source->pollfd.revents, fd_source->pollfd.fd);
  82 }
  83
  84 static void
  85 fd_source_finalize (GSource *source)
  86 {
  87   FDSource *fd_source = (FDSource *)source;
  88
  89   if (fd_source->cancelled_tag)
  90     g_cancellable_disconnect (fd_source->cancellable,
  91                               fd_source->cancelled_tag);
  92
  93   if (fd_source->cancellable)
  94     g_object_unref (fd_source->cancellable);
  95 }
  96
  97 static GSourceFuncs fd_source_funcs = {
  98   fd_source_prepare,
  99   fd_source_check,
 100   fd_source_dispatch,
 101   fd_source_finalize
 102 };
 103
 104 /* Might be called on another thread */
 105 static void
 106 fd_source_cancelled_cb (GCancellable *cancellable,
 107                         gpointer      data)
 108 {
 109   /* Wake up the mainloop in case we're waiting on async calls with FDSource */
 110   g_main_context_wakeup (NULL);
 111 }
 112
 113 GSource *
 114 _g_fd_source_new (int           fd,
 115                   gushort       events,
 116                   GCancellable *cancellable)
 117 {
 118   GSource *source;
 119   FDSource *fd_source;
 120
 121   source = g_source_new (&fd_source_funcs, sizeof (FDSource));
 122   fd_source = (FDSource *)source;
 123
 124   if (cancellable)
 125     fd_source->cancellable = g_object_ref (cancellable);
 126
 127   fd_source->pollfd.fd = fd;
 128   fd_source->pollfd.events = events;
 129   g_source_add_poll (source, &fd_source->pollfd);
 130
 131   if (cancellable)
 132     fd_source->cancelled_tag =
 133       g_cancellable_connect (cancellable,
 134                              (GCallback)fd_source_cancelled_cb,
 135                              NULL, NULL);
 136
 137   return source;
 138 }