sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 08:58:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

remove evil tabs

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@327787 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Joe Watkins 2012-09-25 20:42:14 +00:00
parent 8c5785c3d9
commit e714aaa78f
41 changed files with 143 additions and 280 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
reference/pthreads/book.xml
View file

@ -7,9 +7,7 @@
<preface xml:id="intro.pthreads">
&reftitle.intro;
<para>
pthreads uses the well tested abilities of TSRM and PHP to provide compatible mult-threading capabilities.
</para>
<para>pthreads uses the well tested abilities of TSRM and PHP to provide compatible mult-threading capabilities.</para>
</preface>
&reference.pthreads.setup;

6
reference/pthreads/cond.xml
View file

@ -13,9 +13,9 @@
&reftitle.intro;
<para>The following paragraph is taken from the Posix Thread documentation to explain the purpose of Condition Variables:</para>
<para>
Condition variables provide yet another way for threads to synchronize. While mutexes implement synchronization by controlling thread access to data, condition variables allow threads to synchronize based upon the actual value of data.
Without condition variables, the programmer would need to have threads continually polling (possibly in a critical section), to check if the condition is met. This can be very resource consuming since the thread would be continuously busy in this activity. A condition variable is a way to achieve the same goal without polling.
A condition variable is always used in conjunction with a mutex lock.
Condition variables provide yet another way for threads to synchronize. While mutexes implement synchronization by controlling thread access to data, condition variables allow threads to synchronize based upon the actual value of data.
Without condition variables, the programmer would need to have threads continually polling (possibly in a critical section), to check if the condition is met. This can be very resource consuming since the thread would be continuously busy in this activity. A condition variable is a way to achieve the same goal without polling.
A condition variable is always used in conjunction with a mutex lock.
</para>
<para>pthreads provides PHP with direct acces to a carefully selected subset of Condition Variable functions.</para>
<para>Because of their nature, the programmer must take care to destroy Condition Variable handles they are finished with.</para>

8
reference/pthreads/cond/broadcast.xml
View file

@ -20,9 +20,7 @@
<parameter>condition</parameter>
</methodparam>
</methodsynopsis>
<para>
Broadcast to all Threads blocking on a call to <function>Cond::wait</function>.
</para>
<para>Broadcast to all Threads blocking on a call to <function>Cond::wait</function>.</para>
</refsect1>
<refsect1 role="parameters">
@ -31,9 +29,7 @@
<varlistentry>
<term><parameter>condition</parameter></term>
<listitem>
<para>
A handle to a Condition Variables returned by a previous call to <function>Cond::create</function>
</para>
<para>A handle to a Condition Variables returned by a previous call to <function>Cond::create</function></para>
</listitem>
</varlistentry>
</variablelist>

8
reference/pthreads/cond/create.xml
View file

@ -17,9 +17,7 @@
<methodname>Cond::create</methodname>
<void />
</methodsynopsis>
<para>
Creates a new Condition Variable for the caller.
</para>
<para>Creates a new Condition Variable for the caller.</para>
</refsect1>
<refsect1 role="parameters">
@ -29,9 +27,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A handle to a Condition Variable
</para>
<para>A handle to a Condition Variable</para>
</refsect1>
</refentry>

8
reference/pthreads/cond/destroy.xml
View file

@ -21,8 +21,8 @@
</methodparam>
</methodsynopsis>
<para>
Destroying Condition Variable handles must be carried out explicitly by the programmer when they are finished with the Condition Variable.
No Threads should be blocking on a call to <function>Cond::wait</function> when the call to <function>Cond::destroy</function> takes place.
Destroying Condition Variable handles must be carried out explicitly by the programmer when they are finished with the Condition Variable.
No Threads should be blocking on a call to <function>Cond::wait</function> when the call to <function>Cond::destroy</function> takes place.
</para>
</refsect1>
@ -33,7 +33,7 @@
<term><parameter>condition</parameter></term>
<listitem>
<para>
A handle to a Condition Variable returned by a previous call to <function>Cond::create</function>
A handle to a Condition Variable returned by a previous call to <function>Cond::create</function>
</para>
</listitem>
</varlistentry>
@ -43,7 +43,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A boolean indication of success.
A boolean indication of success.
</para>
</refsect1>

8
reference/pthreads/cond/signal.xml
View file

@ -31,9 +31,7 @@
<varlistentry>
<term><parameter>condition</parameter></term>
<listitem>
<para>
A handle returned by a previous call to <function>Cond::create</function>
</para>
<para>A handle returned by a previous call to <function>Cond::create</function></para>
</listitem>
</varlistentry>
</variablelist>
@ -41,9 +39,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A boolean indication of success.
</para>
<para>A boolean indication of success.</para>
</refsect1>

20
reference/pthreads/cond/wait.xml
View file

@ -28,9 +28,7 @@
<parameter>timeout</parameter>
</methodparam>
</methodsynopsis>
<para>
Wait for a signal on a Condition Variable, optionally specifying a timeout to limit waiting time.
</para>
<para>Wait for a signal on a Condition Variable, optionally specifying a timeout to limit waiting time.</para>
</refsect1>
<refsect1 role="parameters">
@ -39,25 +37,19 @@
<varlistentry>
<term><parameter>condition</parameter></term>
<listitem>
<para>
A handle returned by a previous call to <function>Cond::create</function>.
</para>
<para>A handle returned by a previous call to <function>Cond::create</function>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mutex</parameter></term>
<listitem>
<para>
A handle returned by a previous call to <function>Mutex::create</function> and owned (locked) by the caller.
</para>
<para>A handle returned by a previous call to <function>Mutex::create</function> and owned (locked) by the caller.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
An optional timeout, in microseconds ( millionths of a second ).
</para>
<para>An optional timeout, in microseconds ( millionths of a second ).</para>
</listitem>
</varlistentry>
</variablelist>
@ -65,9 +57,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A boolean indication of success.
</para>
<para>A boolean indication of success.</para>
</refsect1>
</refentry>

4
reference/pthreads/importedthread.xml
View file

@ -12,8 +12,8 @@
<section xml:id="importedthread.intro">
&reftitle.intro;
<para>
An ImportedThread is returned by a call to Thread::getThread.
This provides any Thread created by pthreads, in any context, being executed in the same instance of PHP, the ability to synchronize with any Thread including collect it's output.
An ImportedThread is returned by a call to Thread::getThread.
This provides any Thread created by pthreads, in any context, being executed in the same instance of PHP, the ability to synchronize with any Thread including collect it's output.
</para>
</section>
<!-- }}} -->

15
reference/pthreads/importedthread/getstacked.xml
View file

@ -4,21 +4,16 @@
<refentry xml:id="importedthread.getstacked" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ImportedThread::getStacked</refname>
<refpurpose>The getStacked purpose</refpurpose>
<refpurpose>Return the number of items on the referenced Threads stack</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>void</type><methodname>ImportedThread::getStacked</methodname>
<modifier>final</modifier> <modifier>public</modifier> <type>int</type><methodname>ImportedThread::getStacked</methodname>
<void />
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
<para>Return the number of items waiting to be executed by the referenced Thread.</para>
</refsect1>
<refsect1 role="parameters">
@ -28,9 +23,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<para>An intergral number representing the number of items left on the stack.</para>
</refsect1>

15
reference/pthreads/importedthread/isbusy.xml
View file

@ -4,21 +4,20 @@
<refentry xml:id="importedthread.isbusy" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ImportedThread::isBusy</refname>
<refpurpose>The isBusy purpose</refpurpose>
<refpurpose>Tell if the referenced Thread is busy executing.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>void</type><methodname>ImportedThread::isBusy</methodname>
<modifier>final</modifier> <modifier>public</modifier> <type>boolean</type><methodname>ImportedThread::isBusy</methodname>
<void />
</methodsynopsis>
<para>
Tell if the referenced Thread is busy executing.
A call to <function>Thread::join</function> on a busy Thread could result in significant blocking.
A Thread being used as a Worker will always appear busy until a call to <function>Thread::join</function> on the Worker is made.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
@ -28,9 +27,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<para>A boolean indication of state.</para>
</refsect1>

2
reference/pthreads/importedthread/isjoined.xml
View file

