Parallel (API) - Revision history

Cranium at 20:29, 16 April 2014

2014-04-16T20:29:04Z

2014-04-16T20:28:49Z

correction of sleep link

2014-04-10T18:21:47Z

Fixed arguments

2014-04-10T18:15:49Z

2014-04-10T18:15:21Z

Expanded

2014-04-06T20:41:37Z

Added {{NeedsWork}} Tag

2013-09-14T21:50:03Z

use API table template

2012-11-30T22:21:24Z

Updated to API overview v2

2012-11-25T08:35:16Z

2012-10-06T23:48:58Z

@@ Line 4: / Line 4: @@
 Functions are not actually executed simultaniously, but rather this API will automatically switch between them whenever they yield (eg whenever they call [[coroutine.yield]](), or functions that call that - eg [[os.pullEvent]]() - or functions that call that, etc - basically, anything that causes the function to "pause").
-Each function executed in "parallel" gets its own copy of the event queue, and so "event consuming" functions (again, mostly anything that causes the script to pause - eg [[Os.sleep]](), [[rednet.receive]](), most of the [[Turtle (API)|turtle API]], etc) can safely be used in one without affecting the event queue accessed by the other.
+Each function executed in "parallel" gets its own copy of the event queue, and so "event consuming" functions (again, mostly anything that causes the script to pause - eg [[Os.sleep|sleep]](), [[rednet.receive]](), most of the [[Turtle (API)|turtle API]], etc) can safely be used in one without affecting the event queue accessed by the other.
 {{API table|parallel|image=Grid disk.png|2=

@@ Line 4: / Line 4: @@
 Functions are not actually executed simultaniously, but rather this API will automatically switch between them whenever they yield (eg whenever they call [[coroutine.yield]](), or functions that call that - eg [[os.pullEvent]]() - or functions that call that, etc - basically, anything that causes the function to "pause").
-Each function executed in "parallel" gets its own copy of the event queue, and so "event consuming" functions (again, mostly anything that causes the script to pause - eg [[sleep]](), [[rednet.receive]](), most of the [[Turtle (API)|turtle API]], etc) can safely be used in one without affecting the event queue accessed by the other.
+Each function executed in "parallel" gets its own copy of the event queue, and so "event consuming" functions (again, mostly anything that causes the script to pause - eg [[Os.sleep]](), [[rednet.receive]](), most of the [[Turtle (API)|turtle API]], etc) can safely be used in one without affecting the event queue accessed by the other.
 {{API table|parallel|image=Grid disk.png|2=

@@ Line 1: / Line 1: @@
-{{NeedsWork|This API needs explanation and examples. [[User:MKlegoman357|MKlegoman357]] 20:41, 6 April 2014 (GMT)}}
+{{lowercase}}
-−
 Parallel is an API which allows you to multitask.
@@ Line 7: / Line 6: @@
 Each function executed in "parallel" gets its own copy of the event queue, and so "event consuming" functions (again, mostly anything that causes the script to pause - eg [[sleep]](), [[rednet.receive]](), most of the [[Turtle (API)|turtle API]], etc) can safely be used in one without affecting the event queue accessed by the other.
-{{API table|Parallel|image=Grid disk.png|2=
+{{API table|parallel|image=Grid disk.png|2=
 {{API table/row
-|[[parallel.waitForAny]](function1, function2, ...)
+|[[parallel.waitForAny]]({{type|function}} function1, {{type|function}} function2, ...)
 |{{type|number}} stoppedFunction
 |Runs all the functions at the same time, and stops when any of them returns.
@@ Line 16: / Line 15: @@
 {{API table/row
-|[[parallel.waitForAll]](function1, function2, ...)
+|[[parallel.waitForAll]]({{type|function}} function1, {{type|function}} function2, ...)
 |{{type|nil}}
 |Runs all the functions at the same time, and stops when all of them have returned.

@@ Line 3: / Line 3: @@
 Parallel is an API which allows you to multitask.
-The functions are not actually executed simultaniously, but rather this API will automatically switch between them whenever they yield (eg whenever they call [[coroutine.yield]](), or functions that call that - eg [[os.pullEvent]]() - or functions that call that, etc - basically, anything that causes the function to "pause").
+Functions are not actually executed simultaniously, but rather this API will automatically switch between them whenever they yield (eg whenever they call [[coroutine.yield]](), or functions that call that - eg [[os.pullEvent]]() - or functions that call that, etc - basically, anything that causes the function to "pause").
 Each function executed in "parallel" gets its own copy of the event queue, and so "event consuming" functions (again, mostly anything that causes the script to pause - eg [[sleep]](), [[rednet.receive]](), most of the [[Turtle (API)|turtle API]], etc) can safely be used in one without affecting the event queue accessed by the other.

@@ Line 2: / Line 2: @@
 Parallel is an API which allows you to multitask.
 {{API table|Parallel|image=Grid disk.png|2=
 {{API table/row
-|[[parallel.waitForAny]](function1, function2, ...)|{{type|nil}}
+|[[parallel.waitForAny]](function1, function2, ...)
 |Runs all the functions at the same time, and stops when any of them returns.
 |odd}}
 {{API table/row
-|[[parallel.waitForAll]](function1, function2, ...)|{{type|nil}}
+|[[parallel.waitForAll]](function1, function2, ...)
 |Runs all the functions at the same time, and stops when all of them have returned.
 |}}

← Older revision		Revision as of 20:41, 6 April 2014
Line 1:		Line 1:
		+	{{NeedsWork\|This API needs explanation and examples. [[User:MKlegoman357\|MKlegoman357]] 20:41, 6 April 2014 (GMT)}}

	Parallel is an API which allows you to multitask.		Parallel is an API which allows you to multitask.

@@ Line 2: / Line 2: @@
 Parallel is an API which allows you to multitask.
-<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
+{{API table|Parallel|image=Grid disk.png|2=
-<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
-[[File:Grid_disk.png|24px]]&nbsp;&nbsp;
-Parallel (API)
-</td></tr>
-<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>
+{{API table/row
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[parallel.waitForAny]](function1, function2, ...)</td>
+{{API table/row
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Runs all the functions at the same time, and stops when any of them returns.</td></tr>
+|[[parallel.waitForAll]](function1, function2, ...)|{{type|nil}}
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[parallel.waitForAll]](function1, function2, ...)</td>
+}}
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Runs all the functions at the same time, and stops when all of them have returned.</td></tr>
-−
-</table>
 [[Category:APIs]]

@@ Line 5: / Line 5: @@
 |-
 |[[parallel.waitForAny]]( function1, function2, so on)
-|Waits for any function to complete.
+|Runs all the functions at the same time, and stops when any of them returns.
 |-
 |[[parallel.waitForAll]]( function1, function2, so on)
-|Waits for all of the functions to complete.
+|Runs all the functions at the same time, and stops when all of them have returned.
 |}
 [[Category:APIs]]