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.1 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, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /*
  19  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  20  * file for a list of people on the GLib Team.  See the ChangeLog
  21  * files for a list of changes.  These files are distributed with
  22  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  23  */
  24
  25 #ifndef __G_THREADPOOL_H__
  26 #define __G_THREADPOOL_H__
  27
  28 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  29 #error "Only <glib.h> can be included directly."
  30 #endif
  31
  32 #include <glib/gthread.h>
  33
  34 G_BEGIN_DECLS
  35
  36 typedef struct _GThreadPool GThreadPool;
  37
  38 /* Thread Pools
  39  */
  40
  41 struct _GThreadPool
  42 {
  43   GFunc func;
  44   gpointer user_data;
  45   gboolean exclusive;
  46 };
  47
  48 GLIB_AVAILABLE_IN_ALL
  49 GThreadPool *   g_thread_pool_new               (GFunc            func,
  50                                                  gpointer         user_data,
  51                                                  gint             max_threads,
  52                                                  gboolean         exclusive,
  53                                                  GError         **error);
  54 GLIB_AVAILABLE_IN_ALL
  55 void            g_thread_pool_free              (GThreadPool     *pool,
  56                                                  gboolean         immediate,
  57                                                  gboolean         wait_);
  58 GLIB_AVAILABLE_IN_ALL
  59 gboolean        g_thread_pool_push              (GThreadPool     *pool,
  60                                                  gpointer         data,
  61                                                  GError         **error);
  62 GLIB_AVAILABLE_IN_ALL
  63 guint           g_thread_pool_unprocessed       (GThreadPool     *pool);
  64 GLIB_AVAILABLE_IN_ALL
  65 void            g_thread_pool_set_sort_function (GThreadPool      *pool,
  66                                                  GCompareDataFunc  func,
  67                                                  gpointer          user_data);
  68 GLIB_AVAILABLE_IN_2_46
  69 gboolean        g_thread_pool_move_to_front     (GThreadPool      *pool,
  70                                                  gpointer          data);
  71
  72 GLIB_AVAILABLE_IN_ALL
  73 gboolean        g_thread_pool_set_max_threads   (GThreadPool     *pool,
  74                                                  gint             max_threads,
  75                                                  GError         **error);
  76 GLIB_AVAILABLE_IN_ALL
  77 gint            g_thread_pool_get_max_threads   (GThreadPool     *pool);
  78 GLIB_AVAILABLE_IN_ALL
  79 guint           g_thread_pool_get_num_threads   (GThreadPool     *pool);
  80
  81 GLIB_AVAILABLE_IN_ALL
  82 void            g_thread_pool_set_max_unused_threads (gint  max_threads);
  83 GLIB_AVAILABLE_IN_ALL
  84 gint            g_thread_pool_get_max_unused_threads (void);
  85 GLIB_AVAILABLE_IN_ALL
  86 guint           g_thread_pool_get_num_unused_threads (void);
  87 GLIB_AVAILABLE_IN_ALL
  88 void            g_thread_pool_stop_unused_threads    (void);
  89 GLIB_AVAILABLE_IN_ALL
  90 void            g_thread_pool_set_max_idle_time      (guint interval);
  91 GLIB_AVAILABLE_IN_ALL
  92 guint           g_thread_pool_get_max_idle_time      (void);
  93
  94 G_END_DECLS
  95
  96 #endif /* __G_THREADPOOL_H__ */