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, 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_ASYNCQUEUE_H__
26#define __G_ASYNCQUEUE_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
34G_BEGIN_DECLS
35
36typedef struct _GAsyncQueue GAsyncQueue;
37
38GLIB_AVAILABLE_IN_ALL
39GAsyncQueue *g_async_queue_new (void);
40GLIB_AVAILABLE_IN_ALL
41GAsyncQueue *g_async_queue_new_full (GDestroyNotify item_free_func);
42GLIB_AVAILABLE_IN_ALL
43void g_async_queue_lock (GAsyncQueue *queue);
44GLIB_AVAILABLE_IN_ALL
45void g_async_queue_unlock (GAsyncQueue *queue);
46GLIB_AVAILABLE_IN_ALL
47GAsyncQueue *g_async_queue_ref (GAsyncQueue *queue);
48GLIB_AVAILABLE_IN_ALL
49void g_async_queue_unref (GAsyncQueue *queue);
50
51GLIB_DEPRECATED_FOR(g_async_queue_ref)
52void g_async_queue_ref_unlocked (GAsyncQueue *queue);
53
54GLIB_DEPRECATED_FOR(g_async_queue_unref)
55void g_async_queue_unref_and_unlock (GAsyncQueue *queue);
56
57GLIB_AVAILABLE_IN_ALL
58void g_async_queue_push (GAsyncQueue *queue,
59 gpointer data);
60GLIB_AVAILABLE_IN_ALL
61void g_async_queue_push_unlocked (GAsyncQueue *queue,
62 gpointer data);
63GLIB_AVAILABLE_IN_ALL
64void g_async_queue_push_sorted (GAsyncQueue *queue,
65 gpointer data,
66 GCompareDataFunc func,
67 gpointer user_data);
68GLIB_AVAILABLE_IN_ALL
69void g_async_queue_push_sorted_unlocked (GAsyncQueue *queue,
70 gpointer data,
71 GCompareDataFunc func,
72 gpointer user_data);
73GLIB_AVAILABLE_IN_ALL
74gpointer g_async_queue_pop (GAsyncQueue *queue);
75GLIB_AVAILABLE_IN_ALL
76gpointer g_async_queue_pop_unlocked (GAsyncQueue *queue);
77GLIB_AVAILABLE_IN_ALL
78gpointer g_async_queue_try_pop (GAsyncQueue *queue);
79GLIB_AVAILABLE_IN_ALL
80gpointer g_async_queue_try_pop_unlocked (GAsyncQueue *queue);
81GLIB_AVAILABLE_IN_ALL
82gpointer g_async_queue_timeout_pop (GAsyncQueue *queue,
83 guint64 timeout);
84GLIB_AVAILABLE_IN_ALL
85gpointer g_async_queue_timeout_pop_unlocked (GAsyncQueue *queue,
86 guint64 timeout);
87GLIB_AVAILABLE_IN_ALL
88gint g_async_queue_length (GAsyncQueue *queue);
89GLIB_AVAILABLE_IN_ALL
90gint g_async_queue_length_unlocked (GAsyncQueue *queue);
91GLIB_AVAILABLE_IN_ALL
92void g_async_queue_sort (GAsyncQueue *queue,
93 GCompareDataFunc func,
94 gpointer user_data);
95GLIB_AVAILABLE_IN_ALL
96void g_async_queue_sort_unlocked (GAsyncQueue *queue,
97 GCompareDataFunc func,
98 gpointer user_data);
99
100GLIB_AVAILABLE_IN_2_46
101gboolean g_async_queue_remove (GAsyncQueue *queue,
102 gpointer item);
103GLIB_AVAILABLE_IN_2_46
104gboolean g_async_queue_remove_unlocked (GAsyncQueue *queue,
105 gpointer item);
106GLIB_AVAILABLE_IN_2_46
107void g_async_queue_push_front (GAsyncQueue *queue,
108 gpointer item);
109GLIB_AVAILABLE_IN_2_46
110void g_async_queue_push_front_unlocked (GAsyncQueue *queue,
111 gpointer item);
112
113GLIB_DEPRECATED_FOR(g_async_queue_timeout_pop)
114gpointer g_async_queue_timed_pop (GAsyncQueue *queue,
115 GTimeVal *end_time);
116GLIB_DEPRECATED_FOR(g_async_queue_timeout_pop_unlocked)
117gpointer g_async_queue_timed_pop_unlocked (GAsyncQueue *queue,
118 GTimeVal *end_time);
119
120G_END_DECLS
121
122#endif /* __G_ASYNCQUEUE_H__ */
123