glib/gasyncqueue.h

   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, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  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 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  28 #error "Only <glib.h> can be included directly."
  29 #endif
  30
  31 #ifndef __G_ASYNCQUEUE_H__
  32 #define __G_ASYNCQUEUE_H__
  33
  34 #include <glib/gthread.h>
  35
  36 G_BEGIN_DECLS
  37
  38 typedef struct _GAsyncQueue GAsyncQueue;
  39
  40 GAsyncQueue *g_async_queue_new                  (void);
  41 GAsyncQueue *g_async_queue_new_full             (GDestroyNotify item_free_func);
  42 void         g_async_queue_lock                 (GAsyncQueue      *queue);
  43 void         g_async_queue_unlock               (GAsyncQueue      *queue);
  44 GAsyncQueue *g_async_queue_ref                  (GAsyncQueue      *queue);
  45 void         g_async_queue_unref                (GAsyncQueue      *queue);
  46
  47 GLIB_DEPRECATED_FOR(g_async_queue_ref)
  48 void         g_async_queue_ref_unlocked         (GAsyncQueue      *queue);
  49
  50 GLIB_DEPRECATED_FOR(g_async_queue_unref)
  51 void         g_async_queue_unref_and_unlock     (GAsyncQueue      *queue);
  52
  53 void         g_async_queue_push                 (GAsyncQueue      *queue,
  54                                                  gpointer          data);
  55 void         g_async_queue_push_unlocked        (GAsyncQueue      *queue,
  56                                                  gpointer          data);
  57 void         g_async_queue_push_sorted          (GAsyncQueue      *queue,
  58                                                  gpointer          data,
  59                                                  GCompareDataFunc  func,
  60                                                  gpointer          user_data);
  61 void         g_async_queue_push_sorted_unlocked (GAsyncQueue      *queue,
  62                                                  gpointer          data,
  63                                                  GCompareDataFunc  func,
  64                                                  gpointer          user_data);
  65 gpointer     g_async_queue_pop                  (GAsyncQueue      *queue);
  66 gpointer     g_async_queue_pop_unlocked         (GAsyncQueue      *queue);
  67 gpointer     g_async_queue_try_pop              (GAsyncQueue      *queue);
  68 gpointer     g_async_queue_try_pop_unlocked     (GAsyncQueue      *queue);
  69 gpointer     g_async_queue_timeout_pop          (GAsyncQueue      *queue,
  70                                                  guint64           timeout);
  71 gpointer     g_async_queue_timeout_pop_unlocked (GAsyncQueue      *queue,
  72                                                  guint64           timeout);
  73 gint         g_async_queue_length               (GAsyncQueue      *queue);
  74 gint         g_async_queue_length_unlocked      (GAsyncQueue      *queue);
  75 void         g_async_queue_sort                 (GAsyncQueue      *queue,
  76                                                  GCompareDataFunc  func,
  77                                                  gpointer          user_data);
  78 void         g_async_queue_sort_unlocked        (GAsyncQueue      *queue,
  79                                                  GCompareDataFunc  func,
  80                                                  gpointer          user_data);
  81
  82 GLIB_DEPRECATED_FOR(g_async_queue_timeout_pop)
  83 gpointer     g_async_queue_timed_pop            (GAsyncQueue      *queue,
  84                                                  GTimeVal         *end_time);
  85 GLIB_DEPRECATED_FOR(g_async_queue_timeout_pop_unlocked)
  86 gpointer     g_async_queue_timed_pop_unlocked   (GAsyncQueue      *queue,
  87                                                  GTimeVal         *end_time);
  88
  89 G_END_DECLS
  90
  91 #endif /* __G_ASYNCQUEUE_H__ */