1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * GAsyncQueue: asynchronous queue implementation, based on Gqueue.
5 * Copyright (C) 2000 Sebastian Wilhelmi; University of Karlsruhe
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
38 guint waiting_threads;
43 GCompareDataFunc func;
50 * Creates a new asynchronous queue with the initial reference count of 1.
52 * Return value: the new #GAsyncQueue.
55 g_async_queue_new (void)
57 GAsyncQueue* retval = g_new (GAsyncQueue, 1);
58 retval->mutex = g_mutex_new ();
60 retval->queue = g_queue_new ();
61 retval->waiting_threads = 0;
62 retval->ref_count = 1;
68 * @queue: a #GAsyncQueue.
70 * Increases the reference count of the asynchronous @queue by 1. You
71 * do not need to hold the lock to call this function.
73 * Returns: the @queue that was passed in (since 2.6)
76 g_async_queue_ref (GAsyncQueue *queue)
78 g_return_val_if_fail (queue, NULL);
79 g_return_val_if_fail (g_atomic_int_get (&queue->ref_count) > 0, NULL);
81 g_atomic_int_inc (&queue->ref_count);
87 * g_async_queue_ref_unlocked:
88 * @queue: a #GAsyncQueue.
90 * Increases the reference count of the asynchronous @queue by 1.
92 * @Deprecated: Since 2.8, reference counting is done atomically
93 * so g_async_queue_ref() can be used regardless of the @queue's
97 g_async_queue_ref_unlocked (GAsyncQueue *queue)
99 g_return_if_fail (queue);
100 g_return_if_fail (g_atomic_int_get (&queue->ref_count) > 0);
102 g_atomic_int_inc (&queue->ref_count);
106 * g_async_queue_unref_and_unlock:
107 * @queue: a #GAsyncQueue.
109 * Decreases the reference count of the asynchronous @queue by 1 and
110 * releases the lock. This function must be called while holding the
111 * @queue's lock. If the reference count went to 0, the @queue will be
112 * destroyed and the memory allocated will be freed.
114 * @Deprecated: Since 2.8, reference counting is done atomically
115 * so g_async_queue_unref() can be used regardless of the @queue's
119 g_async_queue_unref_and_unlock (GAsyncQueue *queue)
121 g_return_if_fail (queue);
122 g_return_if_fail (g_atomic_int_get (&queue->ref_count) > 0);
124 g_mutex_unlock (queue->mutex);
125 g_async_queue_unref (queue);
129 * g_async_queue_unref:
130 * @queue: a #GAsyncQueue.
132 * Decreases the reference count of the asynchronous @queue by 1. If
133 * the reference count went to 0, the @queue will be destroyed and the
134 * memory allocated will be freed. So you are not allowed to use the
135 * @queue afterwards, as it might have disappeared. You do not need to
136 * hold the lock to call this function.
139 g_async_queue_unref (GAsyncQueue *queue)
141 g_return_if_fail (queue);
142 g_return_if_fail (g_atomic_int_get (&queue->ref_count) > 0);
144 if (g_atomic_int_dec_and_test (&queue->ref_count))
146 g_return_if_fail (queue->waiting_threads == 0);
147 g_mutex_free (queue->mutex);
149 g_cond_free (queue->cond);
150 g_queue_free (queue->queue);
156 * g_async_queue_lock:
157 * @queue: a #GAsyncQueue.
159 * Acquires the @queue's lock. After that you can only call the
160 * <function>g_async_queue_*_unlocked()</function> function variants on that
161 * @queue. Otherwise it will deadlock.
164 g_async_queue_lock (GAsyncQueue *queue)
166 g_return_if_fail (queue);
167 g_return_if_fail (g_atomic_int_get (&queue->ref_count) > 0);
169 g_mutex_lock (queue->mutex);
173 * g_async_queue_unlock:
174 * @queue: a #GAsyncQueue.
176 * Releases the queue's lock.
179 g_async_queue_unlock (GAsyncQueue *queue)
181 g_return_if_fail (queue);
182 g_return_if_fail (g_atomic_int_get (&queue->ref_count) > 0);
184 g_mutex_unlock (queue->mutex);
188 * g_async_queue_push:
189 * @queue: a #GAsyncQueue.
190 * @data: @data to push into the @queue.
192 * Pushes the @data into the @queue. @data must not be %NULL.
195 g_async_queue_push (GAsyncQueue* queue, gpointer data)
197 g_return_if_fail (queue);
198 g_return_if_fail (g_atomic_int_get (&queue->ref_count) > 0);
199 g_return_if_fail (data);
201 g_mutex_lock (queue->mutex);
202 g_async_queue_push_unlocked (queue, data);
203 g_mutex_unlock (queue->mutex);
207 * g_async_queue_push_unlocked:
208 * @queue: a #GAsyncQueue.
209 * @data: @data to push into the @queue.
211 * Pushes the @data into the @queue. @data must not be %NULL. This
212 * function must be called while holding the @queue's lock.
215 g_async_queue_push_unlocked (GAsyncQueue* queue, gpointer data)
217 g_return_if_fail (queue);
218 g_return_if_fail (g_atomic_int_get (&queue->ref_count) > 0);
219 g_return_if_fail (data);
221 g_queue_push_head (queue->queue, data);
222 if (queue->waiting_threads > 0)
223 g_cond_signal (queue->cond);
227 * g_async_queue_push_sorted:
228 * @queue: a #GAsyncQueue
229 * @data: the @data to push into the @queue
230 * @func: the #GCompareDataFunc is used to sort @queue. This function
231 * is passed two elements of the @queue. The function should return
232 * 0 if they are equal, a negative value if the first element
233 * should be higher in the @queue or a positive value if the first
234 * element should be lower in the @queue than the second element.
235 * @user_data: user data passed to @func.
237 * Inserts @data into @queue using @func to determine the new
240 * This function requires that the @queue is sorted before pushing on
243 * This function will lock @queue before it sorts the queue and unlock
244 * it when it is finished.
246 * For an example of @func see g_async_queue_sort().
251 g_async_queue_push_sorted (GAsyncQueue *queue,
253 GCompareDataFunc func,
256 g_return_if_fail (queue != NULL);
258 g_mutex_lock (queue->mutex);
259 g_async_queue_push_sorted_unlocked (queue, data, func, user_data);
260 g_mutex_unlock (queue->mutex);
264 g_async_queue_invert_compare (gpointer v1,
268 return -sd->func (v1, v2, sd->user_data);
272 * g_async_queue_push_sorted_unlocked:
273 * @queue: a #GAsyncQueue
274 * @data: the @data to push into the @queue
275 * @func: the #GCompareDataFunc is used to sort @queue. This function
276 * is passed two elements of the @queue. The function should return
277 * 0 if they are equal, a negative value if the first element
278 * should be higher in the @queue or a positive value if the first
279 * element should be lower in the @queue than the second element.
280 * @user_data: user data passed to @func.
282 * Inserts @data into @queue using @func to determine the new
285 * This function requires that the @queue is sorted before pushing on
288 * This function is called while holding the @queue's lock.
290 * For an example of @func see g_async_queue_sort().
295 g_async_queue_push_sorted_unlocked (GAsyncQueue *queue,
297 GCompareDataFunc func,
302 g_return_if_fail (queue != NULL);
305 sd.user_data = user_data;
307 g_queue_insert_sorted (queue->queue,
309 (GCompareDataFunc)g_async_queue_invert_compare,
314 g_async_queue_pop_intern_unlocked (GAsyncQueue* queue, gboolean try,
319 if (!g_queue_peek_tail (queue->queue))
325 queue->cond = g_cond_new ();
329 queue->waiting_threads++;
330 while (!g_queue_peek_tail (queue->queue))
331 g_cond_wait(queue->cond, queue->mutex);
332 queue->waiting_threads--;
336 queue->waiting_threads++;
337 while (!g_queue_peek_tail (queue->queue))
338 if (!g_cond_timed_wait (queue->cond, queue->mutex, end_time))
340 queue->waiting_threads--;
341 if (!g_queue_peek_tail (queue->queue))
346 retval = g_queue_pop_tail (queue->queue);
355 * @queue: a #GAsyncQueue.
357 * Pops data from the @queue. This function blocks until data become
360 * Return value: data from the queue.
363 g_async_queue_pop (GAsyncQueue* queue)
367 g_return_val_if_fail (queue, NULL);
368 g_return_val_if_fail (g_atomic_int_get (&queue->ref_count) > 0, NULL);
370 g_mutex_lock (queue->mutex);
371 retval = g_async_queue_pop_intern_unlocked (queue, FALSE, NULL);
372 g_mutex_unlock (queue->mutex);
378 * g_async_queue_pop_unlocked:
379 * @queue: a #GAsyncQueue.
381 * Pops data from the @queue. This function blocks until data become
382 * available. This function must be called while holding the @queue's
385 * Return value: data from the queue.
388 g_async_queue_pop_unlocked (GAsyncQueue* queue)
390 g_return_val_if_fail (queue, NULL);
391 g_return_val_if_fail (g_atomic_int_get (&queue->ref_count) > 0, NULL);
393 return g_async_queue_pop_intern_unlocked (queue, FALSE, NULL);
397 * g_async_queue_try_pop:
398 * @queue: a #GAsyncQueue.
400 * Tries to pop data from the @queue. If no data is available, %NULL is
403 * Return value: data from the queue or %NULL, when no data is
404 * available immediately.
407 g_async_queue_try_pop (GAsyncQueue* queue)
411 g_return_val_if_fail (queue, NULL);
412 g_return_val_if_fail (g_atomic_int_get (&queue->ref_count) > 0, NULL);
414 g_mutex_lock (queue->mutex);
415 retval = g_async_queue_pop_intern_unlocked (queue, TRUE, NULL);
416 g_mutex_unlock (queue->mutex);
422 * g_async_queue_try_pop_unlocked:
423 * @queue: a #GAsyncQueue.
425 * Tries to pop data from the @queue. If no data is available, %NULL is
426 * returned. This function must be called while holding the @queue's
429 * Return value: data from the queue or %NULL, when no data is
430 * available immediately.
433 g_async_queue_try_pop_unlocked (GAsyncQueue* queue)
435 g_return_val_if_fail (queue, NULL);
436 g_return_val_if_fail (g_atomic_int_get (&queue->ref_count) > 0, NULL);
438 return g_async_queue_pop_intern_unlocked (queue, TRUE, NULL);
442 * g_async_queue_timed_pop:
443 * @queue: a #GAsyncQueue.
444 * @end_time: a #GTimeVal, determining the final time.
446 * Pops data from the @queue. If no data is received before @end_time,
449 * To easily calculate @end_time a combination of g_get_current_time()
450 * and g_time_val_add() can be used.
452 * Return value: data from the queue or %NULL, when no data is
453 * received before @end_time.
456 g_async_queue_timed_pop (GAsyncQueue* queue, GTimeVal *end_time)
460 g_return_val_if_fail (queue, NULL);
461 g_return_val_if_fail (g_atomic_int_get (&queue->ref_count) > 0, NULL);
463 g_mutex_lock (queue->mutex);
464 retval = g_async_queue_pop_intern_unlocked (queue, FALSE, end_time);
465 g_mutex_unlock (queue->mutex);
471 * g_async_queue_timed_pop_unlocked:
472 * @queue: a #GAsyncQueue.
473 * @end_time: a #GTimeVal, determining the final time.
475 * Pops data from the @queue. If no data is received before @end_time,
476 * %NULL is returned. This function must be called while holding the
479 * To easily calculate @end_time a combination of g_get_current_time()
480 * and g_time_val_add() can be used.
482 * Return value: data from the queue or %NULL, when no data is
483 * received before @end_time.
486 g_async_queue_timed_pop_unlocked (GAsyncQueue* queue, GTimeVal *end_time)
488 g_return_val_if_fail (queue, NULL);
489 g_return_val_if_fail (g_atomic_int_get (&queue->ref_count) > 0, NULL);
491 return g_async_queue_pop_intern_unlocked (queue, FALSE, end_time);
495 * g_async_queue_length:
496 * @queue: a #GAsyncQueue.
498 * Returns the length of the queue, negative values mean waiting
499 * threads, positive values mean available entries in the
500 * @queue. Actually this function returns the number of data items in
501 * the queue minus the number of waiting threads. Thus a return value
502 * of 0 could mean 'n' entries in the queue and 'n' thread waiting.
503 * That can happen due to locking of the queue or due to
506 * Return value: the length of the @queue.
509 g_async_queue_length (GAsyncQueue* queue)
513 g_return_val_if_fail (queue, 0);
514 g_return_val_if_fail (g_atomic_int_get (&queue->ref_count) > 0, 0);
516 g_mutex_lock (queue->mutex);
517 retval = queue->queue->length - queue->waiting_threads;
518 g_mutex_unlock (queue->mutex);
524 * g_async_queue_length_unlocked:
525 * @queue: a #GAsyncQueue.
527 * Returns the length of the queue, negative values mean waiting
528 * threads, positive values mean available entries in the
529 * @queue. Actually this function returns the number of data items in
530 * the queue minus the number of waiting threads. Thus a return value
531 * of 0 could mean 'n' entries in the queue and 'n' thread waiting.
532 * That can happen due to locking of the queue or due to
533 * scheduling. This function must be called while holding the @queue's
536 * Return value: the length of the @queue.
539 g_async_queue_length_unlocked (GAsyncQueue* queue)
541 g_return_val_if_fail (queue, 0);
542 g_return_val_if_fail (g_atomic_int_get (&queue->ref_count) > 0, 0);
544 return queue->queue->length - queue->waiting_threads;
548 * g_async_queue_sort:
549 * @queue: a #GAsyncQueue
550 * @func: the #GCompareDataFunc is used to sort @queue. This
551 * function is passed two elements of the @queue. The function
552 * should return 0 if they are equal, a negative value if the
553 * first element should be higher in the @queue or a positive
554 * value if the first element should be lower in the @queue than
555 * the second element.
556 * @user_data: user data passed to @func
558 * Sorts @queue using @func.
560 * This function will lock @queue before it sorts the queue and unlock
561 * it when it is finished.
563 * If you were sorting a list of priority numbers to make sure the
564 * lowest priority would be at the top of the queue, you could use:
565 * <informalexample><programlisting>
569 * id1 = GPOINTER_TO_INT (element1);
570 * id2 = GPOINTER_TO_INT (element2);
572 * return (id1 > id2 ? +1 : id1 == id2 ? 0 : -1);
573 * </programlisting></informalexample>
578 g_async_queue_sort (GAsyncQueue *queue,
579 GCompareDataFunc func,
582 g_return_if_fail (queue != NULL);
583 g_return_if_fail (func != NULL);
585 g_mutex_lock (queue->mutex);
586 g_async_queue_sort_unlocked (queue, func, user_data);
587 g_mutex_unlock (queue->mutex);
591 * g_async_queue_sort_unlocked:
592 * @queue: a #GAsyncQueue
593 * @func: the #GCompareDataFunc is used to sort @queue. This
594 * function is passed two elements of the @queue. The function
595 * should return 0 if they are equal, a negative value if the
596 * first element should be higher in the @queue or a positive
597 * value if the first element should be lower in the @queue than
598 * the second element.
599 * @user_data: user data passed to @func
601 * Sorts @queue using @func.
603 * This function is called while holding the @queue's lock.
608 g_async_queue_sort_unlocked (GAsyncQueue *queue,
609 GCompareDataFunc func,
614 g_return_if_fail (queue != NULL);
615 g_return_if_fail (func != NULL);
618 sd.user_data = user_data;
620 g_queue_sort (queue->queue,
621 (GCompareDataFunc)g_async_queue_invert_compare,
625 #define __G_ASYNCQUEUE_C__
626 #include "galiasdef.c"