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 #ifndef __G_IO_SCHEDULER_H__
  24 #define __G_IO_SCHEDULER_H__
  25
  26 #include <glib.h>
  27 #include <gio/gcancellable.h>
  28
  29 G_BEGIN_DECLS
  30
  31 /**
  32  * GIOJob:
  33  *
  34  * Opaque class for definining and scheduling IO jobs.
  35  **/
  36 typedef struct _GIOJob GIOJob;
  37
  38 /**
  39  * GIOJobFunc:
  40  * @job: a #GIOJob.
  41  * @cancellable: optional #GCancellable object, %NULL to ignore.
  42  * @user_data: the data to pass to callback function
  43  *
  44  * I/O Job function.
  45  *
  46  **/
  47 typedef void (*GIOJobFunc) (GIOJob *job,
  48                             GCancellable *cancellable,
  49                             gpointer user_data);
  50
  51 /**
  52  * GIODataFunc:
  53  * @user_data: data to pass to the I/O function.
  54  *
  55  * I/O Data function.
  56  *
  57  **/
  58 typedef void (*GIODataFunc) (gpointer user_data);
  59
  60 void g_schedule_io_job         (GIOJobFunc      job_func,
  61                                 gpointer        user_data,
  62                                 GDestroyNotify  notify,
  63                                 gint            io_priority,
  64                                 GCancellable   *cancellable);
  65 void g_cancel_all_io_jobs      (void);
  66
  67 void g_io_job_send_to_mainloop (GIOJob         *job,
  68                                 GIODataFunc     func,
  69                                 gpointer        user_data,
  70                                 GDestroyNotify  notify,
  71                                 gboolean        block);
  72
  73
  74 G_END_DECLS
  75
  76 #endif /* __G_IO_SCHEDULER_H__ */