@ -4,7 +4,7 @@
<refentry xml:id="importedthread.isjoined" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ImportedThread::isJoined</refname>
<refpurpose>The isJoined purpose</refpurpose>
<refpurpose>Tell if the referenced Thread has been joined.</refpurpose>
</refnamediv>
<refsect1 role="description">

15
reference/pthreads/importedthread/isrunning.xml
View file

@ -4,21 +4,16 @@
<refentry xml:id="importedthread.isrunning" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ImportedThread::isRunning</refname>
<refpurpose>The isRunning purpose</refpurpose>
<refpurpose>Tell if the referenced Thread is running.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>void</type><methodname>ImportedThread::isRunning</methodname>
<modifier>final</modifier> <modifier>public</modifier> <type>boolean</type><methodname>ImportedThread::isRunning</methodname>
<void />
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
<para>Will return true if the referenced Thread has been started, and not yet joined by another context.</para>
</refsect1>
<refsect1 role="parameters">
@ -28,9 +23,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<para>A boolean indication of state.</para>
</refsect1>

13
reference/pthreads/importedthread/isstarted.xml
View file

@ -10,15 +10,14 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>void</type><methodname>ImportedThread::isStarted</methodname>
<modifier>final</modifier> <modifier>public</modifier> <type>boolean</type><methodname>ImportedThread::isStarted</methodname>
<void />
</methodsynopsis>
<para>
A Thread does not begin executing until a call to <function>Thread::start</function>.
A Thread cannot be started twice with a call to <function>Thread::start</function>.
The programmer should take care to avoid potential programming errors by calling state detection methods before attempting synchronization with another Thread.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
@ -28,9 +27,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<para>A boolean indication of state.</para>
</refsect1>

15
reference/pthreads/importedthread/iswaiting.xml
View file

@ -4,21 +4,16 @@
<refentry xml:id="importedthread.iswaiting" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ImportedThread::isWaiting</refname>
<refpurpose>The isWaiting purpose</refpurpose>
<refpurpose>Tell if the referenced Thread is waiting.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>void</type><methodname>ImportedThread::isWaiting</methodname>
<modifier>final</modifier> <modifier>public</modifier> <type>boolean</type><methodname>ImportedThread::isWaiting</methodname>
<void />
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
<para>Tell if the referenced Thread is waiting for notification from another context.</para>
</refsect1>
<refsect1 role="parameters">
@ -28,9 +23,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<para>A boolean indication of state.</para>
</refsect1>

12
reference/pthreads/importedthread/join.xml
View file

@ -4,21 +4,19 @@
<refentry xml:id="importedthread.join" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ImportedThread::join</refname>
<refpurpose>The join purpose</refpurpose>
<refpurpose>Join with the referenced Thread.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>void</type><methodname>ImportedThread::join</methodname>
<modifier>final</modifier> <modifier>public</modifier> <type>mixed</type><methodname>ImportedThread::join</methodname>
<void />
</methodsynopsis>
<para>
Join with the referenced Thread, and, dependant on implementation return to the caller the return value of Thread::run.
A Thread can only be joined by one context, the programmer should use state detection to avoid programming error.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
@ -29,7 +27,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>

14
reference/pthreads/importedthread/notify.xml
View file

@ -4,21 +4,19 @@
<refentry xml:id="importedthread.notify" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ImportedThread::notify</refname>
<refpurpose>The notify purpose</refpurpose>
<refpurpose>Notify all Threads waiting for the referenced Thread.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>void</type><methodname>ImportedThread::notify</methodname>
<modifier>final</modifier> <modifier>public</modifier> <type>boolean</type><methodname>ImportedThread::notify</methodname>
<void />
</methodsynopsis>
<para>
Notify all Threads waiting for the referenced Thread causing the waiting Threads to continue executing.
A call to notify when no Threads are waiting results in blocking until another context call Thread::wait on the referenced Thread.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
@ -28,9 +26,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<para>A boolean indication of success.</para>
</refsect1>

22
reference/pthreads/importedthread/wait.xml
View file

