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 #include "gioalias.h"
  28
  29 /**
  30  * SECTION:gasynchelper
  31  * @short_description: Asynchronous Helper Functions
  32  * @include: gio/gio.h
  33  * @see_also: #GAsyncReady
  34  *
  35  * Provides helper functions for asynchronous operations.
  36  *
  37  **/
  38
  39 /*************************************************************************
  40  *             fd source                                                 *
  41  ************************************************************************/
  42
  43 typedef struct
  44 {
  45   GSource source;
  46   GPollFD pollfd;
  47   GCancellable *cancellable;
  48   gulong cancelled_tag;
  49 } FDSource;
  50
  51 static gboolean
  52 fd_source_prepare (GSource *source,
  53                    gint    *timeout)
  54 {
  55   FDSource *fd_source = (FDSource *)source;
  56   *timeout = -1;
  57
  58   return g_cancellable_is_cancelled (fd_source->cancellable);
  59 }
  60
  61 static gboolean
  62 fd_source_check (GSource *source)
  63 {
  64   FDSource *fd_source = (FDSource *)source;
  65
  66   return
  67     g_cancellable_is_cancelled  (fd_source->cancellable) ||
  68     fd_source->pollfd.revents != 0;
  69 }
  70
  71 static gboolean
  72 fd_source_dispatch (GSource     *source,
  73                     GSourceFunc  callback,
  74                     gpointer     user_data)
  75
  76 {
  77   GFDSourceFunc func = (GFDSourceFunc)callback;
  78   FDSource *fd_source = (FDSource *)source;
  79
  80   g_warn_if_fail (func != NULL);
  81
  82   return (*func) (user_data, fd_source->pollfd.revents, fd_source->pollfd.fd);
  83 }
  84
  85 static void
  86 fd_source_finalize (GSource *source)
  87 {
  88   FDSource *fd_source = (FDSource *)source;
  89
  90   if (fd_source->cancelled_tag)
  91     g_cancellable_disconnect (fd_source->cancellable,
  92                               fd_source->cancelled_tag);
  93
  94   if (fd_source->cancellable)
  95     g_object_unref (fd_source->cancellable);
  96 }
  97
  98 static GSourceFuncs fd_source_funcs = {
  99   fd_source_prepare,
 100   fd_source_check,
 101   fd_source_dispatch,
 102   fd_source_finalize
 103 };
 104
 105 /* Might be called on another thread */
 106 static void
 107 fd_source_cancelled_cb (GCancellable *cancellable,
 108                         gpointer      data)
 109 {
 110   /* Wake up the mainloop in case we're waiting on async calls with FDSource */
 111   g_main_context_wakeup (NULL);
 112 }
 113
 114 GSource *
 115 _g_fd_source_new (int           fd,
 116                   gushort       events,
 117                   GCancellable *cancellable)
 118 {
 119   GSource *source;
 120   FDSource *fd_source;
 121
 122   source = g_source_new (&fd_source_funcs, sizeof (FDSource));
 123   fd_source = (FDSource *)source;
 124
 125   if (cancellable)
 126     fd_source->cancellable = g_object_ref (cancellable);
 127
 128   fd_source->pollfd.fd = fd;
 129   fd_source->pollfd.events = events;
 130   g_source_add_poll (source, &fd_source->pollfd);
 131
 132   if (cancellable)
 133     fd_source->cancelled_tag =
 134       g_cancellable_connect (cancellable,
 135                              (GCallback)fd_source_cancelled_cb,
 136                              NULL, NULL);
 137
 138   return source;
 139 }