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 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
24 #error "Only <gio/gio.h> can be included directly."
27 #ifndef __G_CANCELLABLE_H__
28 #define __G_CANCELLABLE_H__
30 #include <gio/giotypes.h>
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))
44 * Allows actions to be cancelled.
46 typedef struct _GCancellableClass GCancellableClass
;
47 typedef struct _GCancellablePrivate GCancellablePrivate
;
51 GObject parent_instance
;
54 GCancellablePrivate
*priv
;
57 struct _GCancellableClass
59 GObjectClass parent_class
;
61 void (* cancelled
) (GCancellable
*cancellable
);
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);
72 GType
g_cancellable_get_type (void) G_GNUC_CONST
;
74 GCancellable
*g_cancellable_new (void);
76 /* These are only safe to call inside a cancellable op */
77 gboolean
g_cancellable_is_cancelled (GCancellable
*cancellable
);
78 gboolean
g_cancellable_set_error_if_cancelled (GCancellable
*cancellable
,
81 int g_cancellable_get_fd (GCancellable
*cancellable
);
82 gboolean
g_cancellable_make_pollfd (GCancellable
*cancellable
,
84 void g_cancellable_release_fd (GCancellable
*cancellable
);
86 GSource
* g_cancellable_source_new (GCancellable
*cancellable
);
88 GCancellable
*g_cancellable_get_current (void);
89 void g_cancellable_push_current (GCancellable
*cancellable
);
90 void g_cancellable_pop_current (GCancellable
*cancellable
);
91 void g_cancellable_reset (GCancellable
*cancellable
);
92 gulong
g_cancellable_connect (GCancellable
*cancellable
,
95 GDestroyNotify data_destroy_func
);
96 void g_cancellable_disconnect (GCancellable
*cancellable
,
100 /* This is safe to call from another thread */
101 void g_cancellable_cancel (GCancellable
*cancellable
);
105 #endif /* __G_CANCELLABLE_H__ */