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 #include <glib-object.h>
  27
  28 G_BEGIN_DECLS
  29
  30 #define G_TYPE_CANCELLABLE         (g_cancellable_get_type ())
  31 #define G_CANCELLABLE(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_CANCELLABLE, GCancellable))
  32 #define G_CANCELLABLE_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_CANCELLABLE, GCancellableClass))
  33 #define G_IS_CANCELLABLE(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_CANCELLABLE))
  34 #define G_IS_CANCELLABLE_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_CANCELLABLE))
  35 #define G_CANCELLABLE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_CANCELLABLE, GCancellableClass))
  36
  37 /**
  38  * GCancellable:
  39  *
  40  * Allows actions to be cancelled.
  41  */
  42 typedef struct _GCancellable        GCancellable;
  43 typedef struct _GCancellableClass   GCancellableClass;
  44
  45 struct _GCancellableClass
  46 {
  47   GObjectClass parent_class;
  48
  49   void (* cancelled) (GCancellable *cancellable);
  50
  51   /*< private >*/
  52   /* Padding for future expansion */
  53   void (*_g_reserved1) (void);
  54   void (*_g_reserved2) (void);
  55   void (*_g_reserved3) (void);
  56   void (*_g_reserved4) (void);
  57   void (*_g_reserved5) (void);
  58 };
  59
  60 GType g_cancellable_get_type (void) G_GNUC_CONST;
  61
  62 GCancellable *g_cancellable_new          (void);
  63
  64 /* These are only safe to call inside a cancellable op */
  65 gboolean      g_cancellable_is_cancelled           (GCancellable  *cancellable);
  66 gboolean      g_cancellable_set_error_if_cancelled (GCancellable  *cancellable,
  67                                                     GError       **error);
  68 int           g_cancellable_get_fd                 (GCancellable  *cancellable);
  69 GCancellable *g_cancellable_get_current            (void);
  70 void          g_push_current_cancellable           (GCancellable  *cancellable);
  71 void          g_pop_current_cancellable            (GCancellable  *cancellable);
  72 void          g_cancellable_reset                  (GCancellable  *cancellable);
  73
  74
  75 /* This is safe to call from another thread */
  76 void          g_cancellable_cancel       (GCancellable  *cancellable);
  77
  78 G_END_DECLS
  79
  80 #endif /* __G_CANCELLABLE_H__ */