glib/gio/gioscheduler.h
Andrew Walton 5247f12f36 Bumps documentation to 93% symbol coverage, touching most
of the public files. Fixes broken function documentation prototypes. 
	Fixes GCancellable inaccuracies. Removes unnecessary incomplete 
	gtk-doc headers in private files.

svn path=/trunk/; revision=5953
2007-11-27 14:00:13 +00:00

77 lines
1.9 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>
*/
#ifndef __G_IO_SCHEDULER_H__
#define __G_IO_SCHEDULER_H__
#include <glib.h>
#include <gio/gcancellable.h>
G_BEGIN_DECLS
/**
* GIOJob:
*
* Opaque class for definining and scheduling IO jobs.
**/
typedef struct _GIOJob GIOJob;
/**
* GIOJobFunc:
* @job: a #GIOJob.
* @cancellable: optional #GCancellable object, %NULL to ignore.
* @user_data: the data to pass to callback function
*
* I/O Job function.
*
**/
typedef void (*GIOJobFunc) (GIOJob *job,
GCancellable *cancellable,
gpointer user_data);
/**
* GIODataFunc:
* @user_data:
*
* I/O Data function.
*
**/
typedef void (*GIODataFunc) (gpointer user_data);
void g_schedule_io_job (GIOJobFunc job_func,
gpointer user_data,
GDestroyNotify notify,
gint io_priority,
GCancellable *cancellable);
void g_cancel_all_io_jobs (void);
void g_io_job_send_to_mainloop (GIOJob *job,
GIODataFunc func,
gpointer user_data,
GDestroyNotify notify,
gboolean block);
G_END_DECLS
#endif /* __G_IO_SCHEDULER_H__ */