aab5b5f7cc
This is an automated commit. Please report any issues to https://github.com/amphp/website-tools. |
||
---|---|---|
docs | ||
examples | ||
lib | ||
test | ||
travis | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
.gitmodules | ||
.php_cs.dist | ||
.travis.yml | ||
CHANGELOG.md | ||
composer.json | ||
CONTRIBUTING.md | ||
LICENSE | ||
phpunit.xml.dist | ||
psalm.examples.xml | ||
psalm.xml | ||
README.md |
Amp is a non-blocking concurrency framework for PHP. It provides an event loop, promises and streams as a base for asynchronous programming.
Promises in combination with generators are used to build coroutines, which allow writing asynchronous code just like synchronous code, without any callbacks.
Motivation
Traditionally, PHP has a synchronous execution flow, doing one thing at a time. If you query a database, you send the query and wait for the response from the database server in a blocking manner. Once you have the response, you can start doing the next thing.
Instead of sitting there and doing nothing while waiting, we could already send the next database query, or do an HTTP call to an API.
Making use of the time we usually spend on waiting for I/O can speed up the total execution time. The following diagram shows the execution flow with dependencies between the different tasks, once executed sequentially and once concurrently.
Amp allows such concurrent I/O operations while keeping the cognitive load low by avoiding callbacks.
Instead, the results of asynchronous operations can be awaited using yield
resulting in code which is structured like traditional blocking I/O code while the actual execution flow is handled by Amp.
Installation
This package can be installed as a Composer dependency.
composer require amphp/amp
This installs the basic building blocks for asynchronous applications in PHP. We offer a lot of repositories building on top of this repository, e.g.
amphp/byte-stream
providing a stream abstractionamphp/socket
providing a socket layer for UDP and TCP including TLSamphp/parallel
providing parallel processing to utilize multiple CPU cores and offload blocking operationsamphp/http-client
providing an HTTP/1.1 and HTTP/2 clientamphp/http-server
providing an HTTP/1.1 and HTTP/2 application serveramphp/mysql
andamphp/postgres
for non-blocking database access- and many more packages
Documentation
Documentation can be found on amphp.org as well as in the ./docs
directory.
Each packages has it's own ./docs
directory.
Requirements
This package requires PHP 7.0 or later. Many of the other packages raised their requirement to PHP 7.1. No extensions required!
Optional Extensions
Extensions are only needed if your app necessitates a high numbers of concurrent socket connections, usually this limit is configured up to 1024 file descriptors.
Examples
Examples can be found in the ./examples
directory of this repository as well as in the ./examples
directory of our other libraries.
Versioning
amphp/amp
follows the semver semantic versioning specification like all other amphp
packages.
2.x
Supported. We don't have plans to release v3, yet.
1.x
No longer supported. We stopped providing bug fixes 2017-12-31 and stopped providing security fixes 2018-12-31.
Compatible Packages
Compatible packages should use the amphp
topic on GitHub.
Security
If you discover any security related issues, please email me@kelunik.com
instead of using the issue tracker.
License
The MIT License (MIT). Please see LICENSE
for more information.