GQUEUE - Revision history

Tectu: /* API reference */

2016-02-04T15:51:51Z

‎API reference

2015-06-21T13:34:49Z

2015-02-14T00:21:05Z

‎API reference

2014-07-23T13:19:53Z

2014-07-05T10:36:46Z

‎Example

2014-07-05T10:34:48Z

‎Example

2014-07-05T00:18:43Z

‎Queues

2014-07-05T00:11:39Z

‎Operations

2014-07-04T23:58:14Z

2014-07-04T23:53:46Z

‎Queues

@@ Line 2: / Line 2: @@
 == API reference ==
-The API reference of the GQUEUE module can be found [http://api.ugfx.org/master/group___g_q_u_e_u_e.html here].
+The API reference of the GQUEUE module can be found [http://api.ugfx.org/group___g_q_u_e_u_e.html here].
 == Buffers ==

← Older revision		Revision as of 13:34, 21 June 2015
Line 1:		Line 1:
−	The GQUEUE modules ~~does provide~~ queues and buffers.	+	The GQUEUE modules provides implementations of different queues and buffers.

	== API reference ==		== API reference ==

@@ Line 2: / Line 2: @@
 == API reference ==
-The API reference of the GQUEUE module can be found [http://ugfx.org/images/resources/doxygen/master/group___g_q_u_e_u_e.html here].
+The API reference of the GQUEUE module can be found [http://api.ugfx.org/master/group___g_q_u_e_u_e.html here].
 == Buffers ==

@@ Line 19: / Line 19: @@
 === Example ===
-ToDo
+The [[GAUDIO]] play back demo shows how to use buffers.
 == Queues ==

@@ Line 55: / Line 55: @@
 Please refer to the [[#API_reference|API reference]] for further information.
-=== Example ===
-ToDo
 [[Category:Modules]]

@@ Line 17: / Line 17: @@
 As <code>gfxBufferGet()</code> takes a timeout parameter, this function polls until either a free buffer is available or the timeout is exceeded. To avoid this, <code>gfxBufferIsAvailable()</code> can be used to check if there is a free buffer before hand.
 == Queues ==
-Although the queues provided by the GQUEUE module are mainly used internally, these features are still accessible for the user.
+Although the queues provided by the GQUEUE module are mainly used internally, these features are still accessible for the user. The user can use the queue by creating a struct and using ''gfxQueueASyncItem'' as the first struct member.
 === Types ===
@@ Line 51: / Line 54: @@
 * IsEmpty
 Please refer to the [[#API_reference|API reference]] for further information.
 [[Category:Modules]]

@@ Line 36: / Line 36: @@
 === Operations ===
 Although there are three types of queues, the API is fully compatible between them. Only the function name changes (''ASync'', ''GSync'', ''FSync'').
 [[Category:Modules]]

@@ Line 21: / Line 21: @@
 Although the queues provided by the GQUEUE module are mainly used internally, these features are still accessible for the user.
 There are three types of queues available:
-* ASync
+{| class="wikitable"
-* GSync
+|-
-* FSync
+! Queue Type !! Description
+|-
-=== ASync ===
+| ASync || Fully asynchronous queue. Queue operations do never block
-Fully asynchronous queue. Queue operations do never block
+|-
+| GSync || ''Get'' synchronous queue. The ''put'' operations are still asynchronous.
-=== GSync ===
+|-
-''Get'' synchronous queue. The ''put'' operations are still asynchronous. However, the ''get'' operations are synchronous.
+| FSync || Fully synchronous queue. Both, the ''put'' and the ''get'' operations are synchronous.
+|}
-=== FSync ===
 Fully synchronous queue. Both, the ''put'' and the ''get'' operations are synchronous.
-−
 [[Category:Modules]]

← Older revision		Revision as of 23:53, 4 July 2014
Line 21:		Line 21:
	Although the queues provided by the GQUEUE module are mainly used internally, these features are still accessible for the user.		Although the queues provided by the GQUEUE module are mainly used internally, these features are still accessible for the user.

−	~~ToDo~~	+	There are three types of queues available:
		+	* ASync
		+	* GSync
		+	* FSync
		+
		+	=== ASync ===
		+	Fully asynchronous queue. Queue operations do never block
		+
		+	=== GSync ===
		+	''Get'' synchronous queue. The ''put'' operations are still asynchronous. However, the ''get'' operations are synchronous.
		+
		+	=== FSync ===
		+	Fully synchronous queue. Both, the ''put'' and the ''get'' operations are synchronous.