gio/gioscheduler.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   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.
   9  *
  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.
  14  *
  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.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  24 #error "Only <gio/gio.h> can be included directly."
  25 #endif
  26
  27 #ifndef __G_IO_SCHEDULER_H__
  28 #define __G_IO_SCHEDULER_H__
  29
  30 #include <glib.h>
  31 #include <gio/gcancellable.h>
  32
  33 G_BEGIN_DECLS
  34
  35 /**
  36  * GIOSchedulerJob:
  37  *
  38  * Opaque class for definining and scheduling IO jobs.
  39  **/
  40 typedef struct _GIOSchedulerJob GIOSchedulerJob;
  41
  42 /**
  43  * GIOSchedulerJobFunc:
  44  * @job: a #GIOSchedulerJob.
  45  * @cancellable: optional #GCancellable object, %NULL to ignore.
  46  * @user_data: the data to pass to callback function
  47  *
  48  * I/O Job function.
  49  *
  50  **/
  51 typedef void (*GIOSchedulerJobFunc) (GIOSchedulerJob *job,
  52                                      GCancellable *cancellable,
  53                                      gpointer user_data);
  54
  55 void     g_io_scheduler_push_job                   (GIOSchedulerJobFunc  job_func,
  56                                                     gpointer             user_data,
  57                                                     GDestroyNotify       notify,
  58                                                     gint                 io_priority,
  59                                                     GCancellable        *cancellable);
  60 void     g_io_scheduler_cancel_all_jobs            (void);
  61 gboolean g_io_scheduler_job_send_to_mainloop       (GIOSchedulerJob     *job,
  62                                                     GSourceFunc          func,
  63                                                     gpointer             user_data,
  64                                                     GDestroyNotify       notify);
  65 void     g_io_scheduler_job_send_to_mainloop_async (GIOSchedulerJob     *job,
  66                                                     GSourceFunc          func,
  67                                                     gpointer             user_data,
  68                                                     GDestroyNotify       notify);
  69
  70 G_END_DECLS
  71
  72 #endif /* __G_IO_SCHEDULER_H__ */