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 (at) redhat.com> 21 */ 22 23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION) 24 #error "Only <gio/gio.h> can be included directly." 25 #endif 26 27 #ifndef __G_CANCELLABLE_H__ 28 #define __G_CANCELLABLE_H__ 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 48 struct _GCancellableClass 49 { 50 GObjectClass parent_class; 51 52 void (* cancelled) (GCancellable *cancellable); 53 54 /*< private >*/ 55 /* Padding for future expansion */ 56 void (*_g_reserved1) (void); 57 void (*_g_reserved2) (void); 58 void (*_g_reserved3) (void); 59 void (*_g_reserved4) (void); 60 void (*_g_reserved5) (void); 61 }; 62 63 GType g_cancellable_get_type (void) G_GNUC_CONST; 64 65 GCancellable *g_cancellable_new (void); 66 67 /* These are only safe to call inside a cancellable op */ 68 gboolean g_cancellable_is_cancelled (GCancellable *cancellable); 69 gboolean g_cancellable_set_error_if_cancelled (GCancellable *cancellable, 70 GError **error); 71 72 int g_cancellable_get_fd (GCancellable *cancellable); 73 void g_cancellable_make_pollfd (GCancellable *cancellable, 74 GPollFD *pollfd); 75 76 GCancellable *g_cancellable_get_current (void); 77 void g_cancellable_push_current (GCancellable *cancellable); 78 void g_cancellable_pop_current (GCancellable *cancellable); 79 void g_cancellable_reset (GCancellable *cancellable); 80 81 82 /* This is safe to call from another thread */ 83 void g_cancellable_cancel (GCancellable *cancellable); 84 85 G_END_DECLS 86 87 #endif /* __G_CANCELLABLE_H__ */ 88
