1/* GIO - GLib Input, Output and Streaming Library
2 *
3 * Copyright (C) 2006-2007 Red Hat, Inc.
4 *
5 * SPDX-License-Identifier: LGPL-2.1-or-later
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General
18 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
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
32G_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
41typedef struct _GCancellableClass GCancellableClass;
42typedef struct _GCancellablePrivate GCancellablePrivate;
43
44struct _GCancellable
45{
46 GObject parent_instance;
47
48 /*< private >*/
49 GCancellablePrivate *priv;
50};
51
52struct _GCancellableClass
53{
54 GObjectClass parent_class;
55
56 void (* cancelled) (GCancellable *cancellable);
57
58 /*< private >*/
59 /* Padding for future expansion */
60 void (*_g_reserved1) (void);
61 void (*_g_reserved2) (void);
62 void (*_g_reserved3) (void);
63 void (*_g_reserved4) (void);
64 void (*_g_reserved5) (void);
65};
66
67GIO_AVAILABLE_IN_ALL
68GType g_cancellable_get_type (void) G_GNUC_CONST;
69
70GIO_AVAILABLE_IN_ALL
71GCancellable *g_cancellable_new (void);
72
73/* These are only safe to call inside a cancellable op */
74GIO_AVAILABLE_IN_ALL
75gboolean g_cancellable_is_cancelled (GCancellable *cancellable);
76GIO_AVAILABLE_IN_ALL
77gboolean g_cancellable_set_error_if_cancelled (GCancellable *cancellable,
78 GError **error);
79
80GIO_AVAILABLE_IN_ALL
81int g_cancellable_get_fd (GCancellable *cancellable);
82GIO_AVAILABLE_IN_ALL
83gboolean g_cancellable_make_pollfd (GCancellable *cancellable,
84 GPollFD *pollfd);
85GIO_AVAILABLE_IN_ALL
86void g_cancellable_release_fd (GCancellable *cancellable);
87
88GIO_AVAILABLE_IN_ALL
89GSource * g_cancellable_source_new (GCancellable *cancellable);
90
91GIO_AVAILABLE_IN_ALL
92GCancellable *g_cancellable_get_current (void);
93GIO_AVAILABLE_IN_ALL
94void g_cancellable_push_current (GCancellable *cancellable);
95GIO_AVAILABLE_IN_ALL
96void g_cancellable_pop_current (GCancellable *cancellable);
97GIO_AVAILABLE_IN_ALL
98void g_cancellable_reset (GCancellable *cancellable);
99GIO_AVAILABLE_IN_ALL
100gulong g_cancellable_connect (GCancellable *cancellable,
101 GCallback callback,
102 gpointer data,
103 GDestroyNotify data_destroy_func);
104GIO_AVAILABLE_IN_ALL
105void g_cancellable_disconnect (GCancellable *cancellable,
106 gulong handler_id);
107
108
109/* This is safe to call from another thread */
110GIO_AVAILABLE_IN_ALL
111void g_cancellable_cancel (GCancellable *cancellable);
112
113G_END_DECLS
114
115#endif /* __G_CANCELLABLE_H__ */
116