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