mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-11-05 00:46:16 +01:00
8228f7f94b
2008-01-25 Matthias Clasen <mclasen@redhat.com> * gioscheduler.h: Make GIOSchedulerJobFunc return boolean * gioscheduler.c: Keep calling io jobs until they return FALSE; this allows big jobs to be executed in chunks, instead of blocking the main loop for a long time. * gsimpleasyncresult.c: * giofile.c: Adapt callers. svn path=/trunk/; revision=6375
82 lines
2.7 KiB
C
82 lines
2.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_IO_SCHEDULER_H__
|
|
#define __G_IO_SCHEDULER_H__
|
|
|
|
#include <glib.h>
|
|
#include <gio/gcancellable.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/**
|
|
* GIOSchedulerJob:
|
|
*
|
|
* Opaque class for definining and scheduling IO jobs.
|
|
**/
|
|
typedef struct _GIOSchedulerJob GIOSchedulerJob;
|
|
|
|
/**
|
|
* GIOSchedulerJobFunc:
|
|
* @job: a #GIOSchedulerJob.
|
|
* @cancellable: optional #GCancellable object, %NULL to ignore.
|
|
* @user_data: the data to pass to callback function
|
|
*
|
|
* I/O Job function.
|
|
*
|
|
* Note that depending on whether threads are available, the
|
|
* #GIOScheduler may run jobs in separate threads or in an idle
|
|
* in the mainloop.
|
|
*
|
|
* Long-running jobs should periodically check the @cancellable
|
|
* to see if they have been cancelled.
|
|
*
|
|
* Returns: %TRUE if this function should be called again to
|
|
* complete the job, %FALSE if the job is complete (or cancelled)
|
|
**/
|
|
typedef gboolean (*GIOSchedulerJobFunc) (GIOSchedulerJob *job,
|
|
GCancellable *cancellable,
|
|
gpointer user_data);
|
|
|
|
void g_io_scheduler_push_job (GIOSchedulerJobFunc job_func,
|
|
gpointer user_data,
|
|
GDestroyNotify notify,
|
|
gint io_priority,
|
|
GCancellable *cancellable);
|
|
void g_io_scheduler_cancel_all_jobs (void);
|
|
gboolean g_io_scheduler_job_send_to_mainloop (GIOSchedulerJob *job,
|
|
GSourceFunc func,
|
|
gpointer user_data,
|
|
GDestroyNotify notify);
|
|
void g_io_scheduler_job_send_to_mainloop_async (GIOSchedulerJob *job,
|
|
GSourceFunc func,
|
|
gpointer user_data,
|
|
GDestroyNotify notify);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __G_IO_SCHEDULER_H__ */
|