From 87503b01802756d371fcf53f070ab268de395916 Mon Sep 17 00:00:00 2001 From: Thomas Punt Date: Tue, 13 Feb 2018 12:13:29 +0000 Subject: [PATCH] Add renamed pht files git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344251 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/pht/pht.atomicinteger.xml | 82 ++++++++++++++++++++++++++++ reference/pht/pht.hashtable.xml | 84 +++++++++++++++++++++++++++++ reference/pht/pht.queue.xml | 77 ++++++++++++++++++++++++++ reference/pht/pht.runnable.xml | 69 ++++++++++++++++++++++++ reference/pht/pht.thread.xml | 74 +++++++++++++++++++++++++ reference/pht/pht.threaded.xml | 75 ++++++++++++++++++++++++++ reference/pht/pht.vector.xml | 84 +++++++++++++++++++++++++++++ 7 files changed, 545 insertions(+) create mode 100644 reference/pht/pht.atomicinteger.xml create mode 100644 reference/pht/pht.hashtable.xml create mode 100644 reference/pht/pht.queue.xml create mode 100644 reference/pht/pht.runnable.xml create mode 100644 reference/pht/pht.thread.xml create mode 100644 reference/pht/pht.threaded.xml create mode 100644 reference/pht/pht.vector.xml diff --git a/reference/pht/pht.atomicinteger.xml b/reference/pht/pht.atomicinteger.xml new file mode 100644 index 0000000000..8ee601e471 --- /dev/null +++ b/reference/pht/pht.atomicinteger.xml @@ -0,0 +1,82 @@ + + + + + + The AtomicInteger class + pht\AtomicInteger + + + + +
+ &reftitle.intro; + + The pht\AtomicInteger class is currently the only + supported atomic value. It allows for an integer to be safely passed around + between, and manipulated, by multiple threads. The methods exposed by this + class do not need mutex locking, since they will acquire the internal mutex + lock implicitly. pht\AtomicInteger::lock and + pht\AtomicInteger::unlock are still exposed, however, + for when multiple operations involving the same + pht\AtomicInteger object need to be grouped together. + + + The mutex locks of the atomic values are reentrant safe. + +
+ + +
+ &reftitle.classsynopsis; + + + + pht\AtomicInteger + + + + + pht\AtomicInteger + + + + pht\Threaded + + + + + &Methods; + + + + + +
+ +
+ + &reference.pht.entities.atomicinteger; + +
+ + diff --git a/reference/pht/pht.hashtable.xml b/reference/pht/pht.hashtable.xml new file mode 100644 index 0000000000..d67255c4a8 --- /dev/null +++ b/reference/pht/pht.hashtable.xml @@ -0,0 +1,84 @@ + + + + + + The HashTable class + pht\HashTable + + + + +
+ &reftitle.intro; + + The pht\HashTable class is one of the Inter-Thread + Communication (ITC) data structures exposed by pht. It can be safely passed + around between threads, and manipulated by multiple threads using the mutex + locks that have been packed in with the data structure. It is + reference-counted across threads, and so it does not need to be explicitly + destroyed. + + + The pht\HashTable class enables for array access upon + its objects (along with the isset and + unset functions). The + ArrayAccess interface is not explicitly implemented, + however, because it is only needed for such abilities by userland classes. + +
+ + +
+ &reftitle.classsynopsis; + + + + pht\HashTable + + + + + pht\HashTable + + + + pht\Threaded + + + + + &Methods; + + + + + +
+ +
+ + &reference.pht.entities.hashtable; + +
+ + diff --git a/reference/pht/pht.queue.xml b/reference/pht/pht.queue.xml new file mode 100644 index 0000000000..9062d1aa3a --- /dev/null +++ b/reference/pht/pht.queue.xml @@ -0,0 +1,77 @@ + + + + + + The Queue class + pht\Queue + + + + +
+ &reftitle.intro; + + The pht\Queue class is one of the Inter-Thread + Communication (ITC) data structures exposed by pht. It can be safely passed + around between threads, and manipulated by multiple threads using the mutex + locks that have been packed in with the data structure. It is + reference-counted across threads, and so it does not need to be explicitly + destroyed. + +
+ + +
+ &reftitle.classsynopsis; + + + + pht\Queue + + + + + pht\Queue + + + + pht\Threaded + + + + + &Methods; + + + + + +
+ +
+ + &reference.pht.entities.queue; + +
+ + diff --git a/reference/pht/pht.runnable.xml b/reference/pht/pht.runnable.xml new file mode 100644 index 0000000000..1d21e62cea --- /dev/null +++ b/reference/pht/pht.runnable.xml @@ -0,0 +1,69 @@ + + + + + + The Runnable interface + pht\Runnable + + + + +
+ &reftitle.intro; + + The pht\Runnable interface enforces the + implementation of a run() method on classes that should be threaded. This + method acts as the entry point of the threaded class. + +
+ + +
+ &reftitle.interfacesynopsis; + + + + pht\Runnable + + + + + pht\Runnable + + + + &Methods; + + + + + +
+ +
+ + &reference.pht.entities.runnable; + +
+ + diff --git a/reference/pht/pht.thread.xml b/reference/pht/pht.thread.xml new file mode 100644 index 0000000000..3d73863958 --- /dev/null +++ b/reference/pht/pht.thread.xml @@ -0,0 +1,74 @@ + + + + + + The Thread class + pht\Thread + + + + +
+ &reftitle.intro; + + The pht\Thread class abstracts away a native thread. It + has an internal task queue, where the methods + pht\Thread::addClassTask, + pht\Thread::addFunctionTask, and + pht\Thread::addFileTask push new tasks onto this + queue. Invoking the pht\Thread::start method will + cause the new thread to be spawned, where it will then begin working + through the task queue. A thread may be reused for any number of tasks. + +
+ + +
+ &reftitle.classsynopsis; + + + + pht\Thread + + + + + pht\Thread + + + + &Methods; + + + + + +
+ +
+ + &reference.pht.entities.thread; + +
+ + diff --git a/reference/pht/pht.threaded.xml b/reference/pht/pht.threaded.xml new file mode 100644 index 0000000000..880b6afb58 --- /dev/null +++ b/reference/pht/pht.threaded.xml @@ -0,0 +1,75 @@ + + + + + + The Threaded interface + pht\Threaded + + + + +
+ &reftitle.intro; + + The pht\Threaded interface is an internal interface used + by the Inter-Thread Communication (ITC) data structures + (pht\HashTable, pht\Queue, and + pht\Vector). It allows those data structures to be + threaded and ensures that the mutex locking API + (pht\Threaded::lock and + pht\Threaded::unlock) is implemented by each of the + ITC data structures. It is not implementable by userland classes (since + standalone mutex locks are not exposed). + +
+ + +
+ &reftitle.interfacesynopsis; + + + + pht\Threaded + + + + + pht\Threaded + + + + &Methods; + + + + + +
+ +
+ + &reference.pht.entities.threaded; + +
+ + diff --git a/reference/pht/pht.vector.xml b/reference/pht/pht.vector.xml new file mode 100644 index 0000000000..2375f254fa --- /dev/null +++ b/reference/pht/pht.vector.xml @@ -0,0 +1,84 @@ + + + + + + The Vector class + pht\Vector + + + + +
+ &reftitle.intro; + + The pht\Vector class is one of the Inter-Thread + Communication (ITC) data structures exposed by pht. It can be safely passed + around between threads, and manipulated by multiple threads using the mutex + locks that have been packed in with the data structure. It is + reference-counted across threads, and so is does not need to be explicitly + destroyed. + + + The pht\Vector class enables for array access upon + its objects (along with the isset and + unset functions). The + ArrayAccess interface is not explicitly implemented, + however, because it is only needed for such abilities by userland classes. + +
+ + +
+ &reftitle.classsynopsis; + + + + pht\Vector + + + + + pht\Vector + + + + pht\Threaded + + + + + &Methods; + + + + + +
+ +
+ + &reference.pht.entities.vector; + +
+ +