More documentation.

ioquatix · ioquatix · commit fa81ca9b5066 · 2022-12-04T17:14:54.000+13:00
diff --git a/lib/async/barrier.md b/lib/async/barrier.md
@@ -31,6 +31,6 @@ end
 ### Output
 
 ~~~
-0.0s     info: Sorted [ec=0x104] [pid=50291]
-						 | [0, 0, 0, 0, 1, 2, 2, 3, 6, 6]
+0.0s     info: Sorted
+             | [0, 0, 0, 0, 1, 2, 2, 3, 6, 6]
 ~~~
diff --git a/lib/async/condition.md b/lib/async/condition.md
@@ -25,7 +25,7 @@ end
 ### Output
 
 ~~~
-0.0s     info: Waiting for condition... [ec=0x3c] [pid=47943]
-1.0s     info: Signalling condition... [ec=0x64] [pid=47943]
-1.0s     info: Condition was signalled: Hello World [ec=0x3c] [pid=47943]
+0.0s     info: Waiting for condition...
+1.0s     info: Signalling condition...
+1.0s     info: Condition was signalled: Hello World
 ~~~
diff --git a/lib/async/waiter.md b/lib/async/waiter.md
@@ -0,0 +1,50 @@
+A synchronization primitive, which allows you to wait for tasks to complete in order of completion. This is useful for implementing a task pool, where you want to wait for the first task to complete, and then cancel the rest.
+
+If you try to wait for more things than you have added, you will deadlock.
+
+## Example
+
+~~~ ruby
+require 'async'
+require 'async/semaphore'
+require 'async/barrier'
+require 'async/waiter'
+
+Sync do
+	barrier = Async::Barrier.new
+	waiter = Async::Waiter.new(parent: barrier)
+	semaphore = Async::Semaphore.new(2, parent: waiter)
+	
+	# Sleep sort the numbers:
+	generator = Async do
+		while true
+			semaphore.async do |task|
+				number = rand(1..10)
+				sleep(number)
+			end
+		end
+	end
+	
+	numbers = []
+	
+	4.times do
+		# Wait for all the numbers to be sorted:
+		numbers << waiter.wait
+	end
+	
+	# Don't generate any more numbers:
+	generator.stop
+	
+	# Stop all tasks which we don't care about:
+	barrier.stop
+	
+	Console.logger.info("Smallest", numbers)
+end
+~~~
+
+### Output
+
+~~~
+0.0s     info: Smallest
+             | [3, 3, 1, 2]
+~~~
