Download the PHP package ssigwart/process-pool without Composer

On this page you can find all versions of the php package ssigwart/process-pool. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of ssigwart/process-pool

Informations about the package process-pool

Process Pool Package

This package allows you to run a process pool. The pool will multiple background processes to handle messages to the pool. You can specific the minimum and maximum number of pool processes to run.

Creating a Pool

Implementing a Pool Process

The pool process should implement ssigwart\ProcessPool\ProcessPoolProcessMessageHandlerInterface. The handleRequest function should handle incoming requests. It can output to stdout and stderr, which can be read with getStdoutResponse and getStderrResponse.

Below is an example of what /path/to/pool/process/process.php might look like.

Sending a Message to the Pool

  1. Start a process

  2. At this point, you should add $req1 to an array of pending requests and send any other message you need to the queue. At some point in the future, you should check if and of those processes have data yet by calling hasStdoutData() and hasStderrData().

  3. Get output and release process so if can be used for another request

Classes and Public API

ProcessPool

The process pool is used to maintain the pool state and start and stop processes.

Constructor (__construct)

Parameter Type Description
$minNumProcs int Minimum number of processes to run in the pool.
$maxNumProcs int Maximum number of processes to run in the pool.
$cmd string Command to start the background process to handle a request.
$cwd ?string Optional working directory to use when starting the process.
$env |?array` Optional hash of environment variables for the process

setMaxNumSpareProcesses

Sets the maximum number of spare processes to leave running in the pool after they complete a request, but are waiting for a new request.

Parameter Type Description
$maxNumUnassignedProcs int Maximum number of spare processes to run in the pool.

getNumRunningProcesses

Returns the number of running processes. A running process is one that is actively handling a request at the moment.

getNumUnassignedProcesses

Returns the number of unassigned processes. An unassigned process is one that is waiting for a request to process.

startProcess

Starts a new process.

IMPORTANT! Remember to call releaseProcess on the pool to free the resources of the process when you're done with it.

This may throw a ProcessPoolPoolExhaustedException if the pool has reached the maximum number of allowed processes.

It returns a ProcessPoolRequest that you can send your request to.

releaseProcess

This releases a process started with startProcess and allows it to go back into the spare process pool to handle additional requests.

Parameter Type Description
$process ProcessPoolRequest Process to release.

shutDown

This sends "exit" requests to all processes and closes them. This should only be called after handling all open processes and the pool should not be used after this. Often, you don't need to call this function as the pool registers a shutdown function.

ProcessPoolRequest

Represents a pool request that can process a single request.

sendRequest

Parameter Type Description
$data string Data you want to send to the process to handle.

hasFailed

Returns true if the process handling the request has failed.

waitForStdoutOrStderr

Waits for data on STDOUT or STDERR.

Parameter Type Description
$waitSec int Maximum number of seconds + waitUsec microseconds to wait.
$waitUsec int Maximum number of microseconds + $waitSec seconds to wait.

The returns true if there's data available. If so, hasStdoutData and hasStderrData should be called.

hasStdoutData

Returns true if the request has STDOUT data available. Note that this may return true when EOF, but the data returned from getStdoutResponse may be an empty string.

hasStderrData

Returns true if the request has STDERR data available. Note that this may return true when EOF, but the data returned from getStderrResponse may be an empty string.

getStdoutResponse

Returns STDOUT response from the process.

getStderrResponse

Returns STDERR response from the process.

Other Methods

There are additional public function that you should not call directly. These include sendExitRequest, freeRequest, and close.

ProcessPoolProcess

This is used by the background process to wait for and handle incoming messages from the pool.

Constructor (__construct)

Parameter Type Description
$handler ProcessPoolProcessMessageHandlerInterface This is a custom class that you defined that will be able to handle an incoming request.

handleMessages

This function does the work of waiting for message and returning output to the parent pool process.

All versions of process-pool with dependencies

PHP Build Version
Package Version
Requires php Version >=7.0.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package ssigwart/process-pool contains the following files

Loading the files please wait ....