execute read-the-docs.sh

Creational/Pool/index.rst

@@ -0,0 +1,69 @@
+Pool
+====
+
+The **object pool pattern** is a software creational design pattern that
+uses a set of initialized objects kept ready to use – a "pool" – rather
+than allocating and destroying them on demand. A client of the pool will
+request an object from the pool and perform operations on the returned
+object. When the client has finished, it returns the object, which is a
+specific type of factory object, to the pool rather than destroying it.
+
+Object pooling can offer a significant performance boost in situations
+where the cost of initializing a class instance is high, the rate of
+instantiation of a class is high, and the number of instances in use at
+any one time is low. The pooled object is obtained in predictable time
+when creation of the new objects (especially over network) may take
+variable time.
+
+However these benefits are mostly true for objects that are expensive
+with respect to time, such as database connections, socket connections,
+threads and large graphic objects like fonts or bitmaps. In certain
+situations, simple object pooling (that hold no external resources, but
+only occupy memory) may not be efficient and could decrease performance.
+
+UML Diagram
+-----------
+
+.. image:: uml/uml.png
+   :alt: Alt Pool UML Diagram
+   :align: center
+
+Code
+----
+
+You can also find these code on `GitHub`_
+
+Pool.php
+
+.. literalinclude:: Pool.php
+   :language: php
+   :linenos:
+
+Processor.php
+
+.. literalinclude:: Processor.php
+   :language: php
+   :linenos:
+
+Worker.php
+
+.. literalinclude:: Worker.php
+   :language: php
+   :linenos:
+
+Test
+----
+
+Tests/TestWorker.php
+
+.. literalinclude:: Tests/TestWorker.php
+   :language: php
+   :linenos:
+
+Tests/PoolTest.php
+
+.. literalinclude:: Tests/PoolTest.php
+   :language: php
+   :linenos:
+
+.. _`GitHub`: https://github.com/domnikl/DesignPatternsPHP/tree/master/Creational/Pool