1/* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3 *
4 * SPDX-License-Identifier: LGPL-2.1-or-later
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
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_ASYNCQUEUE_H__
28#define __G_ASYNCQUEUE_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
36G_BEGIN_DECLS
37
38typedef struct _GAsyncQueue GAsyncQueue;
39
40GLIB_AVAILABLE_IN_ALL
41GAsyncQueue *g_async_queue_new (void);
42GLIB_AVAILABLE_IN_ALL
43GAsyncQueue *g_async_queue_new_full (GDestroyNotify item_free_func);
44GLIB_AVAILABLE_IN_ALL
45void g_async_queue_lock (GAsyncQueue *queue);
46GLIB_AVAILABLE_IN_ALL
47void g_async_queue_unlock (GAsyncQueue *queue);
48GLIB_AVAILABLE_IN_ALL
49GAsyncQueue *g_async_queue_ref (GAsyncQueue *queue);
50GLIB_AVAILABLE_IN_ALL
51void g_async_queue_unref (GAsyncQueue *queue);
52
53GLIB_DEPRECATED_FOR(g_async_queue_ref)
54void g_async_queue_ref_unlocked (GAsyncQueue *queue);
55
56GLIB_DEPRECATED_FOR(g_async_queue_unref)
57void g_async_queue_unref_and_unlock (GAsyncQueue *queue);
58
59GLIB_AVAILABLE_IN_ALL
60void g_async_queue_push (GAsyncQueue *queue,
61 gpointer data);
62GLIB_AVAILABLE_IN_ALL
63void g_async_queue_push_unlocked (GAsyncQueue *queue,
64 gpointer data);
65GLIB_AVAILABLE_IN_ALL
66void g_async_queue_push_sorted (GAsyncQueue *queue,
67 gpointer data,
68 GCompareDataFunc func,
69 gpointer user_data);
70GLIB_AVAILABLE_IN_ALL
71void g_async_queue_push_sorted_unlocked (GAsyncQueue *queue,
72 gpointer data,
73 GCompareDataFunc func,
74 gpointer user_data);
75GLIB_AVAILABLE_IN_ALL
76gpointer g_async_queue_pop (GAsyncQueue *queue);
77GLIB_AVAILABLE_IN_ALL
78gpointer g_async_queue_pop_unlocked (GAsyncQueue *queue);
79GLIB_AVAILABLE_IN_ALL
80gpointer g_async_queue_try_pop (GAsyncQueue *queue);
81GLIB_AVAILABLE_IN_ALL
82gpointer g_async_queue_try_pop_unlocked (GAsyncQueue *queue);
83GLIB_AVAILABLE_IN_ALL
84gpointer g_async_queue_timeout_pop (GAsyncQueue *queue,
85 guint64 timeout);
86GLIB_AVAILABLE_IN_ALL
87gpointer g_async_queue_timeout_pop_unlocked (GAsyncQueue *queue,
88 guint64 timeout);
89GLIB_AVAILABLE_IN_ALL
90gint g_async_queue_length (GAsyncQueue *queue);
91GLIB_AVAILABLE_IN_ALL
92gint g_async_queue_length_unlocked (GAsyncQueue *queue);
93GLIB_AVAILABLE_IN_ALL
94void g_async_queue_sort (GAsyncQueue *queue,
95 GCompareDataFunc func,
96 gpointer user_data);
97GLIB_AVAILABLE_IN_ALL
98void g_async_queue_sort_unlocked (GAsyncQueue *queue,
99 GCompareDataFunc func,
100 gpointer user_data);
101
102GLIB_AVAILABLE_IN_2_46
103gboolean g_async_queue_remove (GAsyncQueue *queue,
104 gpointer item);
105GLIB_AVAILABLE_IN_2_46
106gboolean g_async_queue_remove_unlocked (GAsyncQueue *queue,
107 gpointer item);
108GLIB_AVAILABLE_IN_2_46
109void g_async_queue_push_front (GAsyncQueue *queue,
110 gpointer item);
111GLIB_AVAILABLE_IN_2_46
112void g_async_queue_push_front_unlocked (GAsyncQueue *queue,
113 gpointer item);
114
115G_GNUC_BEGIN_IGNORE_DEPRECATIONS
116GLIB_DEPRECATED_FOR(g_async_queue_timeout_pop)
117gpointer g_async_queue_timed_pop (GAsyncQueue *queue,
118 GTimeVal *end_time);
119GLIB_DEPRECATED_FOR(g_async_queue_timeout_pop_unlocked)
120gpointer g_async_queue_timed_pop_unlocked (GAsyncQueue *queue,
121 GTimeVal *end_time);
122G_GNUC_END_IGNORE_DEPRECATIONS
123
124G_END_DECLS
125
126#endif /* __G_ASYNCQUEUE_H__ */
127