Pool Class Reference

Public Member Functions
	__construct ($size, $class, $ctor=[])
	collect (callable $collector)
	resize ($size)
	shutdown ()
	submit (Threaded $task)
	submitTo ($worker, Threaded $task)

Protected Attributes
	$size
	$class
	$workers
	$ctor
	$last

Detailed Description

Pool class

A Pool is a container for, and controller of, a number of Worker threads, the number of threads can be adjusted during execution, additionally the Pool provides an easy mechanism to maintain and collect references in the proper way.

http://www.php.net/manual/en/class.pool.php

Constructor & Destructor Documentation

__construct()

__construct	(		$size,
			$class,
			$ctor = []
	)

Construct a new Pool of Workers

Parameters

integer	$size	The maximum number of Workers this Pool can create
string | null	$class	The class for new Workers
array | null	$ctor	An array of arguments to be passed to new Workers

http://www.php.net/manual/en/pool.__construct.php

{}

Member Function Documentation

collect()

collect

(

callable

$collector

)

Collect references to completed tasks

Allows the Pool to collect references determined to be garbage by the given collector

Parameters

callable

$collector

http://www.php.net/manual/en/pool.collect.php

{}

resize()

resize

(

$size

)

Resize the Pool

Parameters

integer

$size

The maximum number of Workers this Pool can create

http://www.php.net/manual/en/pool.resize.php

{}

shutdown()

shutdown

(

)

Shutdown all Workers in this Pool

http://www.php.net/manual/en/pool.shutdown.php

{}

submit()

submit

(

Threaded

$task

)

Submit the task to the next Worker in the Pool

Parameters

Threaded

$task

The task for execution

Returns

int the identifier of the Worker executing the object

{}

submitTo()

submitTo	(		$worker,
		Threaded	$task
	)

Submit the task to the specific Worker in the Pool

Parameters

int	$worker	The worker for execution
Threaded	$task	The task for execution

Returns

int the identifier of the Worker that accepted the object

{}

Field Documentation

$class

$class

protected

$ctor

$ctor

protected

$last

$last

protected

$size

$size

protected

$workers

$workers

protected

---

The documentation for this class was generated from the following file:

• src/spl/stubs/pthreads.php