epoc32/include/stdapis/glib-2.0/glib/gthreadpool.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
--- a/epoc32/include/stdapis/glib-2.0/glib/gthreadpool.h	Tue Nov 24 13:55:44 2009 +0000
+++ b/epoc32/include/stdapis/glib-2.0/glib/gthreadpool.h	Tue Mar 16 16:12:26 2010 +0000
@@ -1,1 +1,113 @@
-gthreadpool.h
+/* GLIB - Library of useful routines for C programming
+ * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
+ * Portions copyright (c) 2006 Nokia Corporation.  All rights reserved.
+ *
+ * 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.
+ */
+
+/*
+ * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
+ * file for a list of people on the GLib Team.  See the ChangeLog
+ * files for a list of changes.  These files are distributed with
+ * GLib at ftp://ftp.gtk.org/pub/gtk/. 
+ */
+
+#ifndef __G_THREADPOOL_H__
+#define __G_THREADPOOL_H__
+
+#include <_ansi.h>
+#include <glib/gthread.h>
+
+G_BEGIN_DECLS
+
+typedef struct _GThreadPool     GThreadPool;
+
+/* Thread Pools
+ */
+
+/* The real GThreadPool is bigger, so you may only create a thread
+ * pool with the constructor function */
+struct _GThreadPool
+{
+  GFunc func;
+  gpointer user_data;
+  gboolean exclusive;
+};
+
+/* Get a thread pool with the function func, at most max_threads may
+ * run at a time (max_threads == -1 means no limit), exclusive == TRUE
+ * means, that the threads shouldn't be shared and that they will be
+ * prestarted (otherwise they are started as needed) user_data is the
+ * 2nd argument to the func */
+IMPORT_C GThreadPool*    g_thread_pool_new             (GFunc            func,
+                                               gpointer         user_data,
+                                               gint             max_threads,
+                                               gboolean         exclusive,
+                                               GError         **error);
+
+/* Push new data into the thread pool. This task is assigned to a thread later
+ * (when the maximal number of threads is reached for that pool) or now
+ * (otherwise). If necessary a new thread will be started. The function
+ * returns immediatly */
+IMPORT_C void            g_thread_pool_push            (GThreadPool     *pool,
+                                               gpointer         data,
+                                               GError         **error);
+
+/* Set the number of threads, which can run concurrently for that pool, -1
+ * means no limit. 0 means has the effect, that the pool won't process
+ * requests until the limit is set higher again */
+IMPORT_C void            g_thread_pool_set_max_threads (GThreadPool     *pool,
+                                               gint             max_threads,
+                                               GError         **error);
+IMPORT_C gint            g_thread_pool_get_max_threads (GThreadPool     *pool);
+
+/* Get the number of threads assigned to that pool. This number doesn't
+ * necessarily represent the number of working threads in that pool */
+IMPORT_C guint           g_thread_pool_get_num_threads (GThreadPool     *pool);
+
+/* Get the number of unprocessed items in the pool */
+IMPORT_C guint           g_thread_pool_unprocessed     (GThreadPool     *pool);
+
+/* Free the pool, immediate means, that all unprocessed items in the queue
+ * wont be processed, wait means, that the function doesn't return immediatly,
+ * but after all threads in the pool are ready processing items. immediate
+ * does however not mean, that threads are killed. */
+IMPORT_C void            g_thread_pool_free            (GThreadPool     *pool,
+                                               gboolean         immediate,
+                                               gboolean         wait);
+
+/* Set the maximal number of unused threads before threads will be stopped by
+ * GLib, -1 means no limit */
+IMPORT_C void            g_thread_pool_set_max_unused_threads (gint      max_threads);
+IMPORT_C gint            g_thread_pool_get_max_unused_threads (void);
+IMPORT_C guint           g_thread_pool_get_num_unused_threads (void);
+
+/* Stop all currently unused threads, but leave the limit untouched */
+IMPORT_C void            g_thread_pool_stop_unused_threads    (void);
+
+/* Set sort function for priority threading */
+IMPORT_C void            g_thread_pool_set_sort_function      (GThreadPool      *pool,
+		                                      GCompareDataFunc  func,
+						      gpointer          user_data);
+
+/* Set maximum time a thread can be idle in the pool before it is stopped */
+IMPORT_C void            g_thread_pool_set_max_idle_time      (guint             interval);
+IMPORT_C guint           g_thread_pool_get_max_idle_time      (void);
+
+G_END_DECLS
+
+#endif /* __G_THREADPOOL_H__ */
+