glib-2.0/gio/gcancellable.h

0001 /* GIO - GLib Input, Output and Streaming Library
0002  *
0003  * Copyright (C) 2006-2007 Red Hat, Inc.
0004  *
0005  * SPDX-License-Identifier: LGPL-2.1-or-later
0006  *
0007  * This library is free software; you can redistribute it and/or
0008  * modify it under the terms of the GNU Lesser General Public
0009  * License as published by the Free Software Foundation; either
0010  * version 2.1 of the License, or (at your option) any later version.
0011  *
0012  * This library is distributed in the hope that it will be useful,
0013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0015  * Lesser General Public License for more details.
0016  *
0017  * You should have received a copy of the GNU Lesser General
0018  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
0019  *
0020  * Author: Alexander Larsson <alexl@redhat.com>
0021  */
0022
0023 #ifndef __G_CANCELLABLE_H__
0024 #define __G_CANCELLABLE_H__
0025
0026 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
0027 #error "Only <gio/gio.h> can be included directly."
0028 #endif
0029
0030 #include <gio/giotypes.h>
0031
0032 G_BEGIN_DECLS
0033
0034 #define G_TYPE_CANCELLABLE         (g_cancellable_get_type ())
0035 #define G_CANCELLABLE(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_CANCELLABLE, GCancellable))
0036 #define G_CANCELLABLE_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_CANCELLABLE, GCancellableClass))
0037 #define G_IS_CANCELLABLE(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_CANCELLABLE))
0038 #define G_IS_CANCELLABLE_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_CANCELLABLE))
0039 #define G_CANCELLABLE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_CANCELLABLE, GCancellableClass))
0040
0041 typedef struct _GCancellableClass   GCancellableClass;
0042 typedef struct _GCancellablePrivate GCancellablePrivate;
0043
0044 struct _GCancellable
0045 {
0046   GObject parent_instance;
0047
0048   /*< private >*/
0049   GCancellablePrivate *priv;
0050 };
0051
0052 struct _GCancellableClass
0053 {
0054   GObjectClass parent_class;
0055
0056   void (* cancelled) (GCancellable *cancellable);
0057
0058   /*< private >*/
0059   /* Padding for future expansion */
0060   void (*_g_reserved1) (void);
0061   void (*_g_reserved2) (void);
0062   void (*_g_reserved3) (void);
0063   void (*_g_reserved4) (void);
0064   void (*_g_reserved5) (void);
0065 };
0066
0067 GIO_AVAILABLE_IN_ALL
0068 GType         g_cancellable_get_type               (void) G_GNUC_CONST;
0069
0070 GIO_AVAILABLE_IN_ALL
0071 GCancellable *g_cancellable_new                    (void);
0072
0073 /* These are only safe to call inside a cancellable op */
0074 GIO_AVAILABLE_IN_ALL
0075 gboolean      g_cancellable_is_cancelled           (GCancellable  *cancellable);
0076 GIO_AVAILABLE_IN_ALL
0077 gboolean      g_cancellable_set_error_if_cancelled (GCancellable  *cancellable,
0078                             GError       **error);
0079
0080 GIO_AVAILABLE_IN_ALL
0081 int           g_cancellable_get_fd                 (GCancellable  *cancellable);
0082 GIO_AVAILABLE_IN_ALL
0083 gboolean      g_cancellable_make_pollfd            (GCancellable  *cancellable,
0084                             GPollFD       *pollfd);
0085 GIO_AVAILABLE_IN_ALL
0086 void          g_cancellable_release_fd             (GCancellable  *cancellable);
0087
0088 GIO_AVAILABLE_IN_ALL
0089 GSource *     g_cancellable_source_new             (GCancellable  *cancellable);
0090
0091 GIO_AVAILABLE_IN_ALL
0092 GCancellable *g_cancellable_get_current            (void);
0093 GIO_AVAILABLE_IN_ALL
0094 void          g_cancellable_push_current           (GCancellable  *cancellable);
0095 GIO_AVAILABLE_IN_ALL
0096 void          g_cancellable_pop_current            (GCancellable  *cancellable);
0097 GIO_AVAILABLE_IN_ALL
0098 void          g_cancellable_reset                  (GCancellable  *cancellable);
0099 GIO_AVAILABLE_IN_ALL
0100 gulong        g_cancellable_connect                (GCancellable  *cancellable,
0101                             GCallback      callback,
0102                             gpointer       data,
0103                             GDestroyNotify data_destroy_func);
0104 GIO_AVAILABLE_IN_ALL
0105 void          g_cancellable_disconnect             (GCancellable  *cancellable,
0106                             gulong         handler_id);
0107
0108
0109 /* This is safe to call from another thread */
0110 GIO_AVAILABLE_IN_ALL
0111 void          g_cancellable_cancel       (GCancellable  *cancellable);
0112
0113 G_END_DECLS
0114
0115 #endif /* __G_CANCELLABLE_H__ */