[DOC-CVS] [doc-en] master: parallel : fix XML by converting para to simpara tags via script
[email protected] (Gina Peter Banyard)
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Gina Peter Banyard (Girgias)
Date: 2026-01-19T03:28:13Z
Commit: https://github.com/php/doc-en/commit/57c7669a1f5336cb17413e0b46540c52c77ee84f
Raw diff: https://github.com/php/doc-en/commit/57c7669a1f5336cb17413e0b46540c52c77ee84f.diff
parallel : fix XML by converting para to simpara tags via script
Changed paths:
M reference/parallel/book.xml
M reference/parallel/configure.xml
M reference/parallel/functional.xml
M reference/parallel/functions/parallel.bootstrap.xml
M reference/parallel/functions/parallel.run.xml
M reference/parallel/parallel.channel.xml
M reference/parallel/parallel.events.event.xml
M reference/parallel/parallel.events.input.xml
M reference/parallel/parallel.events.xml
M reference/parallel/parallel.future.xml
M reference/parallel/parallel.runtime.xml
M reference/parallel/parallel.sync.xml
M reference/parallel/parallel/channel/close.xml
M reference/parallel/parallel/channel/construct.xml
M reference/parallel/parallel/channel/make.xml
M reference/parallel/parallel/channel/open.xml
M reference/parallel/parallel/channel/recv.xml
M reference/parallel/parallel/channel/send.xml
M reference/parallel/parallel/events/addchannel.xml
M reference/parallel/parallel/events/addfuture.xml
M reference/parallel/parallel/events/poll.xml
M reference/parallel/parallel/events/remove.xml
M reference/parallel/parallel/events/setblocking.xml
M reference/parallel/parallel/events/setinput.xml
M reference/parallel/parallel/events/settimeout.xml
M reference/parallel/parallel/future/cancel.xml
M reference/parallel/parallel/future/cancelled.xml
M reference/parallel/parallel/future/done.xml
M reference/parallel/parallel/future/value.xml
M reference/parallel/parallel/input/add.xml
M reference/parallel/parallel/input/clear.xml
M reference/parallel/parallel/input/remove.xml
M reference/parallel/parallel/runtime/close.xml
M reference/parallel/parallel/runtime/construct.xml
M reference/parallel/parallel/runtime/kill.xml
M reference/parallel/parallel/runtime/run.xml
M reference/parallel/parallel/sync/construct.xml
M reference/parallel/parallel/sync/get.xml
M reference/parallel/parallel/sync/invoke.xml
M reference/parallel/parallel/sync/notify.xml
M reference/parallel/parallel/sync/set.xml
M reference/parallel/parallel/sync/wait.xml
M reference/parallel/philosophy.xml
M reference/parallel/setup.xml
Diff:
diff --git a/reference/parallel/book.xml b/reference/parallel/book.xml
index 82a7eac11b93..923c45b7fac3 100644
--- a/reference/parallel/book.xml
+++ b/reference/parallel/book.xml
@@ -1,98 +1,97 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<book xml:id="book.parallel" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="book.parallel">
<?phpdoc extension-membership="pecl" ?>
<title>parallel</title>
<titleabbrev>parallel</titleabbrev>
<preface xml:id="intro.parallel">
&reftitle.intro;
- <para>
+ <simpara>
parallel is a parallel concurrency extension for PHP ≥ 7.2.0.
As of parallel 1.2.0, PHP ≥ 8.0.0 is required.
- </para>
- <para>
+ </simpara>
+ <simpara>
A brief description of the concepts core to parallel follows, more detailed information may be found within this section of the manual.
- </para>
+ </simpara>
<simplesect>
<title>Runtime</title>
- <para>
- A <classname>parallel\Runtime</classname> represents a PHP interpreter thread. A <classname>parallel\Runtime</classname> is configured with an optional bootstrap file passed to <methodname>parallel\Runtime::__construct</methodname>, this is typically an autoloader,
+ <simpara>
+ A <classname>parallel\Runtime</classname> represents a PHP interpreter thread. A <classname>parallel\Runtime</classname> is configured with an optional bootstrap file passed to <methodname>parallel\Runtime::__construct</methodname>, this is typically an autoloader,
or some other preloading routine: The bootstrap file will be included before any task is executed.
- </para>
- <para>
- After construction the <classname>parallel\Runtime</classname> remains available until it is closed, killed, or destroyed by the normal scoping rules of PHP objects.
- <methodname>parallel\Runtime::run</methodname> allows the programmer to schedule tasks for execution in parallel.
+ </simpara>
+ <simpara>
+ After construction the <classname>parallel\Runtime</classname> remains available until it is closed, killed, or destroyed by the normal scoping rules of PHP objects.
+ <methodname>parallel\Runtime::run</methodname> allows the programmer to schedule tasks for execution in parallel.
A <classname>parallel\Runtime</classname> has a FIFO schedule, tasks will be executed in the order that they are scheduled.
- </para>
+ </simpara>
</simplesect>
<simplesect>
<title>Functional API</title>
- <para>
- parallel implements a functional, higher level API on top of <classname>parallel\Runtime</classname> that provides a single function entry point to executing parallel code
+ <simpara>
+ parallel implements a functional, higher level API on top of <classname>parallel\Runtime</classname> that provides a single function entry point to executing parallel code
with automatic scheduling: <function>parallel\run</function>.
- </para>
+ </simpara>
</simplesect>
<simplesect>
<title>Task</title>
<para>
- A task is simply a <classname>Closure</classname> intended for parallel execution. The <classname>Closure</classname> may contain almost any instruction, including nested closures.
+ A task is simply a <classname>Closure</classname> intended for parallel execution. The <classname>Closure</classname> may contain almost any instruction, including nested closures.
However, there are some instructions that are prohibited in tasks:
<itemizedlist>
<listitem>
- <para>yield</para>
+ <simpara>yield</simpara>
</listitem>
<listitem>
- <para>use by-reference</para>
+ <simpara>use by-reference</simpara>
</listitem>
<listitem>
- <para>declare class</para>
+ <simpara>declare class</simpara>
</listitem>
<listitem>
- <para>declare named function</para>
+ <simpara>declare named function</simpara>
</listitem>
</itemizedlist>
</para>
<note>
- <para>
+ <simpara>
Nested closures may yield or use by-reference, but must not contain class or named function declarations.
- </para>
+ </simpara>
</note>
<note>
- <para>
+ <simpara>
No instructions are prohibited in the files which the task may include.
- </para>
+ </simpara>
</note>
</simplesect>
<simplesect>
<title>Future</title>
- <para>
+ <simpara>
The <classname>parallel\Future</classname> is used to access the return value from the task, and exposes an API for cancellation of the task.
- </para>
+ </simpara>
</simplesect>
<simplesect>
<title>Channel</title>
- <para>
+ <simpara>
A task may be scheduled with arguments, use lexical scope variables (by-value), and return a value (via a <classname>parallel\Future</classname>), but these only allow uni-directional communication:
They allow the programmer to send data into and retrieve data from a task, but do not allow bi-directional communication between tasks.
The <classname>parallel\Channel</classname> API allows bi-directional communication between tasks, a <classname>parallel\Channel</classname> is a socket-like link between tasks that the programmer can use to send and receive data.
- </para>
+ </simpara>
</simplesect>
<simplesect>
<title>Events</title>
- <para>
- The <classname>parallel\Events</classname> API implements a native feel (<classname>Traversable</classname>) event loop, and <methodname>parallel\Events::poll</methodname> method.
+ <simpara>
+ The <classname>parallel\Events</classname> API implements a native feel (<classname>Traversable</classname>) event loop, and <methodname>parallel\Events::poll</methodname> method.
It allows the programmer to work with sets of channels and or futures.
- The programmer simply adds channels and futures to the event loop, optionally setting the input for writes with <methodname>parallel\Events::setInput</methodname>,
- and enters into a foreach: parallel will read from and write to objects as they become available yielding <classname>parallel\Events\Event</classname> objects
+ The programmer simply adds channels and futures to the event loop, optionally setting the input for writes with <methodname>parallel\Events::setInput</methodname>,
+ and enters into a foreach: parallel will read from and write to objects as they become available yielding <classname>parallel\Events\Event</classname> objects
describing the operations that have occurred.
- </para>
+ </simpara>
</simplesect>
<simplesect role="seealso">
&reftitle.seealso;
<simplelist>
- <member><xref linkend="philosophy.parallel" /></member>
+ <member><xref linkend="philosophy.parallel"/></member>
</simplelist>
</simplesect>
</preface>
@@ -112,7 +111,6 @@
<!--&reference.parallel.examples;-->
</book>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/configure.xml b/reference/parallel/configure.xml
index 02c1a4abadba..d170437eb2b0 100644
--- a/reference/parallel/configure.xml
+++ b/reference/parallel/configure.xml
@@ -1,20 +1,17 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<section xml:id="parallel.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel.installation">
&reftitle.install;
- <para>
+ <simpara>
Use <option role="configure">--with-parallel[=DIR]</option> when compiling PHP.
- </para>
+ </simpara>
- <para>
+ <simpara>
Windows users should include <filename>php_parallel.dll</filename> into &php.ini;
- </para>
+ </simpara>
</section>
-
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/functional.xml b/reference/parallel/functional.xml
index 4bc76702e074..1d0ae52518f2 100644
--- a/reference/parallel/functional.xml
+++ b/reference/parallel/functional.xml
@@ -1,21 +1,20 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="functional.parallel" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="functional.parallel">
<title>Functional API</title>
<partintro>
- <para>
+ <simpara>
The <classname>parallel\Runtime</classname> API provides a great degree of control to the power PHP programmer, and those intimately familiar with writing applications that use
parallel concurrency.
- </para>
+ </simpara>
<para>
The functional API provides less control in exchange for the ability to make decisions for the programmer:
<itemizedlist>
<listitem>
- <para>all executing runtimes are bootstrapped identically</para>
+ <simpara>all executing runtimes are bootstrapped identically</simpara>
</listitem>
<listitem>
- <para>scheduling is determined by the API, not the programmer</para>
+ <simpara>scheduling is determined by the API, not the programmer</simpara>
</listitem>
</itemizedlist>
<function>parallel\run</function> provides the guarantee that the task will begin to execute in parallel as soon as allowed by hardware and operating system constraints, without
@@ -26,7 +25,6 @@
&reference.parallel.functions.parallel.bootstrap;
&reference.parallel.functions.parallel.run;
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/functions/parallel.bootstrap.xml b/reference/parallel/functions/parallel.bootstrap.xml
index 3934ec62ef7a..75473bd1fd86 100644
--- a/reference/parallel/functions/parallel.bootstrap.xml
+++ b/reference/parallel/functions/parallel.bootstrap.xml
@@ -12,9 +12,9 @@
<type>void</type><methodname>parallel\bootstrap</methodname>
<methodparam><type>string</type><parameter>file</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall use the provided <parameter>file</parameter> to bootstrap all runtimes created for automatic scheduling via <function>parallel\run</function>.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,9 +23,9 @@
<varlistentry>
<term><parameter>file</parameter></term>
<listitem>
- <para>
+ <simpara>
Path to the file to bootstrap all runtimes.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -33,22 +33,22 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.void;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Runtime\Error\Bootstrap</type> if previously called for this process.
- </para>
+ </simpara>
</warning>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Runtime\Error\Bootstrap</type> if called after <function>parallel\run</function>.
- </para>
+ </simpara>
</warning>
</refsect1>
diff --git a/reference/parallel/functions/parallel.run.xml b/reference/parallel/functions/parallel.run.xml
index 433ecbeb28fe..32c5e6cf34a9 100644
--- a/reference/parallel/functions/parallel.run.xml
+++ b/reference/parallel/functions/parallel.run.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel.run" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="parallel.run">
<refnamediv>
<refname>parallel\run</refname>
<refpurpose>Execution</refpurpose>
@@ -13,44 +12,44 @@
<type class="union"><type>Future</type><type>null</type></type><methodname>parallel\run</methodname>
<methodparam><type>Closure</type><parameter>task</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall schedule <parameter>task</parameter> for execution in parallel.
- </para>
+ </simpara>
<methodsynopsis>
<type class="union"><type>Future</type><type>null</type></type><methodname>parallel\run</methodname>
<methodparam><type>Closure</type><parameter>task</parameter></methodparam>
<methodparam><type>array</type><parameter>argv</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall schedule <parameter>task</parameter> for execution in parallel, passing <parameter>argv</parameter> at execution time.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="scheduling-characteristics">
<title>Automatic Scheduling</title>
- <para>
- If a <classname>\parallel\Runtime</classname> internally created and cached by a previous call to <function>parallel\run</function> is idle,
- it will be used to execute the task. If no <classname>\parallel\Runtime</classname> is idle parallel will create and cache a
+ <simpara>
+ If a <classname>\parallel\Runtime</classname> internally created and cached by a previous call to <function>parallel\run</function> is idle,
+ it will be used to execute the task. If no <classname>\parallel\Runtime</classname> is idle parallel will create and cache a
<classname>\parallel\Runtime</classname>.
- </para>
+ </simpara>
<note>
- <para>
+ <simpara>
<classname>\parallel\Runtime</classname> objects created by the programmer are not used for automatic scheduling.
- </para>
+ </simpara>
</note>
</refsect1>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('parallel-runtime.run')/db:refsect1[@role='parameters'])" />
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('parallel-runtime.run')/db:refsect1[@role='closure-characteristics'])" />
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('parallel-runtime.run')/db:refsect1[@role='argv-characteristics'])" />
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('parallel-runtime.run')/db:refsect1[@role='object-characteristics'])" />
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('parallel-runtime.run')/db:refsect1[@role='returnvalues'])" />
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('parallel-runtime.run')/db:refsect1[@role='exceptions'])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('parallel-runtime.run')/db:refsect1[@role='parameters'])"/>
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('parallel-runtime.run')/db:refsect1[@role='closure-characteristics'])"/>
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('parallel-runtime.run')/db:refsect1[@role='argv-characteristics'])"/>
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('parallel-runtime.run')/db:refsect1[@role='object-characteristics'])"/>
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('parallel-runtime.run')/db:refsect1[@role='returnvalues'])"/>
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('parallel-runtime.run')/db:refsect1[@role='exceptions'])"/>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
- <member><xref linkend="parallel-runtime.run" /></member>
+ <member><xref linkend="parallel-runtime.run"/></member>
</simplelist>
</refsect1>
diff --git a/reference/parallel/parallel.channel.xml b/reference/parallel/parallel.channel.xml
index 7d532a8a94cc..ed20f4979ebb 100644
--- a/reference/parallel/parallel.channel.xml
+++ b/reference/parallel/parallel.channel.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.parallel-channel" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.parallel-channel" role="class">
<title>The parallel\Channel class</title>
<titleabbrev>parallel\Channel</titleabbrev>
@@ -9,45 +8,45 @@
<partintro>
<section>
<title>Unbuffered Channels</title>
- <para>
- An unbuffered channel will block on calls to <methodname>parallel\Channel::send</methodname> until there is a receiver, and block on calls to
+ <simpara>
+ An unbuffered channel will block on calls to <methodname>parallel\Channel::send</methodname> until there is a receiver, and block on calls to
<methodname>parallel\Channel::recv</methodname> until there is a sender. This means an unbuffered channel is not only a way to share data among tasks
but also a simple method of synchronization.
- </para>
- <para>
+ </simpara>
+ <simpara>
An unbuffered channel is the fastest way to share data among tasks, requiring the least copying.
- </para>
+ </simpara>
</section>
<section>
<title>Buffered Channels</title>
- <para>
- A buffered channel will not block on calls to <methodname>parallel\Channel::send</methodname> until capacity is reached, calls to
+ <simpara>
+ A buffered channel will not block on calls to <methodname>parallel\Channel::send</methodname> until capacity is reached, calls to
<methodname>parallel\Channel::recv</methodname> will block until there is data in the buffer.
- </para>
+ </simpara>
</section>
<section>
<title>Closures over Channels</title>
- <para>
+ <simpara>
A powerful feature of parallel channels is that they allow the exchange of closures between tasks (and runtimes).
- </para>
- <para>
- When a closure is sent over a channel the closure is buffered, it doesn't change the buffering of the channel transmitting the closure,
- but it does effect the static scope inside the closure: The same closure sent to different runtimes, or the same runtime,
+ </simpara>
+ <simpara>
+ When a closure is sent over a channel the closure is buffered, it doesn't change the buffering of the channel transmitting the closure,
+ but it does effect the static scope inside the closure: The same closure sent to different runtimes, or the same runtime,
will not share their static scope.
- </para>
- <para>
+ </simpara>
+ <simpara>
This means that whenever a closure is executed that was transmitted by a channel, static state will be as it was when the closure was buffered.
- </para>
+ </simpara>
</section>
<section>
<title>Anonymous Channels</title>
- <para>
+ <simpara>
The anonymous channel constructor allows the programmer to avoid assigning names to every channel: parallel will generate a unique name for anonymous
channels.
- </para>
+ </simpara>
</section>
<section xml:id="parallel-channel.synopsis">
@@ -68,22 +67,22 @@
<classsynopsisinfo role="comment">Anonymous Constructor</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-channel')/db:refentry/db:refsect1[@audience='anonymous']/descendant::db:methodsynopsis[not(@role='procedural')])">
- <xi:fallback />
+ <xi:fallback/>
</xi:include>
<classsynopsisinfo role="comment">Access</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-channel')/db:refentry/db:refsect1[@audience='access']/descendant::db:methodsynopsis[not(@role='procedural')])">
- <xi:fallback />
+ <xi:fallback/>
</xi:include>
<classsynopsisinfo role="comment">Sharing</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-channel')/db:refentry/db:refsect1[@audience='sharing']/descendant::db:methodsynopsis[not(@role='procedural')])">
- <xi:fallback />
+ <xi:fallback/>
</xi:include>
<classsynopsisinfo role="comment">Closing</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-channel')/db:refentry/db:refsect1[@audience='close']/descendant::db:methodsynopsis[not(@role='procedural')])">
- <xi:fallback />
+ <xi:fallback/>
</xi:include>
<classsynopsisinfo role="comment">Constant for Infinitely Buffered</classsynopsisinfo>
@@ -107,7 +106,6 @@
&reference.parallel.parallel.channel.close;
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel.events.event.xml b/reference/parallel/parallel.events.event.xml
index 086ce1fbc5fc..869fda5f4587 100644
--- a/reference/parallel/parallel.events.event.xml
+++ b/reference/parallel/parallel.events.event.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.parallel-events-event" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.parallel-events-event" role="class">
<title>The parallel\Events\Event class</title>
<titleabbrev>parallel\Events\Event</titleabbrev>
@@ -10,10 +9,10 @@
<section>
<title>Event Objects</title>
- <para>
+ <simpara>
When an Event is returned, <varname>Event::$object</varname> shall be removed from the loop that returned it, should the event be a write event
the <classname>Input</classname> for <varname>Event::$source</varname> shall also be removed.
- </para>
+ </simpara>
</section>
<section xml:id="parallel-events-event.synopsis">
&reftitle.classsynopsis;
@@ -66,7 +65,6 @@
</partintro>
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel.events.input.xml b/reference/parallel/parallel.events.input.xml
index 644c958887d6..5437a18c2cf9 100644
--- a/reference/parallel/parallel.events.input.xml
+++ b/reference/parallel/parallel.events.input.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.parallel-events-input" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.parallel-events-input" role="class">
<title>The parallel\Events\Input class</title>
<titleabbrev>parallel\Events\Input</titleabbrev>
@@ -10,16 +9,16 @@
<section>
<title>Events Input</title>
- <para>
- An Input object is a container for data that the <classname>parallel\Events</classname> object will write to
- <classname>parallel\Channel</classname> objects as they become available. Multiple event loops may share an Input container - parallel does not
+ <simpara>
+ An Input object is a container for data that the <classname>parallel\Events</classname> object will write to
+ <classname>parallel\Channel</classname> objects as they become available. Multiple event loops may share an Input container - parallel does not
verify the contents of the container when it is set as the input for a <classname>parallel\Events</classname> object.
- </para>
+ </simpara>
<note>
- <para>
- When a <classname>parallel\Events</classname> object performs a write, the target is removed from the input object as if
+ <simpara>
+ When a <classname>parallel\Events</classname> object performs a write, the target is removed from the input object as if
<methodname>parallel\Events\Input::remove</methodname> were called.
- </para>
+ </simpara>
</note>
</section>
@@ -40,13 +39,13 @@
<!-- }}} -->
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-events-input')/db:refentry/db:refsect1[@audience='adding']/descendant::db:methodsynopsis[not(@role='procedural')])">
- <xi:fallback />
+ <xi:fallback/>
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-events-input')/db:refentry/db:refsect1[@audience='removing']/descendant::db:methodsynopsis[not(@role='procedural')])">
- <xi:fallback />
+ <xi:fallback/>
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-events-input')/db:refentry/db:refsect1[@audience='clearing']/descendant::db:methodsynopsis[not(@role='procedural')])">
- <xi:fallback />
+ <xi:fallback/>
</xi:include>
</classsynopsis>
@@ -59,7 +58,6 @@
&reference.parallel.parallel.entities.input;
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel.events.xml b/reference/parallel/parallel.events.xml
index 6e8cfad339ea..36364f71c00d 100644
--- a/reference/parallel/parallel.events.xml
+++ b/reference/parallel/parallel.events.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.parallel-events" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.parallel-events" role="class">
<title>The parallel\Events class</title>
<titleabbrev>parallel\Events</titleabbrev>
@@ -9,9 +8,9 @@
<partintro>
<section>
<title>The Event Loop</title>
- <para>
+ <simpara>
The Event loop monitors the state of sets of futures and or channels (targets) in order to perform read (<methodname>parallel\Future::value</methodname>, <methodname>parallel\Channel::recv</methodname>) and write (<methodname>parallel\Channel::send</methodname>) operations as the targets become available and the operations may be performed without blocking the event loop.
- </para>
+ </simpara>
</section>
<section xml:id="parallel-events.synopsis">
&reftitle.classsynopsis;
@@ -34,25 +33,25 @@
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
-
+
<classsynopsisinfo role="comment">Input</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-events')/db:refentry/db:refsect1[@audience='input']/descendant::db:methodsynopsis[not(@role='procedural')])">
- <xi:fallback />
+ <xi:fallback/>
</xi:include>
<classsynopsisinfo role="comment">Targets</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-events')/db:refentry/db:refsect1[@audience='targets']/descendant::db:methodsynopsis[not(@role='procedural')])">
- <xi:fallback />
+ <xi:fallback/>
</xi:include>
<classsynopsisinfo role="comment">Behaviour</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-events')/db:refentry/db:refsect1[@audience='behaviour']/descendant::db:methodsynopsis[not(@role='procedural')])">
- <xi:fallback />
+ <xi:fallback/>
</xi:include>
<classsynopsisinfo role="comment">Polling</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-events')/db:refentry/db:refsect1[@audience='polling']/descendant::db:methodsynopsis[not(@role='procedural')])">
- <xi:fallback />
+ <xi:fallback/>
</xi:include>
</classsynopsis>
<!-- }}} -->
@@ -70,7 +69,6 @@
&reference.parallel.parallel.events.poll;
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel.future.xml b/reference/parallel/parallel.future.xml
index cc6f1cf1cc56..18f084e479c1 100644
--- a/reference/parallel/parallel.future.xml
+++ b/reference/parallel/parallel.future.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.parallel-future" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.parallel-future" role="class">
<title>The parallel\Future class</title>
<titleabbrev>parallel\Future</titleabbrev>
@@ -10,9 +9,9 @@
<section>
<title>Futures</title>
- <para>
+ <simpara>
A Future represents the return value or uncaught exception from a task, and exposes an API for cancellation.
- </para>
+ </simpara>
<example>
<title>Example showing Future as return value</title>
<programlisting role="php">
@@ -33,9 +32,9 @@ Hello World
]]>
</screen>
</example>
- <para>
+ <simpara>
The behaviour of a future also allows it to be used as a simple synchronization point even where the task does not return a value explicitly.
- </para>
+ </simpara>
<example>
<title>Example showing Future as synchronization point</title>
<programlisting role="php">
@@ -64,7 +63,7 @@ in child .................................................. leaving child
parent continues
]]>
</screen>
- </example>
+ </example>
</section>
<section xml:id="parallel-future.synopsis">
@@ -82,20 +81,20 @@ parent continues
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
-
+
<classsynopsisinfo role="comment">Resolution</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-future')/db:refentry/db:refsect1[@audience='resolution']/descendant::db:methodsynopsis[not(@role='procedural')])">
- <xi:fallback />
+ <xi:fallback/>
</xi:include>
<classsynopsisinfo role="comment">State</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-future')/db:refentry/db:refsect1[@audience='state']/descendant::db:methodsynopsis[not(@role='procedural')])">
- <xi:fallback />
+ <xi:fallback/>
</xi:include>
<classsynopsisinfo role="comment">Cancellation</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-future')/db:refentry/db:refsect1[@audience='cancellation']/descendant::db:methodsynopsis[not(@role='procedural')])">
- <xi:fallback />
+ <xi:fallback/>
</xi:include>
</classsynopsis>
@@ -108,7 +107,6 @@ parent continues
&reference.parallel.parallel.entities.future;
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel.runtime.xml b/reference/parallel/parallel.runtime.xml
index 8ca20f1e57e0..0b1e202b0700 100644
--- a/reference/parallel/parallel.runtime.xml
+++ b/reference/parallel/parallel.runtime.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.parallel-runtime" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.parallel-runtime" role="class">
<title>The parallel\Runtime class</title>
<titleabbrev>parallel\Runtime</titleabbrev>
@@ -10,31 +9,31 @@
<section>
<title>Runtime Objects</title>
- <para>
- Each runtime represents a single PHP thread, the thread is created (and bootstrapped) upon construction.
- The thread then waits for tasks to be scheduled: Scheduled tasks will be executed FIFO and then the thread will resume waiting until
+ <simpara>
+ Each runtime represents a single PHP thread, the thread is created (and bootstrapped) upon construction.
+ The thread then waits for tasks to be scheduled: Scheduled tasks will be executed FIFO and then the thread will resume waiting until
more tasks are scheduled, or it's closed, killed, or destroyed by the normal scoping rules of PHP objects.
- </para>
+ </simpara>
<warning>
- <para>
+ <simpara>
When a runtime is destroyed by the normal scoping rules of PHP objects, it will first execute all of the tasks that were scheduled,
- and block while doing so.
- </para>
+ and block while doing so.
+ </simpara>
</warning>
</section>
<section>
<title>Runtime Bootstrapping</title>
- <para>
+ <simpara>
When a new runtime is created, it does not share code with the thread (or process) that created it. This means it doesn't have the same
classes and functions loaded, nor the same autoloader set. In some cases, a very lightweight runtime is desirable because the tasks that
will be scheduled do not need access to the code in the parent thread. In those cases where the tasks do need to access the same code, it
is enough to set an autoloader as the bootstrap.
- </para>
+ </simpara>
<note>
- <para>
+ <simpara>
preloading may be used in conjunction with parallel, in this case preloaded code is available without bootstrapping
- </para>
+ </simpara>
</note>
</section>
@@ -56,17 +55,17 @@
<classsynopsisinfo role="comment">Create</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-runtime')/db:refentry/db:refsect1[@audience='create']/descendant::db:constructorsynopsis[not(@role='procedural')])">
- <xi:fallback />
+ <xi:fallback/>
</xi:include>
<classsynopsisinfo role="comment">Execute</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-runtime')/db:refentry/db:refsect1[@audience='execute']/descendant::db:methodsynopsis[not(@role='procedural')])">
- <xi:fallback />
+ <xi:fallback/>
</xi:include>
<classsynopsisinfo role="comment">Join</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-runtime')/db:refentry/db:refsect1[@audience='join']/descendant::db:methodsynopsis[not(@role='procedural')])">
- <xi:fallback />
+ <xi:fallback/>
</xi:include>
</classsynopsis>
<!-- }}} -->
@@ -81,7 +80,6 @@
&reference.parallel.parallel.runtime.kill;
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel.sync.xml b/reference/parallel/parallel.sync.xml
index 9e47ac76dfaf..d533c4fe18c5 100644
--- a/reference/parallel/parallel.sync.xml
+++ b/reference/parallel/parallel.sync.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.parallel-sync" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.parallel-sync" role="class">
<title>The parallel\Sync class</title>
<titleabbrev>parallel\Sync</titleabbrev>
@@ -9,14 +8,14 @@
<partintro>
<section>
<title>Low Level Synchronization</title>
- <para>
+ <simpara>
The <classname>parallel\Sync</classname> class provides access to low level synchronization primitives, mutex, condition variables, and allows the implementation of semaphores.
- </para>
+ </simpara>
- <para>
+ <simpara>
Synchronization for most applications is much better implemented using channels, however, in some cases authors of low level code may find it useful to be able to access
these lower level mechanisms.
- </para>
+ </simpara>
</section>
@@ -38,17 +37,17 @@
<classsynopsisinfo role="comment">Constructor</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-sync')/db:refentry/db:refsect1[@audience='construction']/descendant::db:methodsynopsis[not(@role='procedural')])">
- <xi:fallback />
+ <xi:fallback/>
</xi:include>
<classsynopsisinfo role="comment">Access</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-sync')/db:refentry/db:refsect1[@audience='access']/descendant::db:methodsynopsis[not(@role='procedural')])">
- <xi:fallback />
+ <xi:fallback/>
</xi:include>
<classsynopsisinfo role="comment">Synchronization</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parallel-sync')/db:refentry/db:refsect1[@audience='synchronization']/descendant::db:methodsynopsis[not(@role='procedural')])">
- <xi:fallback />
+ <xi:fallback/>
</xi:include>
</classsynopsis>
@@ -66,7 +65,6 @@
&reference.parallel.parallel.sync.invoke;
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/channel/close.xml b/reference/parallel/parallel/channel/close.xml
index 591110324a51..81abefb52607 100644
--- a/reference/parallel/parallel/channel/close.xml
+++ b/reference/parallel/parallel/channel/close.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-channel.close" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-channel.close">
<refnamediv>
<refname>parallel\Channel::close</refname>
<refpurpose>Closing</refpurpose>
@@ -11,25 +10,24 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>parallel\Channel::close</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Shall close this channel
- </para>
+ </simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Channel\Error\Closed</type> if channel is closed.
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/channel/construct.xml b/reference/parallel/parallel/channel/construct.xml
index a50376d2209f..69bd167132d9 100644
--- a/reference/parallel/parallel/channel/construct.xml
+++ b/reference/parallel/parallel/channel/construct.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-channel.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-channel.construct">
<refnamediv>
<refname>parallel\Channel::__construct</refname>
<refpurpose>Channel Construction</refpurpose>
@@ -11,18 +10,18 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>parallel\Channel::__construct</methodname>
- <void/>
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Shall make an anonymous unbuffered channel
- </para>
+ </simpara>
<methodsynopsis>
<modifier>public</modifier> <methodname>parallel\Channel::__construct</methodname>
<methodparam><type>int</type><parameter>capacity</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall make an anonymous buffered channel with the given capacity
- </para>
+ </simpara>
</refsect1>
@@ -32,16 +31,15 @@
<varlistentry>
<term><parameter>capacity</parameter></term>
<listitem>
- <para>
+ <simpara>
May be <type>Channel::Infinite</type> or a positive integer
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/channel/make.xml b/reference/parallel/parallel/channel/make.xml
index af78837857a0..2559bf8c14e2 100644
--- a/reference/parallel/parallel/channel/make.xml
+++ b/reference/parallel/parallel/channel/make.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-channel.make" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-channel.make">
<refnamediv>
<refname>parallel\Channel::make</refname>
<refpurpose>Access</refpurpose>
@@ -13,17 +12,17 @@
<modifier>public</modifier> <type>Channel</type><methodname>parallel\Channel::make</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall make an unbuffered channel with the given name
- </para>
+ </simpara>
<methodsynopsis>
<modifier>public</modifier> <type>Channel</type><methodname>parallel\Channel::make</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>int</type><parameter>capacity</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall make a buffered channel with the given name and capacity
- </para>
+ </simpara>
</refsect1>
@@ -33,17 +32,17 @@
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
- <para>
+ <simpara>
The name of the channel.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>capacity</parameter></term>
<listitem>
- <para>
+ <simpara>
May be <type>Channel::Infinite</type> or a positive integer
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -52,14 +51,13 @@
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Channel\Error\Existence</type> if channel already exists.
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/channel/open.xml b/reference/parallel/parallel/channel/open.xml
index bc78a71f0a4e..1a117d431de3 100644
--- a/reference/parallel/parallel/channel/open.xml
+++ b/reference/parallel/parallel/channel/open.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-channel.open" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-channel.open">
<refnamediv>
<refname>parallel\Channel::open</refname>
<refpurpose>Access</refpurpose>
@@ -13,23 +12,22 @@
<modifier>public</modifier> <type>Channel</type><methodname>parallel\Channel::open</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall open the channel with the given name
- </para>
+ </simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Channel\Error\Existence</type> if channel does not exist.
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/channel/recv.xml b/reference/parallel/parallel/channel/recv.xml
index f89e15220379..245a8de6ece1 100644
--- a/reference/parallel/parallel/channel/recv.xml
+++ b/reference/parallel/parallel/channel/recv.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-channel.recv" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-channel.recv">
<refnamediv>
<refname>parallel\Channel::recv</refname>
<refpurpose>Sharing</refpurpose>
@@ -11,25 +10,24 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>parallel\Channel::recv</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Shall recv a value from this channel
- </para>
+ </simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Channel\Error\Closed</type> if channel is closed.
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/channel/send.xml b/reference/parallel/parallel/channel/send.xml
index 3d8d0c70331d..fde8399f9b87 100644
--- a/reference/parallel/parallel/channel/send.xml
+++ b/reference/parallel/parallel/channel/send.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-channel.send" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-channel.send">
<refnamediv>
<refname>parallel\Channel::send</refname>
<refpurpose>Sharing</refpurpose>
@@ -13,28 +12,27 @@
<modifier>public</modifier> <type>void</type><methodname>parallel\Channel::send</methodname>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall send the given value on this channel
- </para>
+ </simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Channel\Error\Closed</type> if channel is closed.
- </para>
+ </simpara>
</warning>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Channel\Error\IllegalValue</type> if value is illegal.
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/events/addchannel.xml b/reference/parallel/parallel/events/addchannel.xml
index cfffdaa62e10..ea780221db62 100644
--- a/reference/parallel/parallel/events/addchannel.xml
+++ b/reference/parallel/parallel/events/addchannel.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-events.addchannel" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-events.addchannel">
<refnamediv>
<refname>parallel\Events::addChannel</refname>
<refpurpose>Targets</refpurpose>
@@ -13,22 +12,21 @@
<modifier>public</modifier> <type>void</type><methodname>parallel\Events::addChannel</methodname>
<methodparam><type>parallel\Channel</type><parameter>channel</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall watch for events on the given <parameter>channel</parameter>
- </para>
+ </simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Events\Error\Existence</type> if channel was already added.
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/events/addfuture.xml b/reference/parallel/parallel/events/addfuture.xml
index a736fa49d531..44365caa5477 100644
--- a/reference/parallel/parallel/events/addfuture.xml
+++ b/reference/parallel/parallel/events/addfuture.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-events.addfuture" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-events.addfuture">
<refnamediv>
<refname>parallel\Events::addFuture</refname>
<refpurpose>Targets</refpurpose>
@@ -14,22 +13,21 @@
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>parallel\Future</type><parameter>future</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall watch for events on the given <parameter>future</parameter>
- </para>
+ </simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Events\Error\Existence</type> if target with the given name was already added.
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/events/poll.xml b/reference/parallel/parallel/events/poll.xml
index 601ce5eb5a06..86074a52a3ed 100644
--- a/reference/parallel/parallel/events/poll.xml
+++ b/reference/parallel/parallel/events/poll.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-events.poll" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-events.poll">
<refnamediv>
<refname>parallel\Events::poll</refname>
<refpurpose>Polling</refpurpose>
@@ -11,37 +10,36 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>parallel\Events\Event</type><type>null</type></type><methodname>parallel\Events::poll</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Shall poll for the next event
- </para>
+ </simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Should there be no targets remaining, &null; shall be returned
- </para>
- <para>
+ </simpara>
+ <simpara>
Should this be a non-blocking loop, and blocking would occur, &null; shall be returned
- </para>
- <para>
+ </simpara>
+ <simpara>
Otherwise, the <classname>parallel\Events\Event</classname> returned describes the event.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Events\Error\Timeout</type> if timeout is used and reached.
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/events/remove.xml b/reference/parallel/parallel/events/remove.xml
index b3520c09443d..306f00f4c036 100644
--- a/reference/parallel/parallel/events/remove.xml
+++ b/reference/parallel/parallel/events/remove.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-events.remove" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-events.remove">
<refnamediv>
<refname>parallel\Events::remove</refname>
<refpurpose>Targets</refpurpose>
@@ -13,22 +12,21 @@
<modifier>public</modifier> <type>void</type><methodname>parallel\Events::remove</methodname>
<methodparam><type>string</type><parameter>target</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall remove the given <parameter>target</parameter>
- </para>
+ </simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Events\Error\Existence</type> if target with the given name was not found.
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/events/setblocking.xml b/reference/parallel/parallel/events/setblocking.xml
index 1eb3889c7f85..ef6bcee77269 100644
--- a/reference/parallel/parallel/events/setblocking.xml
+++ b/reference/parallel/parallel/events/setblocking.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-events.setblocking" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-events.setblocking">
<refnamediv>
<refname>parallel\Events::setBlocking</refname>
<refpurpose>Behaviour</refpurpose>
@@ -9,37 +8,36 @@
<refsect1 role="description" audience="behaviour">
&reftitle.description;
- <para>
+ <simpara>
By default when events are polled for, blocking will occur (at the PHP level) until the first event can be returned: Setting blocking mode to &false; will cause
poll to return control if the first target polled is not ready.
- </para>
- <para>
- This differs from setting a timeout of 0 with <methodname>parallel\Events::setTimeout</methodname>, since a timeout of 0, while allowed, will cause an exception
+ </simpara>
+ <simpara>
+ This differs from setting a timeout of 0 with <methodname>parallel\Events::setTimeout</methodname>, since a timeout of 0, while allowed, will cause an exception
to be raised, which may be extremely slow or wasteful if what is really desired is non-blocking behaviour.
- </para>
- <para>
+ </simpara>
+ <simpara>
A non-blocking loop effects the return value of <methodname>parallel\Events::poll</methodname>, such that it may be &null; before all events have been processed.
- </para>
+ </simpara>
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>parallel\Events::setBlocking</methodname>
<methodparam><type>bool</type><parameter>blocking</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall set blocking mode
- </para>
+ </simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Events\Error</type> if loop has timeout set.
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/events/setinput.xml b/reference/parallel/parallel/events/setinput.xml
index c3a575f7e0fe..df0324f75418 100644
--- a/reference/parallel/parallel/events/setinput.xml
+++ b/reference/parallel/parallel/events/setinput.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-events.setinput" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-events.setinput">
<refnamediv>
<refname>parallel\Events::setInput</refname>
<refpurpose>Input</refpurpose>
@@ -13,13 +12,12 @@
<modifier>public</modifier> <type>void</type><methodname>parallel\Events::setInput</methodname>
<methodparam><type>Input</type><parameter>input</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall set <parameter>input</parameter> for this event loop
- </para>
+ </simpara>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/events/settimeout.xml b/reference/parallel/parallel/events/settimeout.xml
index 64518bcdc76d..6f4123b27c71 100644
--- a/reference/parallel/parallel/events/settimeout.xml
+++ b/reference/parallel/parallel/events/settimeout.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-events.settimeout" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-events.settimeout">
<refnamediv>
<refname>parallel\Events::setTimeout</refname>
<refpurpose>Behaviour</refpurpose>
@@ -9,33 +8,32 @@
<refsect1 role="description" audience="behaviour">
&reftitle.description;
- <para>
+ <simpara>
By default when events are polled for, blocking will occur (at the PHP level) until the first event can be returned: Setting the timeout causes an exception to be
thrown when the timeout is reached.
- </para>
- <para>
+ </simpara>
+ <simpara>
This differs from setting blocking mode to &false; with <methodname>parallel\Events::setBlocking</methodname>, which will not cause an exception to be thrown.
- </para>
+ </simpara>
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>parallel\Events::setTimeout</methodname>
<methodparam><type>int</type><parameter>timeout</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall set the timeout in microseconds
- </para>
+ </simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Events\Error</type> if loop is non-blocking.
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/future/cancel.xml b/reference/parallel/parallel/future/cancel.xml
index 1189301345c8..a658dd01ce46 100644
--- a/reference/parallel/parallel/future/cancel.xml
+++ b/reference/parallel/parallel/future/cancel.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-future.cancel" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-future.cancel">
<refnamediv>
<refname>parallel\Future::cancel</refname>
<refpurpose>Cancellation</refpurpose>
@@ -11,39 +10,38 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>parallel\Future::cancel</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Shall try to cancel the task
- </para>
+ </simpara>
<note>
- <para>
+ <simpara>
If task is running, it will be interrupted.
- </para>
+ </simpara>
</note>
<warning>
- <para>
+ <simpara>
Internal function calls in progress cannot be interrupted.
- </para>
+ </simpara>
</warning>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Future\Error\Killed</type> if <type>parallel\Runtime</type> executing task was killed.
- </para>
+ </simpara>
</warning>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Future\Error\Cancelled</type> if task was already cancelled.
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/future/cancelled.xml b/reference/parallel/parallel/future/cancelled.xml
index b17b9ad23533..855b2a7ff7d9 100644
--- a/reference/parallel/parallel/future/cancelled.xml
+++ b/reference/parallel/parallel/future/cancelled.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-future.cancelled" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-future.cancelled">
<refnamediv>
<refname>parallel\Future::cancelled</refname>
<refpurpose>State Detection</refpurpose>
@@ -11,16 +10,15 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>parallel\Future::cancelled</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Shall indicate if the task was cancelled
- </para>
+ </simpara>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/future/done.xml b/reference/parallel/parallel/future/done.xml
index b4e4ad0ccbda..ad17c389448a 100644
--- a/reference/parallel/parallel/future/done.xml
+++ b/reference/parallel/parallel/future/done.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-future.done" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-future.done">
<refnamediv>
<refname>parallel\Future::done</refname>
<refpurpose>State Detection</refpurpose>
@@ -11,16 +10,15 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>parallel\Future::done</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Shall indicate if the task is completed
- </para>
+ </simpara>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/future/value.xml b/reference/parallel/parallel/future/value.xml
index 16bd571db2c0..d3f1e77f3e41 100644
--- a/reference/parallel/parallel/future/value.xml
+++ b/reference/parallel/parallel/future/value.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-future.value" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-future.value">
<refnamediv>
<refname>parallel\Future::value</refname>
<refpurpose>Resolution</refpurpose>
@@ -11,45 +10,44 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>parallel\Future::value</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Shall return (and if necessary wait for) return from task
- </para>
+ </simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Future\Error</type> if waiting failed (internal error).
- </para>
+ </simpara>
</warning>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Future\Error\Killed</type> if <type>parallel\Runtime</type> executing task was killed.
- </para>
+ </simpara>
</warning>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Future\Error\Cancelled</type> if task was cancelled.
- </para>
+ </simpara>
</warning>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Future\Error\Foreign</type> if task raised an unrecognized uncaught exception.
- </para>
+ </simpara>
</warning>
<warning>
- <para>
+ <simpara>
Shall rethrow <type>Throwable</type> uncaught in task
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/input/add.xml b/reference/parallel/parallel/input/add.xml
index 36a6638488f9..618477679f9c 100644
--- a/reference/parallel/parallel/input/add.xml
+++ b/reference/parallel/parallel/input/add.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-events-input.add" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-events-input.add">
<refnamediv>
<refname>parallel\Events\Input::add</refname>
<refpurpose>Inputs</refpurpose>
@@ -14,27 +13,26 @@
<methodparam><type>string</type><parameter>target</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall set input for the given target
- </para>
+ </simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Events\Input\Error\Existence</type> if input for target already exists.
- </para>
+ </simpara>
</warning>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Events\Input\Error\IllegalValue</type> if value is illegal (&object;, &null;).
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/input/clear.xml b/reference/parallel/parallel/input/clear.xml
index 6cd562bd5b95..af70b6762594 100644
--- a/reference/parallel/parallel/input/clear.xml
+++ b/reference/parallel/parallel/input/clear.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-events-input.clear" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-events-input.clear">
<refnamediv>
<refname>parallel\Events\Input::clear</refname>
<refpurpose>Inputs</refpurpose>
@@ -11,15 +10,14 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>parallel\Events\Input::clear</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Shall remove input for all targets
- </para>
+ </simpara>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/input/remove.xml b/reference/parallel/parallel/input/remove.xml
index adf313a6f695..23444d774cd8 100644
--- a/reference/parallel/parallel/input/remove.xml
+++ b/reference/parallel/parallel/input/remove.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-events-input.remove" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-events-input.remove">
<refnamediv>
<refname>parallel\Events\Input::remove</refname>
<refpurpose>Inputs</refpurpose>
@@ -13,22 +12,21 @@
<modifier>public</modifier> <type>void</type><methodname>parallel\Events\Input::remove</methodname>
<methodparam><type>string</type><parameter>target</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall remove input for the given target
- </para>
+ </simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Events\Input\Error\Existence</type> if input for target does not exist.
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/runtime/close.xml b/reference/parallel/parallel/runtime/close.xml
index 34c5640051d8..ab42e072d89e 100644
--- a/reference/parallel/parallel/runtime/close.xml
+++ b/reference/parallel/parallel/runtime/close.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-runtime.close" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-runtime.close">
<refnamediv>
<refname>parallel\Runtime::close</refname>
<refpurpose>Runtime Graceful Join</refpurpose>
@@ -11,30 +10,29 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>parallel\Runtime::close</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Shall request that the runtime shutsdown.
- </para>
+ </simpara>
<note>
- <para>
+ <simpara>
Tasks scheduled for execution will be executed before the shutdown occurs.
- </para>
+ </simpara>
</note>
</refsect1>
-
+
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Runtime\Error\Closed</type> if <type>Runtime</type> was already closed.
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/runtime/construct.xml b/reference/parallel/parallel/runtime/construct.xml
index 3cd842082a26..1d402835297c 100644
--- a/reference/parallel/parallel/runtime/construct.xml
+++ b/reference/parallel/parallel/runtime/construct.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-runtime.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-runtime.construct">
<refnamediv>
<refname>parallel\Runtime::__construct</refname>
<refpurpose>Runtime Construction</refpurpose>
@@ -11,18 +10,18 @@
&reftitle.description;
<constructorsynopsis>
<modifier>public</modifier> <methodname>parallel\Runtime::__construct</methodname>
- <void />
+ <void/>
</constructorsynopsis>
- <para>
+ <simpara>
Shall construct a new runtime without bootstrapping.
- </para>
+ </simpara>
<constructorsynopsis>
<modifier>public</modifier> <methodname>parallel\Runtime::__construct</methodname>
<methodparam><type>string</type><parameter>bootstrap</parameter></methodparam>
</constructorsynopsis>
- <para>
+ <simpara>
Shall construct a bootstrapped runtime.
- </para>
+ </simpara>
</refsect1>
@@ -32,30 +31,29 @@
<varlistentry>
<term><parameter>bootstrap</parameter></term>
<listitem>
- <para>
+ <simpara>
The location of a bootstrap file, generally an autoloader.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
-
+
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Runtime\Error</type> if thread could not be created
- </para>
+ </simpara>
</warning>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Runtime\Bootstrap</type> if bootstrapping failed
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/runtime/kill.xml b/reference/parallel/parallel/runtime/kill.xml
index d124f08805eb..69948af15752 100644
--- a/reference/parallel/parallel/runtime/kill.xml
+++ b/reference/parallel/parallel/runtime/kill.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-runtime.kill" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-runtime.kill">
<refnamediv>
<refname>parallel\Runtime::kill</refname>
<refpurpose>Runtime Join</refpurpose>
@@ -11,35 +10,34 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>parallel\Runtime::kill</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Shall attempt to force the runtime to shutdown.
- </para>
+ </simpara>
<note>
- <para>
+ <simpara>
Tasks scheduled for execution will not be executed, the currently running task shall be interrupted.
- </para>
+ </simpara>
</note>
<warning>
- <para>
+ <simpara>
Internal function calls in progress cannot be interrupted.
- </para>
+ </simpara>
</warning>
</refsect1>
-
+
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Runtime\Error\Closed</type> if <type>Runtime</type> was closed.
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/runtime/run.xml b/reference/parallel/parallel/runtime/run.xml
index c2d874f125cd..39b06180a9fe 100644
--- a/reference/parallel/parallel/runtime/run.xml
+++ b/reference/parallel/parallel/runtime/run.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-runtime.run" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-runtime.run">
<refnamediv>
<refname>parallel\Runtime::run</refname>
<refpurpose>Execution</refpurpose>
@@ -13,17 +12,17 @@
<modifier>public</modifier> <type class="union"><type>Future</type><type>null</type></type><methodname>parallel\Runtime::run</methodname>
<methodparam><type>Closure</type><parameter>task</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall schedule <parameter>task</parameter> for execution in parallel.
- </para>
+ </simpara>
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>Future</type><type>null</type></type><methodname>parallel\Runtime::run</methodname>
<methodparam><type>Closure</type><parameter>task</parameter></methodparam>
<methodparam><type>array</type><parameter>argv</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall schedule <parameter>task</parameter> for execution in parallel, passing <parameter>argv</parameter> at execution time.
- </para>
+ </simpara>
</refsect1>
@@ -33,22 +32,22 @@
<varlistentry>
<term><parameter>task</parameter></term>
<listitem>
- <para>
+ <simpara>
A <classname>Closure</classname> with specific characteristics.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>argv</parameter></term>
<listitem>
- <para>
+ <simpara>
An <type>array</type> of arguments with specific characteristics to be passed to <parameter>task</parameter> at execution time.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
-
+
<refsect1 role="closure-characteristics">
<title>Task Characteristics</title>
<para>
@@ -69,17 +68,17 @@
</simplelist>
</para>
<note>
- <para>
+ <simpara>
Nested closures may yield or use by-reference, but must not contain class or named function declarations.
- </para>
+ </simpara>
</note>
<note>
- <para>
+ <simpara>
No instructions are prohibited in the files which the task may include.
- </para>
+ </simpara>
</note>
</refsect1>
-
+
<refsect1 role="argv-characteristics">
<title>Arguments Characteristics</title>
<para>
@@ -90,76 +89,75 @@
<member>contain internal objects (see notes)</member>
</simplelist>
<note>
- <para>
+ <simpara>
In the case of file stream resources, the resource will be cast to the file descriptor and passed as <type>int</type> where possible, this is unsupported on Windows.
- </para>
+ </simpara>
</note>
</para>
</refsect1>
<refsect1 role="object-characteristics">
<title>Internal Objects Notes</title>
- <para>
- Internal objects generally use a custom structure which cannot be copied by value safely, PHP currently lacks the mechanics to do this (without serialization)
+ <simpara>
+ Internal objects generally use a custom structure which cannot be copied by value safely, PHP currently lacks the mechanics to do this (without serialization)
and so only objects that do not use a custom structure may be shared.
- </para>
- <para>
+ </simpara>
+ <simpara>
Some internal objects do not use a custom structure, for example <classname>parallel\Events\Event</classname> and so may be shared.
- </para>
- <para>
+ </simpara>
+ <simpara>
Closures are a special kind of internal object and support being copied by value, and so may be shared.
- </para>
- <para>
+ </simpara>
+ <simpara>
Channels are central to writing parallel code and support concurrent access and execution by necessity, and so may be shared.
- </para>
+ </simpara>
<warning>
- <para>
- A user class that extends an internal class may use a custom structure as defined by the internal class, in which case they cannot be copied by value safely,
+ <simpara>
+ A user class that extends an internal class may use a custom structure as defined by the internal class, in which case they cannot be copied by value safely,
and so may not be shared.
- </para>
+ </simpara>
</warning>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<warning>
- <para>
+ <simpara>
The return <type>parallel\Future</type> must not be ignored when the task contains a return or throw statement.
- </para>
+ </simpara>
</warning>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Runtime\Error\Closed</type> if <type>parallel\Runtime</type> was closed.
- </para>
+ </simpara>
</warning>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Runtime\Error\IllegalFunction</type> if <parameter>task</parameter> is a closure created from an internal function.
- </para>
+ </simpara>
</warning>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Runtime\Error\IllegalInstruction</type> if <parameter>task</parameter> contains illegal instructions.
- </para>
+ </simpara>
</warning>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Runtime\Error\IllegalParameter</type> if <parameter>task</parameter> accepts or <parameter>argv</parameter> contains illegal variables.
- </para>
+ </simpara>
</warning>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Runtime\Error\IllegalReturn</type> if <parameter>task</parameter> returns illegally.
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/sync/construct.xml b/reference/parallel/parallel/sync/construct.xml
index 91ae9db2974a..637f799ff392 100644
--- a/reference/parallel/parallel/sync/construct.xml
+++ b/reference/parallel/parallel/sync/construct.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-sync.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-sync.construct">
<refnamediv>
<refname>parallel\Sync::__construct</refname>
<refpurpose>Construction</refpurpose>
@@ -11,33 +10,32 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>parallel\Sync::__construct</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Shall construct a new synchronization object with no value
- </para>
+ </simpara>
<methodsynopsis>
<modifier>public</modifier> <methodname>parallel\Sync::__construct</methodname>
<methodparam><type>scalar</type><parameter>value</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall construct a new synchronization object containing the given scalar value
- </para>
+ </simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Sync\Error\IllegalValue</type> if <parameter>value</parameter> is non-scalar.
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/sync/get.xml b/reference/parallel/parallel/sync/get.xml
index 566ba1650d30..8a40daf295e4 100644
--- a/reference/parallel/parallel/sync/get.xml
+++ b/reference/parallel/parallel/sync/get.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-sync.get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-sync.get">
<refnamediv>
<refname>parallel\Sync::get</refname>
<refpurpose>Access</refpurpose>
@@ -11,16 +10,15 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>scalar</type><methodname>parallel\Sync::get</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Shall atomically return the synchronization objects value
- </para>
+ </simpara>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/sync/invoke.xml b/reference/parallel/parallel/sync/invoke.xml
index 0413f333b6e1..6903f5a170b8 100644
--- a/reference/parallel/parallel/sync/invoke.xml
+++ b/reference/parallel/parallel/sync/invoke.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-sync.invoke" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-sync.invoke">
<refnamediv>
<refname>parallel\Sync::__invoke</refname>
<refpurpose>Synchronization</refpurpose>
@@ -13,14 +12,13 @@
<modifier>public</modifier> <methodname>parallel\Sync::__invoke</methodname>
<methodparam><type>callable</type><parameter>critical</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall exclusively enter into the critical code
- </para>
+ </simpara>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/sync/notify.xml b/reference/parallel/parallel/sync/notify.xml
index 32b94eaf66f4..91adea8cc5cd 100644
--- a/reference/parallel/parallel/sync/notify.xml
+++ b/reference/parallel/parallel/sync/notify.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-sync.notify" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-sync.notify">
<refnamediv>
<refname>parallel\Sync::notify</refname>
<refpurpose>Synchronization</refpurpose>
@@ -13,14 +12,13 @@
<modifier>public</modifier> <methodname>parallel\Sync::notify</methodname>
<methodparam choice="opt"><type>bool</type><parameter>all</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall notify one (by default) or all threads waiting on the synchronization object
- </para>
+ </simpara>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/sync/set.xml b/reference/parallel/parallel/sync/set.xml
index 284df393b126..543b6a634d9f 100644
--- a/reference/parallel/parallel/sync/set.xml
+++ b/reference/parallel/parallel/sync/set.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-sync.set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-sync.set">
<refnamediv>
<refname>parallel\Sync::set</refname>
<refpurpose>Access</refpurpose>
@@ -13,23 +12,22 @@
<modifier>public</modifier> <methodname>parallel\Sync::set</methodname>
<methodparam><type>scalar</type><parameter>value</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Shall atomically set the value of the synchronization object
- </para>
+ </simpara>
</refsect1>
<refsect1 role="exceptions">
<title>Exceptions</title>
<warning>
- <para>
+ <simpara>
Shall throw <type>parallel\Sync\Error\IllegalValue</type> if <parameter>value</parameter> is non-scalar.
- </para>
+ </simpara>
</warning>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/parallel/sync/wait.xml b/reference/parallel/parallel/sync/wait.xml
index b893da2f2242..df573818f81f 100644
--- a/reference/parallel/parallel/sync/wait.xml
+++ b/reference/parallel/parallel/sync/wait.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="parallel-sync.wait" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel-sync.wait">
<refnamediv>
<refname>parallel\Sync::wait</refname>
<refpurpose>Synchronization</refpurpose>
@@ -11,16 +10,15 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>parallel\Sync::wait</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Shall wait for notification on this synchronization object
- </para>
+ </simpara>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/philosophy.xml b/reference/parallel/philosophy.xml
index a2d08dea66e2..28eebbfd3f5f 100644
--- a/reference/parallel/philosophy.xml
+++ b/reference/parallel/philosophy.xml
@@ -1,60 +1,58 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<chapter xml:id="philosophy.parallel" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="philosophy.parallel">
<title>Philosophy</title>
- <para>
+ <simpara>
This section contains philosophies important to writing parallel code and some details about the internal implementation of parallel.
- </para>
+ </simpara>
<simplesect role="sharing">
<title>Do not communicate by sharing memory; instead, share memory by communicating.</title>
- <para>
- This philosophy which is embraced by parallel has its origins in Go, one of the most widely admired if not used platforms for writing parallel code at the moment.
+ <simpara>
+ This philosophy which is embraced by parallel has its origins in Go, one of the most widely admired if not used platforms for writing parallel code at the moment.
Go programmers have to work hard to live up to this ideal: PHP and parallel do all the hard work for the programmer, and by default.
- </para>
- <para>
- In conventional threading models found in other languages, generally threads are communicating with one another through nothing more than by virtue of the fact that
+ </simpara>
+ <simpara>
+ In conventional threading models found in other languages, generally threads are communicating with one another through nothing more than by virtue of the fact that
they operate in the same address space.
- The programmer must deploy mutual exclusion, condition variables, and other low level threading or synchronization primitives in order to ensure proper communication
+ The programmer must deploy mutual exclusion, condition variables, and other low level threading or synchronization primitives in order to ensure proper communication
of state and consistency.
- </para>
- <para>
+ </simpara>
+ <simpara>
When the conventional model is inversed, it means that threads only share memory as a result of communication (a variable is passed over a Channel for example).
- </para>
- <para>
- When parallel passes a variable from one thread to another by any means - Task arguments, return via Future, and Channels - it is passed by value.
- In all but the case of unbuffered channels, the variable is also buffered so that it may not change (or be destroyed) before it is used in whichever thread the variable
- is being passed to. An unbuffered read over a channel is the only instance in which a thread directly reads memory allocated by another thread, it can do so safely because
+ </simpara>
+ <simpara>
+ When parallel passes a variable from one thread to another by any means - Task arguments, return via Future, and Channels - it is passed by value.
+ In all but the case of unbuffered channels, the variable is also buffered so that it may not change (or be destroyed) before it is used in whichever thread the variable
+ is being passed to. An unbuffered read over a channel is the only instance in which a thread directly reads memory allocated by another thread, it can do so safely because
the thread that owns the memory is waiting for the read to complete before it can continue to manipulate it, and the thread that does not own the memory reads by value. When
both threads continue, they are no longer sharing memory.
- </para>
- <para>
- This makes writing and reasoning about parallel code much easier than the conventional model of threading. It means the programmer does not need to consider that threads
+ </simpara>
+ <simpara>
+ This makes writing and reasoning about parallel code much easier than the conventional model of threading. It means the programmer does not need to consider that threads
may be manipulating data concurrently, because that is not possible.
- </para>
- <para>
- This also makes PHP the perfect platform for implementing a parallel concurrency API based on CSP (message passing over channels), because PHP itself is shared nothing -
+ </simpara>
+ <simpara>
+ This also makes PHP the perfect platform for implementing a parallel concurrency API based on CSP (message passing over channels), because PHP itself is shared nothing -
PHP threads operate in their own virtual address space by default, and so may only share memory by communicating.
- </para>
+ </simpara>
</simplesect>
<simplesect role="owning">
<title>Data should have a definitive single owner</title>
- <para>
+ <simpara>
When approaching the CSP model for the first time, a programmer versed in the traditional model of threading may find themselves looking for concurrent data structures,
because that is what they are used too: they pass around shared objects for manipulation.
- </para>
- <para>
- When it comes to the CSP model, there is no need for data structures to be shared by many tasks, and indeed, it is simpler if they are not. The data should be owned
- by a single task, changes to (or operations on) that data structure should be communicated over channels and performed by the owner of the data, the success, failure,
+ </simpara>
+ <simpara>
+ When it comes to the CSP model, there is no need for data structures to be shared by many tasks, and indeed, it is simpler if they are not. The data should be owned
+ by a single task, changes to (or operations on) that data structure should be communicated over channels and performed by the owner of the data, the success, failure,
or result (state) of the change (or operation) being communicated back.
- </para>
- <para>
- Once again the share nothing nature of PHP and copy by value nature of parallel helps the programmer to achieve this goal, no data will be shared by accident,
+ </simpara>
+ <simpara>
+ Once again the share nothing nature of PHP and copy by value nature of parallel helps the programmer to achieve this goal, no data will be shared by accident,
only ever as a result of communication.
- </para>
+ </simpara>
</simplesect>
</chapter>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/parallel/setup.xml b/reference/parallel/setup.xml
index b685e87f083d..17b6c65b6ad6 100644
--- a/reference/parallel/setup.xml
+++ b/reference/parallel/setup.xml
@@ -1,45 +1,43 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<chapter xml:id="parallel.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="parallel.setup">
<title>Installation</title>
<simplesect xml:id="parallel.requirements">
&reftitle.required;
- <para>
+ <simpara>
parallel requires a build of PHP with ZTS (Zend Thread Safety) enabled
(<option role="configure">--enable-zts</option>, or on non-Windows systems prior to PHP 8.0.0,
<option role="configure">--enable-maintainer-zts</option>)
- </para>
+ </simpara>
<caution>
- <para>
+ <simpara>
Zend Thread Safety cannot be enabled post build; it is a build time configuration option.
- </para>
+ </simpara>
</caution>
- <para>
+ <simpara>
parallel should build anywhere there is a working Posix Threads header (pthread.h) and ZTS build of PHP, including Windows (using the pthread-w32 project from redhat).
- </para>
+ </simpara>
</simplesect>
<simplesect xml:id="parallel.installation">
&reftitle.install;
- <para>
- parallel releases are hosted by PECL and the source code by
- <link xlink:href="&url.git.hub;krakjoe/parallel">github</link>,
+ <simpara>
+ parallel releases are hosted by PECL and the source code by
+ <link xlink:href="&url.git.hub;krakjoe/parallel">github</link>,
the easiest route to installation is the normal PECL route:
<link xlink:href="&url.pecl.package;parallel">&url.pecl.package;parallel</link>.
- </para>
- <para>
+ </simpara>
+ <simpara>
Windows users can download prebuilt release binaries from the <link xlink:href="&url.pecl.package;parallel">PECL</link> website.
- </para>
+ </simpara>
<caution>
- <para>
+ <simpara>
Windows users need to take the additional step of adding <filename>pthreadVC<replaceable>?</replaceable>.dll</filename> (distributed with Windows releases) to their <envar>PATH</envar>.
- </para>
+ </simpara>
</caution>
</simplesect>
</chapter>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml