docs: add some more Since: markers to atomic queue docs
[platform/upstream/gstreamer.git] / 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., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22
23 #include <glib.h>
24
25 #ifndef __GST_ATOMIC_QUEUE_H__
26 #define __GST_ATOMIC_QUEUE_H__
27
28 G_BEGIN_DECLS
29
30 /**
31  * GstAtomicQueue:
32  * Opaque atomic data queue.
33  *
34  * Use the acessor functions to get the stored values.
35  *
36  * Since: 0.10.33
37  */
38 typedef struct _GstAtomicQueue GstAtomicQueue;
39
40
41 GstAtomicQueue *   gst_atomic_queue_new         (guint initial_size);
42
43 void               gst_atomic_queue_ref         (GstAtomicQueue * queue);
44 void               gst_atomic_queue_unref       (GstAtomicQueue * queue);
45
46 void               gst_atomic_queue_push        (GstAtomicQueue* queue, gpointer data);
47 gpointer           gst_atomic_queue_pop         (GstAtomicQueue* queue);
48 gpointer           gst_atomic_queue_peek        (GstAtomicQueue* queue);
49
50 guint              gst_atomic_queue_length      (GstAtomicQueue * queue);
51
52 G_END_DECLS
53
54 #endif /* __GST_ATOMIC_QUEUE_H__ */