@ -4,21 +4,21 @@
<refentry xml:id="importedthread.wait" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ImportedThread::wait</refname>
<refpurpose>The wait purpose</refpurpose>
<refpurpose>Wait for Notification from the referenced Thread.</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>void</type><methodname>ImportedThread::wait</methodname>
<methodparam choice="opt"><type>string</type><parameter>timeout</parameter></methodparam>
<modifier>final</modifier> <modifier>public</modifier> <type>boolean</type><methodname>ImportedThread::wait</methodname>
<methodparam choice="opt"><type>long</type><parameter>timeout</parameter></methodparam>
</methodsynopsis>
<para>
Causes the calling thread to block and wait for a call to <function>Thread::notify</function> on the referenced Thread.
A reached timeout is regarded as failure.
A call to <function>Thread::wait</function> will always result in blocking.
The programmer should use state detection methods to avoid programming errors when using synchronization methods, <function>Thread::wait</function>, and <function>Thread::notify</function>.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
@ -27,9 +27,7 @@
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
</para>
<para>An optional timeout in microseconds ( millionths of a second ).</para>
</listitem>
</varlistentry>
</variablelist>
@ -37,9 +35,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
<para>A boolean indication of success.</para>
</refsect1>

6
reference/pthreads/mutex.xml
View file

@ -13,9 +13,9 @@
&reftitle.intro;
<para>The following paragraph was taken, in part, from the Posix Threads documentation:</para>
<para>
Mutex is an abbreviation for "mutual exclusion". Mutex variables are one of the primary means of implementing thread synchronization and for protecting shared data when multiple writes occur.
A mutex variable acts like a "lock" protecting access to a shared data resource. The basic concept of a mutex is that only one thread can lock (or own) a mutex variable at any given time. Thus, even if several threads try to lock a mutex only one thread will be successful. No other thread can own that mutex until the owning thread unlocks that mutex. Threads must "take turns" accessing protected data.
Mutex can be used to prevent race conditions.
Mutex is an abbreviation for "mutual exclusion". Mutex variables are one of the primary means of implementing thread synchronization and for protecting shared data when multiple writes occur.
A mutex variable acts like a "lock" protecting access to a shared data resource. The basic concept of a mutex is that only one thread can lock (or own) a mutex variable at any given time. Thus, even if several threads try to lock a mutex only one thread will be successful. No other thread can own that mutex until the owning thread unlocks that mutex. Threads must "take turns" accessing protected data.
Mutex can be used to prevent race conditions.
</para>
<para>pthreads provides PHP with direct access to a carefully selected subset of Mutex functions.</para>
<para>The Mutex created by pthreads for PHP are of an error-checking type where available (PTHREAD_MUTEX_ERRORCHECK), in the alpha stages of development this is the only type of Mutex supported by pthreads.</para>

12
reference/pthreads/mutex/create.xml
View file

@ -20,9 +20,7 @@
<parameter>lock</parameter>
</methodparam>
</methodsynopsis>
<para>
Create, and optionally lock a new Mutex for the caller
</para>
<para>Create, and optionally lock a new Mutex for the caller</para>
</refsect1>
<refsect1 role="parameters">
@ -31,9 +29,7 @@
<varlistentry>
<term><parameter>lock</parameter></term>
<listitem>
<para>
Setting lock to true will lock the Mutex for the caller before returning the handle
</para>
<para>Setting lock to true will lock the Mutex for the caller before returning the handle</para>
</listitem>
</varlistentry>
</variablelist>
@ -41,9 +37,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A newly created and optionally locked Mutex handle
</para>
<para>A newly created and optionally locked Mutex handle</para>
</refsect1>
</refentry>

12
reference/pthreads/mutex/destroy.xml
View file

@ -20,9 +20,7 @@
<parameter>mutex</parameter>
</methodparam>
</methodsynopsis>
<para>
Destroying Mutex handles must be carried out explicitly by the programmer when they are finished with the Mutex handle.
</para>
<para>Destroying Mutex handles must be carried out explicitly by the programmer when they are finished with the Mutex handle. </para>
</refsect1>
<refsect1 role="parameters">
@ -32,8 +30,8 @@
<term><parameter>mutex</parameter></term>
<listitem>
<para>
A handle returned by a previous call to <function>Mutex::create</function>.
The handle should not be locked by any Thread when <function>Mutex::destroy</function> is called.
A handle returned by a previous call to <function>Mutex::create</function>.
The handle should not be locked by any Thread when <function>Mutex::destroy</function> is called.
</para>
</listitem>
</varlistentry>
@ -42,9 +40,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A boolean indication of success
</para>
<para>A boolean indication of success</para>
</refsect1>

