gst/gstatomicqueue.h

   1 /* GStreamer
   2  * Copyright (C) 2009-2010 Edward Hervey <bilboed@bilboed.com>
   3  *           (C) 2011 Wim Taymans <wim.taymans@gmail.com>
   4  *
   5  * gstatomicqueue.h:
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library 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.
  11  *
  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  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 #include <glib.h>
  24 #include <glib-object.h>
  25 #include <gst/gstconfig.h>
  26
  27 #ifndef __GST_ATOMIC_QUEUE_H__
  28 #define __GST_ATOMIC_QUEUE_H__
  29
  30 G_BEGIN_DECLS
  31
  32 #define GST_TYPE_ATOMIC_QUEUE (gst_atomic_queue_get_type())
  33
  34 /**
  35  * GstAtomicQueue:
  36  *
  37  * Opaque atomic data queue.
  38  *
  39  * Use the accessor functions to get the stored values.
  40  */
  41 typedef struct _GstAtomicQueue GstAtomicQueue;
  42
  43
  44 GST_API
  45 GType              gst_atomic_queue_get_type    (void);
  46
  47 GST_API
  48 GstAtomicQueue *   gst_atomic_queue_new         (guint initial_size) G_GNUC_MALLOC;
  49
  50 GST_API
  51 void               gst_atomic_queue_ref         (GstAtomicQueue * queue);
  52
  53 GST_API
  54 void               gst_atomic_queue_unref       (GstAtomicQueue * queue);
  55
  56 GST_API
  57 void               gst_atomic_queue_push        (GstAtomicQueue* queue, gpointer data);
  58
  59 GST_API
  60 gpointer           gst_atomic_queue_pop         (GstAtomicQueue* queue);
  61
  62 GST_API
  63 gpointer           gst_atomic_queue_peek        (GstAtomicQueue* queue);
  64
  65 GST_API
  66 guint              gst_atomic_queue_length      (GstAtomicQueue * queue);
  67
  68 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
  69 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstAtomicQueue, gst_atomic_queue_unref)
  70 #endif
  71
  72 G_END_DECLS
  73
  74 #endif /* __GST_ATOMIC_QUEUE_H__ */