1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
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.
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.
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.
20 * Author: Alexander Larsson <alexl@redhat.com>
23 #ifndef __G_CANCELLABLE_H__
24 #define __G_CANCELLABLE_H__
26 #include <glib-object.h>
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))
37 typedef struct _GCancellable GCancellable;
38 typedef struct _GCancellableClass GCancellableClass;
40 struct _GCancellableClass
42 GObjectClass parent_class;
44 void (* cancelled) (GCancellable *cancellable);
46 /* Padding for future expansion */
47 void (*_g_reserved1) (void);
48 void (*_g_reserved2) (void);
49 void (*_g_reserved3) (void);
50 void (*_g_reserved4) (void);
51 void (*_g_reserved5) (void);
54 GType g_cancellable_get_type (void) G_GNUC_CONST;
56 GCancellable *g_cancellable_new (void);
58 /* These are only safe to call inside a cancellable op */
59 gboolean g_cancellable_is_cancelled (GCancellable *cancellable);
60 gboolean g_cancellable_set_error_if_cancelled (GCancellable *cancellable,
62 int g_cancellable_get_fd (GCancellable *cancellable);
63 GCancellable *g_cancellable_get_current (void);
64 void g_push_current_cancellable (GCancellable *cancellable);
65 void g_pop_current_cancellable (GCancellable *cancellable);
66 void g_cancellable_reset (GCancellable *cancellable);
69 /* This is safe to call from another thread */
70 void g_cancellable_cancel (GCancellable *cancellable);
74 #endif /* __G_CANCELLABLE_H__ */