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