gio/gcancellable.h

   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.1 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, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: Alexander Larsson <alexl@redhat.com>
  19  */
  20
  21 #ifndef __G_CANCELLABLE_H__
  22 #define __G_CANCELLABLE_H__
  23
  24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  25 #error "Only <gio/gio.h> can be included directly."
  26 #endif
  27
  28 #include <gio/giotypes.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define G_TYPE_CANCELLABLE         (g_cancellable_get_type ())
  33 #define G_CANCELLABLE(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_CANCELLABLE, GCancellable))
  34 #define G_CANCELLABLE_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_CANCELLABLE, GCancellableClass))
  35 #define G_IS_CANCELLABLE(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_CANCELLABLE))
  36 #define G_IS_CANCELLABLE_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_CANCELLABLE))
  37 #define G_CANCELLABLE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_CANCELLABLE, GCancellableClass))
  38
  39 /**
  40  * GCancellable:
  41  *
  42  * Allows actions to be cancelled.
  43  */
  44 typedef struct _GCancellableClass   GCancellableClass;
  45 typedef struct _GCancellablePrivate GCancellablePrivate;
  46
  47 struct _GCancellable
  48 {
  49   GObject parent_instance;
  50
  51   /*< private >*/
  52   GCancellablePrivate *priv;
  53 };
  54
  55 struct _GCancellableClass
  56 {
  57   GObjectClass parent_class;
  58
  59   void (* cancelled) (GCancellable *cancellable);
  60
  61   /*< private >*/
  62   /* Padding for future expansion */
  63   void (*_g_reserved1) (void);
  64   void (*_g_reserved2) (void);
  65   void (*_g_reserved3) (void);
  66   void (*_g_reserved4) (void);
  67   void (*_g_reserved5) (void);
  68 };
  69
  70 GLIB_AVAILABLE_IN_ALL
  71 GType         g_cancellable_get_type               (void) G_GNUC_CONST;
  72
  73 GLIB_AVAILABLE_IN_ALL
  74 GCancellable *g_cancellable_new                    (void);
  75
  76 /* These are only safe to call inside a cancellable op */
  77 GLIB_AVAILABLE_IN_ALL
  78 gboolean      g_cancellable_is_cancelled           (GCancellable  *cancellable);
  79 GLIB_AVAILABLE_IN_ALL
  80 gboolean      g_cancellable_set_error_if_cancelled (GCancellable  *cancellable,
  81                                                     GError       **error);
  82
  83 GLIB_AVAILABLE_IN_ALL
  84 int           g_cancellable_get_fd                 (GCancellable  *cancellable);
  85 GLIB_AVAILABLE_IN_ALL
  86 gboolean      g_cancellable_make_pollfd            (GCancellable  *cancellable,
  87                                                     GPollFD       *pollfd);
  88 GLIB_AVAILABLE_IN_ALL
  89 void          g_cancellable_release_fd             (GCancellable  *cancellable);
  90
  91 GLIB_AVAILABLE_IN_ALL
  92 GSource *     g_cancellable_source_new             (GCancellable  *cancellable);
  93
  94 GLIB_AVAILABLE_IN_ALL
  95 GCancellable *g_cancellable_get_current            (void);
  96 GLIB_AVAILABLE_IN_ALL
  97 void          g_cancellable_push_current           (GCancellable  *cancellable);
  98 GLIB_AVAILABLE_IN_ALL
  99 void          g_cancellable_pop_current            (GCancellable  *cancellable);
 100 GLIB_AVAILABLE_IN_ALL
 101 void          g_cancellable_reset                  (GCancellable  *cancellable);
 102 GLIB_AVAILABLE_IN_ALL
 103 gulong        g_cancellable_connect                (GCancellable  *cancellable,
 104                                                     GCallback      callback,
 105                                                     gpointer       data,
 106                                                     GDestroyNotify data_destroy_func);
 107 GLIB_AVAILABLE_IN_ALL
 108 void          g_cancellable_disconnect             (GCancellable  *cancellable,
 109                                                     gulong         handler_id);
 110
 111
 112 /* This is safe to call from another thread */
 113 GLIB_AVAILABLE_IN_ALL
 114 void          g_cancellable_cancel       (GCancellable  *cancellable);
 115
 116 G_END_DECLS
 117
 118 #endif /* __G_CANCELLABLE_H__ */