*
* 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
+ * 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.
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
*/
/*
* GLib at ftp://ftp.gtk.org/pub/gtk/.
*/
-#if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
-#error "Only <glib.h> can be included directly."
-#endif
-
#ifndef __G_THREADPOOL_H__
#define __G_THREADPOOL_H__
+#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
+#error "Only <glib.h> can be included directly."
+#endif
+
#include <glib/gthread.h>
G_BEGIN_DECLS
-typedef struct _GThreadPool GThreadPool;
+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;
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 */
-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 */
-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 */
-void g_thread_pool_set_max_threads (GThreadPool *pool,
- gint max_threads,
- GError **error);
-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 */
-guint g_thread_pool_get_num_threads (GThreadPool *pool);
-
-/* Get the number of unprocessed items in the pool */
-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. */
-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 */
-void g_thread_pool_set_max_unused_threads (gint max_threads);
+GLIB_AVAILABLE_IN_ALL
+GThreadPool * g_thread_pool_new (GFunc func,
+ gpointer user_data,
+ gint max_threads,
+ gboolean exclusive,
+ GError **error);
+GLIB_AVAILABLE_IN_ALL
+void g_thread_pool_free (GThreadPool *pool,
+ gboolean immediate,
+ gboolean wait_);
+GLIB_AVAILABLE_IN_ALL
+gboolean g_thread_pool_push (GThreadPool *pool,
+ gpointer data,
+ GError **error);
+GLIB_AVAILABLE_IN_ALL
+guint g_thread_pool_unprocessed (GThreadPool *pool);
+GLIB_AVAILABLE_IN_ALL
+void g_thread_pool_set_sort_function (GThreadPool *pool,
+ GCompareDataFunc func,
+ gpointer user_data);
+GLIB_AVAILABLE_IN_ALL
+gboolean g_thread_pool_set_max_threads (GThreadPool *pool,
+ gint max_threads,
+ GError **error);
+GLIB_AVAILABLE_IN_ALL
+gint g_thread_pool_get_max_threads (GThreadPool *pool);
+GLIB_AVAILABLE_IN_ALL
+guint g_thread_pool_get_num_threads (GThreadPool *pool);
+
+GLIB_AVAILABLE_IN_ALL
+void g_thread_pool_set_max_unused_threads (gint max_threads);
+GLIB_AVAILABLE_IN_ALL
gint g_thread_pool_get_max_unused_threads (void);
+GLIB_AVAILABLE_IN_ALL
guint g_thread_pool_get_num_unused_threads (void);
-
-/* Stop all currently unused threads, but leave the limit untouched */
+GLIB_AVAILABLE_IN_ALL
void g_thread_pool_stop_unused_threads (void);
-
-/* Set sort function for priority threading */
-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 */
-void g_thread_pool_set_max_idle_time (guint interval);
+GLIB_AVAILABLE_IN_ALL
+void g_thread_pool_set_max_idle_time (guint interval);
+GLIB_AVAILABLE_IN_ALL
guint g_thread_pool_get_max_idle_time (void);
G_END_DECLS
projects / platform / upstream / glib.git / blobdiff