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_IO_SCHEDULER_H__
28 #define __G_IO_SCHEDULER_H__
31 #include <gio/gcancellable.h>
38 * Opaque class for definining and scheduling IO jobs.
40 typedef struct _GIOSchedulerJob GIOSchedulerJob;
43 * GIOSchedulerJobFunc:
44 * @job: a #GIOSchedulerJob.
45 * @cancellable: optional #GCancellable object, %NULL to ignore.
46 * @user_data: the data to pass to callback function
50 * Note that depending on whether threads are available, the
51 * #GIOScheduler may run jobs in separate threads or in an idle
54 * Long-running jobs should periodically check the @cancellable
55 * to see if they have been cancelled.
57 * Returns: %TRUE if this function should be called again to
58 * complete the job, %FALSE if the job is complete (or cancelled)
60 typedef gboolean (*GIOSchedulerJobFunc) (GIOSchedulerJob *job,
61 GCancellable *cancellable,
64 void g_io_scheduler_push_job (GIOSchedulerJobFunc job_func,
66 GDestroyNotify notify,
68 GCancellable *cancellable);
69 void g_io_scheduler_cancel_all_jobs (void);
70 gboolean g_io_scheduler_job_send_to_mainloop (GIOSchedulerJob *job,
73 GDestroyNotify notify);
74 void g_io_scheduler_job_send_to_mainloop_async (GIOSchedulerJob *job,
77 GDestroyNotify notify);
81 #endif /* __G_IO_SCHEDULER_H__ */