docs/reference/glib/tmpl/queue.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Double-ended Queues
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 double-ended queue data structure.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The #GQueue structure and its associated functions provide a standard
  10 queue data structure. Internally, #GQueue uses the same data structure as
  11 #GList to store elements.
  12 </para>
  13 <para>
  14 The data contained in each element can be either integer values, by using one
  15 of the
  16 <link linkend="glib-Type-Conversion-Macros">Type Conversion Macros</link>,
  17 or simply pointers to any type of data.
  18 </para>
  19 <para>
  20 To create a new #GQueue, use g_queue_new().
  21 </para>
  22 <para>
  23 To add elements, use g_queue_push_head(), g_queue_push_head_link(),
  24 g_queue_push_tail() and g_queue_push_tail_link().
  25 </para>
  26 <para>
  27 To remove elements, use g_queue_pop_head() and g_queue_pop_tail().
  28 </para>
  29 <para>
  30 To free the entire queue, use g_queue_free().
  31 </para>
  32
  33 <!-- ##### SECTION See_Also ##### -->
  34 <para>
  35
  36 </para>
  37
  38 <!-- ##### STRUCT GQueue ##### -->
  39 <para>
  40 Contains the public fields of a <link linkend="glib-queues">Queue</link>.
  41 </para>
  42
  43 @head: a pointer to the first element of the queue.
  44 @tail: a pointer to the last element of the queue.
  45 @length: the number of elements in the queue.
  46
  47 <!-- ##### FUNCTION g_queue_new ##### -->
  48 <para>
  49
  50 </para>
  51
  52 @Returns:
  53
  54
  55 <!-- ##### FUNCTION g_queue_free ##### -->
  56 <para>
  57
  58 </para>
  59
  60 @queue:
  61
  62
  63 <!-- ##### FUNCTION g_queue_push_head ##### -->
  64 <para>
  65
  66 </para>
  67
  68 @queue:
  69 @data:
  70
  71
  72 <!-- ##### FUNCTION g_queue_push_tail ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @queue:
  78 @data:
  79
  80
  81 <!-- ##### FUNCTION g_queue_pop_head ##### -->
  82 <para>
  83
  84 </para>
  85
  86 @queue:
  87 @Returns:
  88
  89
  90 <!-- ##### FUNCTION g_queue_pop_tail ##### -->
  91 <para>
  92
  93 </para>
  94
  95 @queue:
  96 @Returns:
  97
  98
  99 <!-- ##### FUNCTION g_queue_is_empty ##### -->
 100 <para>
 101
 102 </para>
 103
 104 @queue:
 105 @Returns:
 106
 107
 108 <!-- ##### FUNCTION g_queue_peek_head ##### -->
 109 <para>
 110
 111 </para>
 112
 113 @queue:
 114 @Returns:
 115
 116
 117 <!-- ##### FUNCTION g_queue_peek_tail ##### -->
 118 <para>
 119
 120 </para>
 121
 122 @queue:
 123 @Returns:
 124
 125
 126 <!-- ##### FUNCTION g_queue_push_head_link ##### -->
 127 <para>
 128
 129 </para>
 130
 131 @queue:
 132 @link_:
 133
 134
 135 <!-- ##### FUNCTION g_queue_push_tail_link ##### -->
 136 <para>
 137
 138 </para>
 139
 140 @queue:
 141 @link_:
 142
 143
 144 <!-- ##### FUNCTION g_queue_pop_head_link ##### -->
 145 <para>
 146
 147 </para>
 148
 149 @queue:
 150 @Returns:
 151
 152
 153 <!-- ##### FUNCTION g_queue_pop_tail_link ##### -->
 154 <para>
 155
 156 </para>
 157
 158 @queue:
 159 @Returns:
 160
 161