README

True concurrency using native threading and multiprocessing for parallelizing code, without blocking.

This library is a component for Icicle that provides native threading, multiprocessing, process synchronization, shared memory, and task workers. Like other Icicle components, this library uses Coroutines built from Awaitables and Generators to make writing asynchronous code more like writing synchronous code.

This library provides a means of parallelizing code without littering your application with complicated lock checking and inter-process communication.

To be as flexible as possible, this library comes with a collection of non-blocking concurrency tools that can be used independently as needed, as well as an "opinionated" worker API that allows you to assign units of work to a pool of worker threads or processes.

Documentation and Support

Requirements

PHP 5.5+ for v0.3.x branch (current stable) and v1.x branch (mirrors current stable)
PHP 7 for v2.0 (master) branch supporting generator delegation and return expressions

Suggested

pthreads extension: Best extension option for concurrency in PHP, but it requires PHP to be compiled with --enable-maintainer-zts to enable thread-safety.
pcntl extension: Enables forking concurrency method.
sysvmsg extension: Required for sharing memory between forks or processes.

Installation

The recommended way to install is with the Composer package manager. (See the Composer installation guide for information on installing and using Composer.)

Run the following command to use this package in your project:

composer require icicleio/concurrent

You can also manually edit composer.json to add this library as a project requirement.

// composer.json
{
    "require": {
        "icicleio/concurrent": "^0.3"
    }
}

Development and Contributing

Interested in contributing to Icicle? Please see our contributing guidelines in the Icicle repository.

Want to hack on the source? A Vagrant box is provided with the repository to give a common development environment for running concurrent threads and processes, and comes with a bunch of handy tools and scripts for testing and experimentation.

Starting up and logging into the virtual machine is as simple as

vagrant up && vagrant ssh

Once inside the VM, you can install PHP extensions with Pickle, switch versions with newphp VERSION, and test for memory leaks with Valgrind.

icicleio / concurrent

Maintainers

Details