16
reference/pthreads/mutex/lock.xml
View file

@ -20,12 +20,8 @@
<parameter>mutex</parameter>
</methodparam>
</methodsynopsis>
<para>
Attempt to lock the Mutex for the caller.
</para>
<para>
An attempt to lock a Mutex owned (locked) by another Thread will result in blocking.
</para>
<para>Attempt to lock the Mutex for the caller.</para>
<para>An attempt to lock a Mutex owned (locked) by another Thread will result in blocking.</para>
</refsect1>
<refsect1 role="parameters">
@ -34,9 +30,7 @@
<varlistentry>
<term><parameter>mutex</parameter></term>
<listitem>
<para>
A handle returned by a previous call to <function>Mutex::create</function>.
</para>
<para>A handle returned by a previous call to <function>Mutex::create</function>.</para>
</listitem>
</varlistentry>
</variablelist>
@ -44,9 +38,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A boolean indication of success.
</para>
<para>A boolean indication of success.</para>
</refsect1>

4
reference/pthreads/mutex/trylock.xml
View file

@ -29,9 +29,7 @@
<varlistentry>
<term><parameter>mutex</parameter></term>
<listitem>
<para>
A handle returned by a previous call to <function>Mutex::create</function>.
</para>
<para>A handle returned by a previous call to <function>Mutex::create</function>.</para>
</listitem>
</varlistentry>
</variablelist>

16
reference/pthreads/mutex/unlock.xml
View file

@ -25,8 +25,8 @@
</methodparam>
</methodsynopsis>
<para>
Attempts to unlock the Mutex for the caller, optionally destroying the Mutex handle.
The calling thread should own the Mutex at the time of the call.
Attempts to unlock the Mutex for the caller, optionally destroying the Mutex handle.
The calling thread should own the Mutex at the time of the call.
</para>
</refsect1>
@ -36,17 +36,13 @@
<varlistentry>
<term><parameter>mutex</parameter></term>
<listitem>
<para>
A handle returned by a previous call to <function>Mutex::create</function>.
</para>
<para>A handle returned by a previous call to <function>Mutex::create</function>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>destroy</parameter></term>
<listitem>
<para>
When true pthreads will destroy the Mutex after a successful unlock.
</para>
<para>When true pthreads will destroy the Mutex after a successful unlock.</para>
</listitem>
</varlistentry>
</variablelist>
@ -54,9 +50,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A boolean indication of success.
</para>
<para>A boolean indication of success.</para>
</refsect1>

2
reference/pthreads/thread.xml
View file

@ -12,7 +12,7 @@
<section xml:id="thread.intro">
&reftitle.intro;
<para>
Any object that extends Thread can have the run method executed asynchronously in a Thread.
Any object that extends Thread can have the run method executed asynchronously in a Thread.
</para>
</section>
<!-- }}} -->

8
reference/pthreads/thread/getcount.xml
View file

@ -17,9 +17,7 @@
<methodname>Thread::getCount</methodname>
<void />
</methodsynopsis>
<para>
Returns the number of currently executing Threads.
</para>
<para>Returns the number of currently executing Threads.</para>
</refsect1>
<refsect1 role="parameters">
@ -30,8 +28,8 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The number of threads that are currently running.
This number does not include any threads that are waiting to be joined, only those that are actively executing.
The number of threads that are currently running.
This number does not include any threads that are waiting to be joined, only those that are actively executing.
</para>
</refsect1>
</refentry>

8
reference/pthreads/thread/getmax.xml
View file

@ -14,8 +14,8 @@
<void />
</methodsynopsis>
<para>
Some system administrators choose to limit the amount of Threads an instance of PHP can create.
If the number is set and reach any calls to <function>Thread::start</function> will fail, generating a warning.
Some system administrators choose to limit the amount of Threads an instance of PHP can create.
If the number is set and reach any calls to <function>Thread::start</function> will fail, generating a warning.
</para>
</refsect1>
@ -26,9 +26,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The maximum number of Threads as defined by system administrators.
</para>
<para>The maximum number of Threads as defined by system administrators.</para>
</refsect1>

