mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-11-04 01:58:54 +01:00
6181c7de36
g_cancellable_create_source() returns a GSource that triggers when its corresponding GCancellable is cancelled. This can be used with g_source_add_child_source() to add cancellability to a source. Port gasynchelper's FDSource to use this rather than doing its own cancellable handling, and also fix up its callback argument order to be more normal. https://bugzilla.gnome.org/show_bug.cgi?id=634239
106 lines
3.7 KiB
C
106 lines
3.7 KiB
C
/* GIO - GLib Input, Output and Streaming Library
|
|
*
|
|
* Copyright (C) 2006-2007 Red Hat, Inc.
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General
|
|
* Public License along with this library; if not, write to the
|
|
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
|
|
* Boston, MA 02111-1307, USA.
|
|
*
|
|
* Author: Alexander Larsson <alexl@redhat.com>
|
|
*/
|
|
|
|
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
|
|
#error "Only <gio/gio.h> can be included directly."
|
|
#endif
|
|
|
|
#ifndef __G_CANCELLABLE_H__
|
|
#define __G_CANCELLABLE_H__
|
|
|
|
#include <gio/giotypes.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define G_TYPE_CANCELLABLE (g_cancellable_get_type ())
|
|
#define G_CANCELLABLE(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_CANCELLABLE, GCancellable))
|
|
#define G_CANCELLABLE_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_CANCELLABLE, GCancellableClass))
|
|
#define G_IS_CANCELLABLE(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_CANCELLABLE))
|
|
#define G_IS_CANCELLABLE_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_CANCELLABLE))
|
|
#define G_CANCELLABLE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_CANCELLABLE, GCancellableClass))
|
|
|
|
/**
|
|
* GCancellable:
|
|
*
|
|
* Allows actions to be cancelled.
|
|
*/
|
|
typedef struct _GCancellableClass GCancellableClass;
|
|
typedef struct _GCancellablePrivate GCancellablePrivate;
|
|
|
|
struct _GCancellable
|
|
{
|
|
GObject parent_instance;
|
|
|
|
/*< private >*/
|
|
GCancellablePrivate *priv;
|
|
};
|
|
|
|
struct _GCancellableClass
|
|
{
|
|
GObjectClass parent_class;
|
|
|
|
void (* cancelled) (GCancellable *cancellable);
|
|
|
|
/*< private >*/
|
|
/* Padding for future expansion */
|
|
void (*_g_reserved1) (void);
|
|
void (*_g_reserved2) (void);
|
|
void (*_g_reserved3) (void);
|
|
void (*_g_reserved4) (void);
|
|
void (*_g_reserved5) (void);
|
|
};
|
|
|
|
GType g_cancellable_get_type (void) G_GNUC_CONST;
|
|
|
|
GCancellable *g_cancellable_new (void);
|
|
|
|
/* These are only safe to call inside a cancellable op */
|
|
gboolean g_cancellable_is_cancelled (GCancellable *cancellable);
|
|
gboolean g_cancellable_set_error_if_cancelled (GCancellable *cancellable,
|
|
GError **error);
|
|
|
|
int g_cancellable_get_fd (GCancellable *cancellable);
|
|
gboolean g_cancellable_make_pollfd (GCancellable *cancellable,
|
|
GPollFD *pollfd);
|
|
void g_cancellable_release_fd (GCancellable *cancellable);
|
|
|
|
GSource * g_cancellable_source_new (GCancellable *cancellable);
|
|
|
|
GCancellable *g_cancellable_get_current (void);
|
|
void g_cancellable_push_current (GCancellable *cancellable);
|
|
void g_cancellable_pop_current (GCancellable *cancellable);
|
|
void g_cancellable_reset (GCancellable *cancellable);
|
|
gulong g_cancellable_connect (GCancellable *cancellable,
|
|
GCallback callback,
|
|
gpointer data,
|
|
GDestroyNotify data_destroy_func);
|
|
void g_cancellable_disconnect (GCancellable *cancellable,
|
|
gulong handler_id);
|
|
|
|
|
|
/* This is safe to call from another thread */
|
|
void g_cancellable_cancel (GCancellable *cancellable);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __G_CANCELLABLE_H__ */
|