mirror of
https://github.com/danog/parallel.git
synced 2024-11-26 20:34:40 +01:00
66 lines
3.8 KiB
Markdown
66 lines
3.8 KiB
Markdown
# Concurrency for Amp
|
|
|
|
**True concurrency using native threading and multiprocessing for parallelizing code, *without* blocking.**
|
|
|
|
This library is a component for [Amp](https://github.com/icicleio/icicle) that provides native threading, multiprocessing, process synchronization, shared memory, and task workers. Like other Amp components, this library uses [Coroutines](https://icicle.io/docs/manual/coroutines/) built from [Awaitables](https://icicle.io/docs/manual/awaitables/) and [Generators](http://www.php.net/manual/en/language.generators.overview.php) to make writing asynchronous code more like writing synchronous code.
|
|
|
|
[](https://travis-ci.org/icicleio/concurrent)
|
|
[](https://coveralls.io/r/icicleio/concurrent)
|
|
[](http://semver.org)
|
|
[](LICENSE)
|
|
[](https://twitter.com/icicleio)
|
|
|
|
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
|
|
|
|
- [Full API Documentation](https://icicle.io/docs/api/Concurrent/)
|
|
- [Official Twitter](https://twitter.com/icicleio)
|
|
- [Gitter Chat](https://gitter.im/icicleio/icicle)
|
|
|
|
##### 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](https://pecl.php.net/package/pthreads): Best extension option for concurrency in PHP, but it requires PHP to be compiled with `--enable-maintainer-zts` to enable thread-safety.
|
|
- [pcntl extension](http://php.net/manual/en/book.pcntl.php): Enables forking concurrency method.
|
|
- [sysvmsg extension](http://php.net/manual/en/book.sem.php): Required for sharing memory between forks or processes.
|
|
|
|
##### Installation
|
|
|
|
The recommended way to install is with the [Composer](http://getcomposer.org/) package manager. (See the [Composer installation guide](https://getcomposer.org/doc/00-intro.md) for information on installing and using Composer.)
|
|
|
|
Run the following command to use this package in your project:
|
|
|
|
```bash
|
|
composer require icicleio/concurrent
|
|
```
|
|
|
|
You can also manually edit `composer.json` to add this library as a project requirement.
|
|
|
|
```js
|
|
// composer.json
|
|
{
|
|
"require": {
|
|
"icicleio/concurrent": "^0.3"
|
|
}
|
|
}
|
|
```
|
|
|
|
### Development and Contributing
|
|
|
|
Interested in contributing to Amp? Please see our [contributing guidelines](https://github.com/icicleio/icicle/blob/master/CONTRIBUTING.md) in the [Amp repository](https://github.com/icicleio/icicle).
|
|
|
|
Want to hack on the source? A [Vagrant](http://vagrantup.com) 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](https://github.com/FriendsOfPHP/pickle), switch versions with `newphp VERSION`, and test for memory leaks with [Valgrind](http://valgrind.org).
|