glib/gthreadpool.h

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GLib Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #ifndef __G_THREADPOOL_H__
  28 #define __G_THREADPOOL_H__
  29
  30 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  31 #error "Only <glib.h> can be included directly."
  32 #endif
  33
  34 #include <glib/gthread.h>
  35
  36 G_BEGIN_DECLS
  37
  38 typedef struct _GThreadPool GThreadPool;
  39
  40 /* Thread Pools
  41  */
  42
  43 struct _GThreadPool
  44 {
  45   GFunc func;
  46   gpointer user_data;
  47   gboolean exclusive;
  48 };
  49
  50 GLIB_AVAILABLE_IN_ALL
  51 GThreadPool *   g_thread_pool_new               (GFunc            func,
  52                                                  gpointer         user_data,
  53                                                  gint             max_threads,
  54                                                  gboolean         exclusive,
  55                                                  GError         **error);
  56 GLIB_AVAILABLE_IN_ALL
  57 void            g_thread_pool_free              (GThreadPool     *pool,
  58                                                  gboolean         immediate,
  59                                                  gboolean         wait_);
  60 GLIB_AVAILABLE_IN_ALL
  61 gboolean        g_thread_pool_push              (GThreadPool     *pool,
  62                                                  gpointer         data,
  63                                                  GError         **error);
  64 GLIB_AVAILABLE_IN_ALL
  65 guint           g_thread_pool_unprocessed       (GThreadPool     *pool);
  66 GLIB_AVAILABLE_IN_ALL
  67 void            g_thread_pool_set_sort_function (GThreadPool      *pool,
  68                                                  GCompareDataFunc  func,
  69                                                  gpointer          user_data);
  70 GLIB_AVAILABLE_IN_ALL
  71 gboolean        g_thread_pool_set_max_threads   (GThreadPool     *pool,
  72                                                  gint             max_threads,
  73                                                  GError         **error);
  74 GLIB_AVAILABLE_IN_ALL
  75 gint            g_thread_pool_get_max_threads   (GThreadPool     *pool);
  76 GLIB_AVAILABLE_IN_ALL
  77 guint           g_thread_pool_get_num_threads   (GThreadPool     *pool);
  78
  79 GLIB_AVAILABLE_IN_ALL
  80 void            g_thread_pool_set_max_unused_threads (gint  max_threads);
  81 GLIB_AVAILABLE_IN_ALL
  82 gint            g_thread_pool_get_max_unused_threads (void);
  83 GLIB_AVAILABLE_IN_ALL
  84 guint           g_thread_pool_get_num_unused_threads (void);
  85 GLIB_AVAILABLE_IN_ALL
  86 void            g_thread_pool_stop_unused_threads    (void);
  87 GLIB_AVAILABLE_IN_ALL
  88 void            g_thread_pool_set_max_idle_time      (guint interval);
  89 GLIB_AVAILABLE_IN_ALL
  90 guint           g_thread_pool_get_max_idle_time      (void);
  91
  92 G_END_DECLS
  93
  94 #endif /* __G_THREADPOOL_H__ */