10
reference/pthreads/thread/getpeak.xml
View file

@ -14,9 +14,9 @@
<void />
</methodsynopsis>
<para>
Return the peak number of Threads executing concurrently in the current instance of PHP.
Some system administrators choose to limit the amount of Threads an instance of PHP can create.
If enabled the maximum number of Threads the current instance can create is returned by a call to <function>Thread::getMax</function>.
Return the peak number of Threads executing concurrently in the current instance of PHP.
Some system administrators choose to limit the amount of Threads an instance of PHP can create.
If enabled the maximum number of Threads the current instance can create is returned by a call to <function>Thread::getMax</function>.
</para>
<para>What counts as "an instance of PHP" depends on the current environment PHP and pthreads are executing in.</para>
</refsect1>
@ -28,9 +28,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The peak number of Threads the current of PHP has executed.
</para>
<para>The peak number of Threads the current of PHP has executed.</para>
</refsect1>

8
reference/pthreads/thread/getstacked.xml
View file

@ -13,9 +13,7 @@
<modifier>final</modifier> <modifier>public</modifier> <type>int</type><methodname>Thread::getStacked</methodname>
<void />
</methodsynopsis>
<para>
Return the number of items waiting to be executed by the referenced Thread.
</para>
<para>Return the number of items waiting to be executed by the referenced Thread.</para>
</refsect1>
<refsect1 role="parameters">
@ -25,9 +23,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An intergral number representing the number of items left on the stack.
</para>
<para>An intergral number representing the number of items left on the stack.</para>
</refsect1>

12
reference/pthreads/thread/getthread.xml
View file

@ -13,9 +13,7 @@
<modifier>final</modifier> <modifier>public</modifier> <modifier>static</modifier> <type>ImportedThread</type><methodname>Thread::getThread</methodname>
<methodparam><type>string</type><parameter>tid</parameter></methodparam>
</methodsynopsis>
<para>
Import a Thread created in another context for the purposes of synchronization.
</para>
<para>Import a Thread created in another context for the purposes of synchronization.</para>
</refsect1>
<refsect1 role="parameters">
@ -24,9 +22,7 @@
<varlistentry>
<term><parameter>tid</parameter></term>
<listitem>
<para>
A valid Thread identifier returned by a previous call to <function>Thread::getThreadId</function>.
</para>
<para>A valid Thread identifier returned by a previous call to <function>Thread::getThreadId</function>.</para>
</listitem>
</varlistentry>
</variablelist>
@ -34,9 +30,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An ImportedThread represetning the Thread referenced by tid, if it can be found in the current instance of PHP.
</para>
<para>An ImportedThread represetning the Thread referenced by tid, if it can be found in the current instance of PHP.</para>
</refsect1>
</refentry>

8
reference/pthreads/thread/getthreadid.xml
View file

@ -13,9 +13,7 @@
<modifier>final</modifier> <modifier>public</modifier> <type>long</type><methodname>Thread::getThreadId</methodname>
<void />
</methodsynopsis>
<para>
Get the identifier for the refeerenced Thread
</para>
<para>Get the identifier for the refeerenced Thread</para>
</refsect1>
<refsect1 role="parameters">
@ -25,9 +23,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The return value can subsequently be used in a call to <function>Thread::getThread</function> for the purposes of importing into another context.
</para>
<para>The return value can subsequently be used in a call to <function>Thread::getThread</function> for the purposes of importing into another context.</para>
</refsect1>
</refentry>

10
reference/pthreads/thread/isbusy.xml
View file

@ -14,9 +14,9 @@
<void />
</methodsynopsis>
<para>
Tell if the referenced Thread is busy executing.
A call to <function>Thread::join</function> on a busy Thread could result in significant blocking.
A Thread being used as a Worker will always appear busy until a call to <function>Thread::join</function> on the Worker is made.
Tell if the referenced Thread is busy executing.
A call to <function>Thread::join</function> on a busy Thread could result in significant blocking.
A Thread being used as a Worker will always appear busy until a call to <function>Thread::join</function> on the Worker is made.
</para>
</refsect1>
@ -27,9 +27,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A boolean indication of state.
</para>
<para>A boolean indication of state.</para>
</refsect1>

