From bd4ceb6dd5cf4d65b85e169f2a791d12050ee6de Mon Sep 17 00:00:00 2001 From: Joe Watkins Date: Tue, 6 Nov 2012 21:08:55 +0000 Subject: [PATCH] intermittent changes git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@328265 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/pthreads/book.xml | 43 --------- reference/pthreads/cond.xml | 67 -------------- reference/pthreads/cond/broadcast.xml | 67 -------------- reference/pthreads/cond/create.xml | 53 ----------- reference/pthreads/cond/destroy.xml | 72 --------------- reference/pthreads/cond/signal.xml | 67 -------------- reference/pthreads/cond/wait.xml | 84 ------------------ reference/pthreads/configure.xml | 35 -------- reference/pthreads/ini.xml | 87 ------------------- reference/pthreads/mutex.xml | 67 -------------- reference/pthreads/mutex/create.xml | 63 -------------- reference/pthreads/mutex/destroy.xml | 68 --------------- reference/pthreads/mutex/lock.xml | 66 -------------- reference/pthreads/mutex/trylock.xml | 65 -------------- reference/pthreads/mutex/unlock.xml | 78 ----------------- reference/pthreads/reference.xml | 30 ------- reference/pthreads/setup.xml | 52 ----------- reference/pthreads/stackable.xml | 67 -------------- reference/pthreads/stackable/getcreatorid.xml | 55 ------------ reference/pthreads/stackable/getthreadid.xml | 53 ----------- reference/pthreads/stackable/isrunning.xml | 55 ------------ reference/pthreads/stackable/iswaiting.xml | 55 ------------ reference/pthreads/stackable/notify.xml | 55 ------------ reference/pthreads/stackable/run.xml | 55 ------------ reference/pthreads/stackable/wait.xml | 64 -------------- reference/pthreads/thread.xml | 67 -------------- reference/pthreads/thread/getcount.xml | 55 ------------ reference/pthreads/thread/getmax.xml | 55 ------------ reference/pthreads/thread/getpeak.xml | 53 ----------- reference/pthreads/thread/getstacked.xml | 51 ----------- reference/pthreads/thread/getthread.xml | 63 -------------- reference/pthreads/thread/getthreadid.xml | 55 ------------ reference/pthreads/thread/isjoined.xml | 55 ------------ reference/pthreads/thread/isrunning.xml | 55 ------------ reference/pthreads/thread/isstarted.xml | 55 ------------ reference/pthreads/thread/iswaiting.xml | 55 ------------ reference/pthreads/thread/join.xml | 55 ------------ reference/pthreads/thread/notify.xml | 55 ------------ reference/pthreads/thread/run.xml | 55 ------------ reference/pthreads/thread/start.xml | 64 -------------- reference/pthreads/thread/wait.xml | 64 -------------- reference/pthreads/versions.xml | 72 --------------- reference/pthreads/worker.xml | 67 -------------- reference/pthreads/worker/getcreatorid.xml | 55 ------------ reference/pthreads/worker/getstacked.xml | 55 ------------ reference/pthreads/worker/getthreadid.xml | 55 ------------ reference/pthreads/worker/isjoined.xml | 55 ------------ reference/pthreads/worker/iswaiting.xml | 55 ------------ reference/pthreads/worker/join.xml | 55 ------------ reference/pthreads/worker/run.xml | 55 ------------ reference/pthreads/worker/stack.xml | 64 -------------- reference/pthreads/worker/start.xml | 64 -------------- reference/pthreads/worker/unstack.xml | 64 -------------- 53 files changed, 3151 deletions(-) delete mode 100644 reference/pthreads/book.xml delete mode 100644 reference/pthreads/cond.xml delete mode 100644 reference/pthreads/cond/broadcast.xml delete mode 100644 reference/pthreads/cond/create.xml delete mode 100644 reference/pthreads/cond/destroy.xml delete mode 100644 reference/pthreads/cond/signal.xml delete mode 100644 reference/pthreads/cond/wait.xml delete mode 100644 reference/pthreads/configure.xml delete mode 100644 reference/pthreads/ini.xml delete mode 100644 reference/pthreads/mutex.xml delete mode 100644 reference/pthreads/mutex/create.xml delete mode 100644 reference/pthreads/mutex/destroy.xml delete mode 100644 reference/pthreads/mutex/lock.xml delete mode 100644 reference/pthreads/mutex/trylock.xml delete mode 100644 reference/pthreads/mutex/unlock.xml delete mode 100644 reference/pthreads/reference.xml delete mode 100644 reference/pthreads/setup.xml delete mode 100644 reference/pthreads/stackable.xml delete mode 100644 reference/pthreads/stackable/getcreatorid.xml delete mode 100644 reference/pthreads/stackable/getthreadid.xml delete mode 100644 reference/pthreads/stackable/isrunning.xml delete mode 100644 reference/pthreads/stackable/iswaiting.xml delete mode 100644 reference/pthreads/stackable/notify.xml delete mode 100644 reference/pthreads/stackable/run.xml delete mode 100644 reference/pthreads/stackable/wait.xml delete mode 100644 reference/pthreads/thread.xml delete mode 100644 reference/pthreads/thread/getcount.xml delete mode 100644 reference/pthreads/thread/getmax.xml delete mode 100644 reference/pthreads/thread/getpeak.xml delete mode 100644 reference/pthreads/thread/getstacked.xml delete mode 100644 reference/pthreads/thread/getthread.xml delete mode 100644 reference/pthreads/thread/getthreadid.xml delete mode 100644 reference/pthreads/thread/isjoined.xml delete mode 100644 reference/pthreads/thread/isrunning.xml delete mode 100644 reference/pthreads/thread/isstarted.xml delete mode 100644 reference/pthreads/thread/iswaiting.xml delete mode 100644 reference/pthreads/thread/join.xml delete mode 100644 reference/pthreads/thread/notify.xml delete mode 100644 reference/pthreads/thread/run.xml delete mode 100644 reference/pthreads/thread/start.xml delete mode 100644 reference/pthreads/thread/wait.xml delete mode 100644 reference/pthreads/versions.xml delete mode 100644 reference/pthreads/worker.xml delete mode 100644 reference/pthreads/worker/getcreatorid.xml delete mode 100644 reference/pthreads/worker/getstacked.xml delete mode 100644 reference/pthreads/worker/getthreadid.xml delete mode 100644 reference/pthreads/worker/isjoined.xml delete mode 100644 reference/pthreads/worker/iswaiting.xml delete mode 100644 reference/pthreads/worker/join.xml delete mode 100644 reference/pthreads/worker/run.xml delete mode 100644 reference/pthreads/worker/stack.xml delete mode 100644 reference/pthreads/worker/start.xml delete mode 100644 reference/pthreads/worker/unstack.xml diff --git a/reference/pthreads/book.xml b/reference/pthreads/book.xml deleted file mode 100644 index 4c0412b9f1..0000000000 --- a/reference/pthreads/book.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - pthreads - pthreads - - - &reftitle.intro; - - pthreads uses the well tested abilities of TSRM and PHP to provide object oreintated multi-threading capabilities. - - - - &reference.pthreads.setup; - &reference.pthreads.thread; - &reference.pthreads.worker; - &reference.pthreads.stackable; - &reference.pthreads.mutex; - &reference.pthreads.cond; - - - - diff --git a/reference/pthreads/cond.xml b/reference/pthreads/cond.xml deleted file mode 100644 index 3ca922e1fc..0000000000 --- a/reference/pthreads/cond.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The Cond class - Cond - - - - -
- &reftitle.intro; - - The static methods contained in the Cond class provide direct access to Posix Condition Variables. - -
- - -
- &reftitle.classsynopsis; - - - - Cond - - - - - Cond - - - - - &Methods; - - - - -
- -
- - &reference.pthreads.entities.cond; - -
- - diff --git a/reference/pthreads/cond/broadcast.xml b/reference/pthreads/cond/broadcast.xml deleted file mode 100644 index 57d4f63415..0000000000 --- a/reference/pthreads/cond/broadcast.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Cond::broadcast - Broadcast a condition to all Threads - - - - &reftitle.description; - - final - public - static - boolean - Cond::broadcast - - long - condition - - - Broadcast to all Threads blocking on a call to Cond::wait. - - - - &reftitle.parameters; - - - condition - - A handle to a Condition Variables returned by a previous call to Cond::create - - - - - - - &reftitle.returnvalues; - - A boolean indication of success. - - - - - - - diff --git a/reference/pthreads/cond/create.xml b/reference/pthreads/cond/create.xml deleted file mode 100644 index 62e3ed22bf..0000000000 --- a/reference/pthreads/cond/create.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - Cond::create - Create a new Condition Variable - - - - &reftitle.description; - - final - public - static - long - Cond::create - - - Creates a new Condition Variable for the caller. - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - A handle to a Condition Variable - - - - diff --git a/reference/pthreads/cond/destroy.xml b/reference/pthreads/cond/destroy.xml deleted file mode 100644 index d316f22b1a..0000000000 --- a/reference/pthreads/cond/destroy.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - Cond::destroy - Destroy a handle to a Condition Variable and free the associated resources - - - - &reftitle.description; - - final - public - static - boolean - Cond::destroy - - long - condition - - - - 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 Cond::wait when the call to Cond::destroy takes place. - - - - - &reftitle.parameters; - - - condition - - - A handle to a Condition Variable returned by a previous call to Cond::create - - - - - - - - &reftitle.returnvalues; - - A boolean indication of success. - - - - - - - diff --git a/reference/pthreads/cond/signal.xml b/reference/pthreads/cond/signal.xml deleted file mode 100644 index a37ecd6c59..0000000000 --- a/reference/pthreads/cond/signal.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - Cond::signal - Signal a condition to a single Thread - - - - &reftitle.description; - - final - public - static - boolean - Cond::signal - - long - condition - - - - - - - - - &reftitle.parameters; - - - condition - - A handle returned by a previous call to Cond::create - - - - - - - &reftitle.returnvalues; - A boolean indication of success. - - - - - - diff --git a/reference/pthreads/cond/wait.xml b/reference/pthreads/cond/wait.xml deleted file mode 100644 index 6a84284b8a..0000000000 --- a/reference/pthreads/cond/wait.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - Cond::wait - Wait for a signal on a Condition Variable - - - - &reftitle.description; - - final - public - static - boolean - Cond::wait - - long - condition - - - long - mutex - - - long - timeout - - - Wait for a signal on a Condition Variable, optionally specifying a timeout to limit waiting time. - - - - &reftitle.parameters; - - - condition - - A handle returned by a previous call to Cond::create. - - - - mutex - - A handle returned by a previous call to Mutex::create and owned (locked) by the caller. - - - - timeout - - An optional timeout, in microseconds ( millionths of a second ). - - - - - - - &reftitle.returnvalues; - A boolean indication of success. - - - - - diff --git a/reference/pthreads/configure.xml b/reference/pthreads/configure.xml deleted file mode 100644 index 5e0fe35fa6..0000000000 --- a/reference/pthreads/configure.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;pthreads - - - -
- - - diff --git a/reference/pthreads/ini.xml b/reference/pthreads/ini.xml deleted file mode 100644 index cdb5f3f08a..0000000000 --- a/reference/pthreads/ini.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - -
- &reftitle.runtime; - &extension.runtime; - - - pthreads &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - pthreads.max - 0 - PHP_INI_SYSTEM - - - - pthreads.importing - 1 - PHP_INI_SYSTEM - - - - -
-
- - &ini.descriptions.title; - - - - - - pthreads.max - integer - - - - provides system administrators a way to limit the amount of threads or workers an instance of PHP can create. - - - - - - pthreads.importing - integer - - - - provides system administrators a way to disable importing threads from other contexts for security. - - - - - - -
- - diff --git a/reference/pthreads/mutex.xml b/reference/pthreads/mutex.xml deleted file mode 100644 index b7cdef2b61..0000000000 --- a/reference/pthreads/mutex.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The Mutex class - Mutex - - - - -
- &reftitle.intro; - - The static methods contained in the Mutex class provide direct access to Posix Mutex functionality. - -
- - -
- &reftitle.classsynopsis; - - - - Mutex - - - - - Mutex - - - - - &Methods; - - - - -
- -
- - &reference.pthreads.entities.mutex; - -
- - diff --git a/reference/pthreads/mutex/create.xml b/reference/pthreads/mutex/create.xml deleted file mode 100644 index 22208e91d7..0000000000 --- a/reference/pthreads/mutex/create.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Mutex::create - Create a new Mutex - - - - &reftitle.description; - - final - public - static - long - Mutex::create - - boolean - lock - - - Create, and optionally lock a new Mutex for the caller - - - - &reftitle.parameters; - - - lock - - Setting lock to true will lock the Mutex for the caller before returning the handle - - - - - - - &reftitle.returnvalues; - A newly created and optionally locked Mutex handle - - - - diff --git a/reference/pthreads/mutex/destroy.xml b/reference/pthreads/mutex/destroy.xml deleted file mode 100644 index ab82173505..0000000000 --- a/reference/pthreads/mutex/destroy.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - Mutex::destroy - To destroy a handle to a Mutex and free the associated resources - - - - &reftitle.description; - - final - public - static - boolean - Mutex::destroy - - long - mutex - - - Destroying Mutex handles must be carried out explicitly by the programmer when they are finished with the Mutex handle. - - - - &reftitle.parameters; - - - mutex - - - A handle returned by a previous call to Mutex::create. - The handle should not be locked by any Thread when Mutex::destroy is called. - - - - - - - - &reftitle.returnvalues; - A boolean indication of success - - - - - - diff --git a/reference/pthreads/mutex/lock.xml b/reference/pthreads/mutex/lock.xml deleted file mode 100644 index dbb1d29cdf..0000000000 --- a/reference/pthreads/mutex/lock.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - Mutex::lock - The lock purpose - - - - &reftitle.description; - - final - public - static - boolean - Mutex::lock - - long - mutex - - - Attempt to lock the Mutex for the caller. - An attempt to lock a Mutex owned (locked) by another Thread will result in blocking. - - - - &reftitle.parameters; - - - mutex - - A handle returned by a previous call to Mutex::create. - - - - - - - &reftitle.returnvalues; - A boolean indication of success. - - - - - - diff --git a/reference/pthreads/mutex/trylock.xml b/reference/pthreads/mutex/trylock.xml deleted file mode 100644 index 8662032214..0000000000 --- a/reference/pthreads/mutex/trylock.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Mutex::trylock - To attempt to lock a Mutex without blocking. - - - - &reftitle.description; - - final - public - static - boolean - Mutex::trylock - - long - mutex - - - Attempt to lock the Mutex for the caller without blocking if the Mutex is owned (locked) by another Thread. - - - - &reftitle.parameters; - - - mutex - - A handle returned by a previous call to Mutex::create. - - - - - - - &reftitle.returnvalues; - - A boolean indication of success. - - - - - diff --git a/reference/pthreads/mutex/unlock.xml b/reference/pthreads/mutex/unlock.xml deleted file mode 100644 index 3d610e765e..0000000000 --- a/reference/pthreads/mutex/unlock.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - Mutex::unlock - Attempts to unlock a Mutex - - - - &reftitle.description; - - final - public - static - boolean - Mutex::unlock - - long - mutex - - - boolean - destroy - - - - 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. - - - - - &reftitle.parameters; - - - mutex - - A handle returned by a previous call to Mutex::create. - - - - destroy - - When true pthreads will destroy the Mutex after a successful unlock. - - - - - - - &reftitle.returnvalues; - A boolean indication of success. - - - - - - diff --git a/reference/pthreads/reference.xml b/reference/pthreads/reference.xml deleted file mode 100644 index bfec3d2e38..0000000000 --- a/reference/pthreads/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - pthreads &Functions; - - &reference.pthreads.entities.functions; - - - - diff --git a/reference/pthreads/setup.xml b/reference/pthreads/setup.xml deleted file mode 100644 index 3272c6bba6..0000000000 --- a/reference/pthreads/setup.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - pthreads requires a build of PHP with ZTS enabled ( --enable-maintainer-zts or --enable-zts on Windows ) - -
- -
- &reftitle.install; - &no.install; -
- -
- &reftitle.runtime; - &no.config; -
- -
- &reftitle.resources; - - - -
- -
- - diff --git a/reference/pthreads/stackable.xml b/reference/pthreads/stackable.xml deleted file mode 100644 index d41df970c3..0000000000 --- a/reference/pthreads/stackable.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The Stackable class - Stackable - - - - -
- &reftitle.intro; - - Stackables are tasks that are executed by Worker threads. You can synchronize with, read, and write Stackable objects before, after and during their execution. - -
- - -
- &reftitle.classsynopsis; - - - - Stackable - - - - - Stackable - - - - - &Methods; - - - - -
- -
- - &reference.pthreads.entities.stackable; - -
- - diff --git a/reference/pthreads/stackable/getcreatorid.xml b/reference/pthreads/stackable/getcreatorid.xml deleted file mode 100644 index 20e97683f4..0000000000 --- a/reference/pthreads/stackable/getcreatorid.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Stackable::getCreatorId - Identification - - - - &reftitle.description; - - final public longStackable::getCreatorId - - - - Will return the identity of the Thread that created the referenced Stackable - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A numeric value representing the identity of the creating context - - - - - - - diff --git a/reference/pthreads/stackable/getthreadid.xml b/reference/pthreads/stackable/getthreadid.xml deleted file mode 100644 index 6e6ec45fd7..0000000000 --- a/reference/pthreads/stackable/getthreadid.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - Stackable::getThreadId - Identification - - - - &reftitle.description; - - final public longStackable::getThreadId - - - - Will return the identity of the Worker Thread executing the referenced Stackable - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A numeric value, which can be used within a Stackable to retrieve the Worker Thread executing the object. - - - - - diff --git a/reference/pthreads/stackable/isrunning.xml b/reference/pthreads/stackable/isrunning.xml deleted file mode 100644 index 0f6f103ae9..0000000000 --- a/reference/pthreads/stackable/isrunning.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Stackable::isRunning - State Detection - - - - &reftitle.description; - - final public booleanStackable::isRunning - - - - A Stackable is running when a Worker Thread is executing it - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A boolean indication of state - - - - - - - diff --git a/reference/pthreads/stackable/iswaiting.xml b/reference/pthreads/stackable/iswaiting.xml deleted file mode 100644 index bb729c377f..0000000000 --- a/reference/pthreads/stackable/iswaiting.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Stackable::isWaiting - State Detection - - - - &reftitle.description; - - final public booleanStackable::isWaiting - - - - Tell if the referenced Stackable is waiting for notification - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A boolean indication of state - - - - - - - diff --git a/reference/pthreads/stackable/notify.xml b/reference/pthreads/stackable/notify.xml deleted file mode 100644 index e1983582ef..0000000000 --- a/reference/pthreads/stackable/notify.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Stackable::notify - Synchronization - - - - &reftitle.description; - - final public intStackable::notify - - - - Sends notification to a Stackable that is waiting - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An integral indication of success - - - - - - - diff --git a/reference/pthreads/stackable/run.xml b/reference/pthreads/stackable/run.xml deleted file mode 100644 index 5f3b21b60e..0000000000 --- a/reference/pthreads/stackable/run.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Stackable::run - Execution - - - - &reftitle.description; - - abstract public mixedStackable::run - - - - The run method of a Stackable is executed by the Worker Thread - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/pthreads/stackable/wait.xml b/reference/pthreads/stackable/wait.xml deleted file mode 100644 index 4dd268ec9c..0000000000 --- a/reference/pthreads/stackable/wait.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Stackable::wait - Synchronization - - - - &reftitle.description; - - final public intStackable::wait - stringtimeout - - - Waits for notification from the Stackable - - - - - &reftitle.parameters; - - - timeout - - - An optional timeout in millions of a second. - - - - - - - - &reftitle.returnvalues; - - An integral indication of success - - - - - - - diff --git a/reference/pthreads/thread.xml b/reference/pthreads/thread.xml deleted file mode 100644 index f1d02f24b6..0000000000 --- a/reference/pthreads/thread.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The Thread class - Thread - - - - -
- &reftitle.intro; - - An implementation of a Thread should extend this declaration, implementing the run method. When the start method of that object is called, the run method code will be executed in separate Thread. - -
- - -
- &reftitle.classsynopsis; - - - - Thread - - - - - Thread - - - - - &Methods; - - - - -
- -
- - &reference.pthreads.entities.thread; - -
- - diff --git a/reference/pthreads/thread/getcount.xml b/reference/pthreads/thread/getcount.xml deleted file mode 100644 index 7b75261bf7..0000000000 --- a/reference/pthreads/thread/getcount.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Thread::getCount - Statistics - - - - &reftitle.description; - - final public static intThread::getCount - - - - Will return the number of Threads ( including Workers ) in scope in the current instance of PHP - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An integral number - - - - - - - diff --git a/reference/pthreads/thread/getmax.xml b/reference/pthreads/thread/getmax.xml deleted file mode 100644 index cc623fd976..0000000000 --- a/reference/pthreads/thread/getmax.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Thread::getMax - Statistics - - - - &reftitle.description; - - final public static longThread::getMax - - - - Will return the maximum number of Threads the current instance is permitted to create - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An integral number - - - - - - - diff --git a/reference/pthreads/thread/getpeak.xml b/reference/pthreads/thread/getpeak.xml deleted file mode 100644 index 909d90bc69..0000000000 --- a/reference/pthreads/thread/getpeak.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - Thread::getPeak - Statistics - - - - &reftitle.description; - - final public static longThread::getPeak - - - - Will return the peak number of Threads the current instance has executed concurrently - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An integral number - - - - - diff --git a/reference/pthreads/thread/getstacked.xml b/reference/pthreads/thread/getstacked.xml deleted file mode 100644 index 252dba65c6..0000000000 --- a/reference/pthreads/thread/getstacked.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - Thread::getStacked - Return the number of items on the referenced Threads stack. - - - - &reftitle.description; - - final public intThread::getStacked - - - Return the number of items waiting to be executed by the referenced Thread. - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - An integral number representing the number of items left on the stack. - - - - - - diff --git a/reference/pthreads/thread/getthread.xml b/reference/pthreads/thread/getthread.xml deleted file mode 100644 index c352ea92ee..0000000000 --- a/reference/pthreads/thread/getthread.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - Thread::getThread - Synchronization - - - - &reftitle.description; - - final public static mixedThread::getThread - stringtid - - - Will return an object representing the thread identified by tid if it can be found executing in the current instance - - - - - &reftitle.parameters; - - - tid - - - The identity of the Thread or Worker you wish to import into the calling context - - - - - - - - &reftitle.returnvalues; - - An object of the same type as the requested Thread or Worker - - - - - - diff --git a/reference/pthreads/thread/getthreadid.xml b/reference/pthreads/thread/getthreadid.xml deleted file mode 100644 index d944f4f0ea..0000000000 --- a/reference/pthreads/thread/getthreadid.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Thread::getThreadId - Identification - - - - &reftitle.description; - - final public longThread::getThreadId - - - - Will return the identity of the referenced Thread - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A numeric value representing the identity of the referenced Thread - - - - - - - diff --git a/reference/pthreads/thread/isjoined.xml b/reference/pthreads/thread/isjoined.xml deleted file mode 100644 index 614597e776..0000000000 --- a/reference/pthreads/thread/isjoined.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Thread::isJoined - State Detection - - - - &reftitle.description; - - final public booleanThread::isJoined - - - - Tell if the referenced Thread has been joined by another context - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A boolean indication of state - - - - - - - diff --git a/reference/pthreads/thread/isrunning.xml b/reference/pthreads/thread/isrunning.xml deleted file mode 100644 index 2e68a6d292..0000000000 --- a/reference/pthreads/thread/isrunning.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Thread::isRunning - State Detection - - - - &reftitle.description; - - final public booleanThread::isRunning - - - - Tell if the referenced Thread is executing - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A boolean indication of state - - - - - - - diff --git a/reference/pthreads/thread/isstarted.xml b/reference/pthreads/thread/isstarted.xml deleted file mode 100644 index 86109a2dbb..0000000000 --- a/reference/pthreads/thread/isstarted.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Thread::isStarted - State Detection - - - - &reftitle.description; - - final public booleanThread::isStarted - - - - Tell if the referenced Thread has been started - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A boolean indication of state - - - - - - - diff --git a/reference/pthreads/thread/iswaiting.xml b/reference/pthreads/thread/iswaiting.xml deleted file mode 100644 index 8e399686bd..0000000000 --- a/reference/pthreads/thread/iswaiting.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Thread::isWaiting - State Detection - - - - &reftitle.description; - - final public booleanThread::isWaiting - - - - Tell if the referenced Thread is waiting for notification - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A boolean indication of state - - - - - - - diff --git a/reference/pthreads/thread/join.xml b/reference/pthreads/thread/join.xml deleted file mode 100644 index 343daee592..0000000000 --- a/reference/pthreads/thread/join.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Thread::join - Synchronization - - - - &reftitle.description; - - final public mixedThread::join - - - - Causes the calling context to wait for the referenced Thread to finish executing - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/pthreads/thread/notify.xml b/reference/pthreads/thread/notify.xml deleted file mode 100644 index 08755d6571..0000000000 --- a/reference/pthreads/thread/notify.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Thread::notify - Synchronization - - - - &reftitle.description; - - final public intThread::notify - - - - Send notification to the referenced Thread - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An integral indication of success - - - - - - - diff --git a/reference/pthreads/thread/run.xml b/reference/pthreads/thread/run.xml deleted file mode 100644 index cc7211a0ac..0000000000 --- a/reference/pthreads/thread/run.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Thread::run - Execution - - - - &reftitle.description; - - abstract public mixedThread::run - - - - The run method of a Thread is executed in a Thread when a call to Thread::start is made - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/pthreads/thread/start.xml b/reference/pthreads/thread/start.xml deleted file mode 100644 index 450e826686..0000000000 --- a/reference/pthreads/thread/start.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Thread::start - Execution - - - - &reftitle.description; - - final public booleanThread::start - booleansynchronized - - - Will start executing this implementations run method in a seperate Thread - - - - - &reftitle.parameters; - - - synchronized - - - When true will cause the calling context to wait for notification from the Thread before returning from the call to Thread::start - - - - - - - - &reftitle.returnvalues; - - A boolean indication of success - - - - - - - diff --git a/reference/pthreads/thread/wait.xml b/reference/pthreads/thread/wait.xml deleted file mode 100644 index 615143785d..0000000000 --- a/reference/pthreads/thread/wait.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Thread::wait - Synchronization - - - - &reftitle.description; - - final public intThread::wait - longtimeout - - - Will cause the calling Thread to wait for notification from the referenced Thread - - - - - &reftitle.parameters; - - - timeout - - - An optional timeout in millionths of a second - - - - - - - - &reftitle.returnvalues; - - An integral indication of success - - - - - - - diff --git a/reference/pthreads/versions.xml b/reference/pthreads/versions.xml deleted file mode 100644 index a8a6ae62fd..0000000000 --- a/reference/pthreads/versions.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/pthreads/worker.xml b/reference/pthreads/worker.xml deleted file mode 100644 index 914dc810f6..0000000000 --- a/reference/pthreads/worker.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The Worker class - Worker - - - - -
- &reftitle.intro; - - Worker Threads have a persistent context, as such should be used over Threads in most cases. - -
- - -
- &reftitle.classsynopsis; - - - - Worker - - - - - Worker - - - - - &Methods; - - - - -
- -
- - &reference.pthreads.entities.worker; - -
- - diff --git a/reference/pthreads/worker/getcreatorid.xml b/reference/pthreads/worker/getcreatorid.xml deleted file mode 100644 index 7220f20811..0000000000 --- a/reference/pthreads/worker/getcreatorid.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Worker::getCreatorId - Identification - - - - &reftitle.description; - - final public longWorker::getCreatorId - - - - Will return the identity of the Thread that created the referenced Thread - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A numeric value representing the identity of the creating context - - - - - - - diff --git a/reference/pthreads/worker/getstacked.xml b/reference/pthreads/worker/getstacked.xml deleted file mode 100644 index db3208fb0d..0000000000 --- a/reference/pthreads/worker/getstacked.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Worker::getStacked - Stack Analysis - - - - &reftitle.description; - - final public intWorker::getStacked - - - - Returns the number of Stackables waiting to be executed by the referenced Worker - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - An integral value - - - - - - - diff --git a/reference/pthreads/worker/getthreadid.xml b/reference/pthreads/worker/getthreadid.xml deleted file mode 100644 index 30a021d1e4..0000000000 --- a/reference/pthreads/worker/getthreadid.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Worker::getThreadId - Identification - - - - &reftitle.description; - - final public longWorker::getThreadId - - - - Will return the identity of the referenced Worker - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A numeric value representing the identity of the referenced Worker - - - - - - - diff --git a/reference/pthreads/worker/isjoined.xml b/reference/pthreads/worker/isjoined.xml deleted file mode 100644 index 054d70c832..0000000000 --- a/reference/pthreads/worker/isjoined.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Worker::isJoined - State Detection - - - - &reftitle.description; - - final public booleanWorker::isJoined - - - - Tell if the referenced Worker has been joined by another context - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A boolean indication of state - - - - - - - diff --git a/reference/pthreads/worker/iswaiting.xml b/reference/pthreads/worker/iswaiting.xml deleted file mode 100644 index 9b02ba9f51..0000000000 --- a/reference/pthreads/worker/iswaiting.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Worker::isWaiting - State Detection - - - - &reftitle.description; - - final public booleanWorker::isWaiting - - - - Tell if the referenced Worker is waiting for notification - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A boolean indication of state - - - - - - - diff --git a/reference/pthreads/worker/join.xml b/reference/pthreads/worker/join.xml deleted file mode 100644 index 242fceb40a..0000000000 --- a/reference/pthreads/worker/join.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Worker::join - Synchronization - - - - &reftitle.description; - - final public mixedWorker::join - - - - Causes the calling context to wait for the referenced Worker to finish executing all of the Stackables previously stacked - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/pthreads/worker/run.xml b/reference/pthreads/worker/run.xml deleted file mode 100644 index 4ba0b7dab1..0000000000 --- a/reference/pthreads/worker/run.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - Worker::run - Execution - - - - &reftitle.description; - - abstract public mixedWorker::run - - - - The run method of a Worker is executed before any Stackables such that the context and workers parameters may be setup in preparation for the Stackables to come - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/pthreads/worker/stack.xml b/reference/pthreads/worker/stack.xml deleted file mode 100644 index 487e48dca7..0000000000 --- a/reference/pthreads/worker/stack.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Worker::stack - Stacking - - - - &reftitle.description; - - final public intWorker::stack - Stackablework - - - Appends the referenced Stackable to the stack of the referenced Worker - - - - - &reftitle.parameters; - - - work - - - An object of type Stackable to be executed by the referenced Worker - - - - - - - - &reftitle.returnvalues; - - The new length of the stack - - - - - - - diff --git a/reference/pthreads/worker/start.xml b/reference/pthreads/worker/start.xml deleted file mode 100644 index 3ed4a52bab..0000000000 --- a/reference/pthreads/worker/start.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Worker::start - Execution - - - - &reftitle.description; - - final public booleanWorker::start - booleansynchronized - - - Will start a new Thread, first executing Worker::run and then waiting for an executing Stackables - - - - - &reftitle.parameters; - - - synchronized - - - When true will cause the calling context to wait for notification from the Worker before returning from the call to Worker::start - - - - - - - - &reftitle.returnvalues; - - A boolean indication of success - - - - - - - diff --git a/reference/pthreads/worker/unstack.xml b/reference/pthreads/worker/unstack.xml deleted file mode 100644 index ad4df2e004..0000000000 --- a/reference/pthreads/worker/unstack.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - Worker::unstack - Stacking - - - - &reftitle.description; - - final public intWorker::unstack - Stackablework - - - Removes the referenced Stackable ( or all Stackables if parameters are void ) from stack of the referenced Worker - - - - - &reftitle.parameters; - - - work - - - An object of type Stackable - - - - - - - - &reftitle.returnvalues; - - The new length of the stack - - - - - - -