12
reference/pthreads/thread/isjoined.xml
View file

@ -4,7 +4,7 @@
<refentry xml:id="thread.isjoined" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Thread::isJoined</refname>
<refpurpose>Tell if a Thread has been joined.</refpurpose>
<refpurpose>Tell if the referenced Thread has been joined.</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -14,9 +14,9 @@
<void />
</methodsynopsis>
<para>
Tell if a Thread has been joined by another context.
A Thread may only be joined with one context currently.
A call to <function>Thread::join</function> on a joined Thread will result in failure, and a warning being raised.
Tell if a Thread has been joined by another context.
A Thread may only be joined with one context currently.
A call to <function>Thread::join</function> on a joined Thread will result in failure, and a warning being raised.
</para>
</refsect1>
@ -27,9 +27,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A boolean indication of state.
</para>
<para>A boolean indication of state.</para>
</refsect1>

8
reference/pthreads/thread/isrunning.xml
View file

@ -13,9 +13,7 @@
<modifier>final</modifier> <modifier>public</modifier> <type>boolean</type><methodname>Thread::isRunning</methodname>
<void />
</methodsynopsis>
<para>
Will return true if the referenced Thread has been started, and not yet joined by another context.
</para>
<para>Will return true if the referenced Thread has been started, and not yet joined by another context.</para>
</refsect1>
<refsect1 role="parameters">
@ -25,9 +23,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A boolean indication of state.
</para>
<para>A boolean indication of state.</para>
</refsect1>
</refentry>

10
reference/pthreads/thread/isstarted.xml
View file

@ -14,9 +14,9 @@
<void />
</methodsynopsis>
<para>
A Thread does not begin executing until a call to <function>Thread::start</function>.
A Thread cannot be started twice with a call to <function>Thread::start</function>.
The programmer should take care to avoid potential programming errors by calling state detection methods before attempting synchronization with another Thread.
A Thread does not begin executing until a call to <function>Thread::start</function>.
A Thread cannot be started twice with a call to <function>Thread::start</function>.
The programmer should take care to avoid potential programming errors by calling state detection methods before attempting synchronization with another Thread.
</para>
</refsect1>
@ -27,9 +27,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A boolean indication of state.
</para>
<para>A boolean indication of state.</para>
</refsect1>
</refentry>

8
reference/pthreads/thread/iswaiting.xml
View file

@ -13,9 +13,7 @@
<modifier>final</modifier> <modifier>public</modifier> <type>boolean</type><methodname>Thread::isWaiting</methodname>
<void />
</methodsynopsis>
<para>
Tell if the referenced Thread is waiting for notification from another context.
</para>
<para>Tell if the referenced Thread is waiting for notification from another context.</para>
</refsect1>
<refsect1 role="parameters">
@ -25,9 +23,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A boolean indication of state.
</para>
<para>A boolean indication of state.</para>
</refsect1>

4
reference/pthreads/thread/join.xml
View file

@ -14,8 +14,8 @@
<void />
</methodsynopsis>
<para>
Join with the referenced Thread, and, dependant on implementation return to the caller the return value of Thread::run.
A Thread can only be joined by one context, the programmer should use state detection to avoid programming error.
Join with the referenced Thread, and, dependant on implementation return to the caller the return value of Thread::run.
A Thread can only be joined by one context, the programmer should use state detection to avoid programming error.
</para>
</refsect1>

8
reference/pthreads/thread/notify.xml
View file

@ -14,8 +14,8 @@
<void />
</methodsynopsis>
<para>
Notify all Threads waiting for the referenced Thread causing the waiting Threads to continue executing.
A call to notify when no Threads are waiting results in blocking until another context call Thread::wait on the referenced Thread.
Notify all Threads waiting for the referenced Thread causing the waiting Threads to continue executing.
A call to notify when no Threads are waiting results in blocking until another context call Thread::wait on the referenced Thread.
</para>
</refsect1>
@ -26,9 +26,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A boolean indication of success.
</para>
<para>A boolean indication of success.</para>
</refsect1>

6
reference/pthreads/thread/run.xml
View file

@ -14,9 +14,9 @@
<void />
</methodsynopsis>
<para>
A run method is just like any other member function, it has access to any members that were set before the call to <function>Thread::start</function> was made.
A run methods return value must be serializeable to be passed as the result of <function>Thread::join</function>.
Unserializeable data will generate a warning for the context that calls <function>Thread::join</function>.
A run method is just like any other member function, it has access to any members that were set before the call to <function>Thread::start</function> was made.
A run methods return value must be serializeable to be passed as the result of <function>Thread::join</function>.
Unserializeable data will generate a warning for the context that calls <function>Thread::join</function>.
</para>
</refsect1>

18
reference/pthreads/thread/stack.xml
View file

@ -14,11 +14,11 @@
<methodparam><type>Object</type><parameter>work</parameter></methodparam>
</methodsynopsis>
<para>
Pushing work onto the stack of an executing Thread automatically turns that Thread into a Worker.
A Worker Thread will automatically pop work off the stack and execute the items run method.
A Worker Thread is available until a call to <function>Thread::join</function> is recieved.
The return value of the run method of an executed item is ignored, until the last execution on the stack.
The last item on the stack has the return value of run available to the caller of <function>Thread::join</function> on the Worker Thread.
Pushing work onto the stack of an executing Thread automatically turns that Thread into a Worker.
A Worker Thread will automatically pop work off the stack and execute the items run method.
A Worker Thread is available until a call to <function>Thread::join</function> is recieved.
The return value of the run method of an executed item is ignored, until the last execution on the stack.
The last item on the stack has the return value of run available to the caller of <function>Thread::join</function> on the Worker Thread.
</para>
</refsect1>
@ -28,9 +28,7 @@
<varlistentry>
<term><parameter>work</parameter></term>
<listitem>
<para>
An item of the same type as the referenced Thread
</para>
<para>An item of the same type as the referenced Thread</para>
</listitem>
</varlistentry>
</variablelist>
@ -38,9 +36,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The size of stack after work was added.
</para>
<para>The size of stack after work was added.</para>
</refsect1>

12
reference/pthreads/thread/unstack.xml
View file

@ -13,9 +13,7 @@
<modifier>final</modifier> <modifier>public</modifier> <type>int</type><methodname>Thread::unstack</methodname>
<methodparam choice="opt"><type>Object</type><parameter>work</parameter></methodparam>
</methodsynopsis>
<para>
Remove an item, or all items if no parameters are present from the referenced Threads stack.
</para>
<para>Remove an item, or all items if no parameters are present from the referenced Threads stack.</para>
</refsect1>
<refsect1 role="parameters">
@ -24,9 +22,7 @@
<varlistentry>
<term><parameter>work</parameter></term>
<listitem>
<para>
Should be an object previous used as the parameter to <function>Thread::stack</function>
</para>
<para>Should be an object previous used as the parameter to <function>Thread::stack</function></para>
</listitem>
</varlistentry>
</variablelist>
@ -34,9 +30,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The size of the stack after work was removed.
</para>
<para>The size of the stack after work was removed.</para>
</refsect1>

16
reference/pthreads/thread/wait.xml
View file

@ -14,10 +14,10 @@
<methodparam choice="opt"><type>long</type><parameter>timeout</parameter></methodparam>
</methodsynopsis>
<para>
Causes the calling thread to block and wait for a call to <function>Thread::notify</function> on the referenced Thread.
A reached timeout is regarded as failure.
A call to <function>Thread::wait</function> will always result in blocking.
The programmer should use state detection methods to avoid programming errors when using synchronization methods, <function>Thread::wait</function>, and <function>Thread::notify</function>.
Causes the calling thread to block and wait for a call to <function>Thread::notify</function> on the referenced Thread.
A reached timeout is regarded as failure.
A call to <function>Thread::wait</function> will always result in blocking.
The programmer should use state detection methods to avoid programming errors when using synchronization methods, <function>Thread::wait</function>, and <function>Thread::notify</function>.
</para>
</refsect1>
@ -27,9 +27,7 @@
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
<para>
An optional timeout in microseconds ( millionths of a second ).
</para>
<para>An optional timeout in microseconds ( millionths of a second ).</para>
</listitem>
</varlistentry>
</variablelist>
@ -37,9 +35,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A boolean indication of success.
</para>
<para>A boolean indication of success.</para>
</refsect1>