Home

Awesome

Dazzle Async I/O Event Loop

Build Status Code Coverage Code Quality Latest Stable Version Latest Unstable Version License

Note: This repository is part of Dazzle Project - the next-gen library for PHP. The project's purpose is to provide PHP developers with a set of complete tools to build functional async applications. Please, make sure you read the attached README carefully and it is guaranteed you will be surprised how easy to use and powerful it is. In the meantime, you might want to check out the rest of our async libraries in Dazzle repository for the full extent of Dazzle experience.

<br> <p align="center"> <img src="https://raw.githubusercontent.com/dazzle-php/dazzle/master/media/dazzle-x125.png" /> </p>

Description

Dazzle Loop is a component that provides abstraction layer for writing asynchronous code in PHP on single thread or process with usage of single or multiple loops.

Feature Highlights

Dazzle Loop features:

Provided Example(s)

Quickstart

This example shows implementation of non-blocking clock using loop:

$loop = new Loop();

$loop->addPeriodicTimer(1, function() {
    printf("\rCurrent clock: %s", date('Y-m-d H:i:s'));
});

$loop->start();

Additional

Additional examples can be found in example directory. Below is the list of provided examples as a reference and preferred consumption order:

If any of the above examples has left you confused, please take a look in the tests directory as well.

Comparison

This section contains Dazzle vs React comparison many users requested. If you are wondering why this section has been created, see the author's note.

Performance

<br> <p align="center"> <img src="https://raw.githubusercontent.com/dazzle-php/loop/master/media/graph-perf-cpu.png" /> </p>

The detailed information about this benchmark can be found in benchmark-on.php and benchmark-react.php files.

Memory Allocation Efficiency

<br> <p align="center"> <img src="https://raw.githubusercontent.com/dazzle-php/loop/master/media/graph-perf-mem.png" /> </p>

The detailed information about this benchmark can be found in benchmark-once.php and benchmark-react.php files.

Details

DetailDazzle EventReact-equivalent
Active supportX?
Provided well-formed documentationXX
Provided well-formed set of tests with at least 80% coverage and API examplesXX
Support for executing event ticksXX
Support for before and after event ticks listenersXX
Support for timersXX
Support for periodic timersXX
Asynchronous writing of streamsXX
Asynchronous reading of streamsXX
Cancelling timersXX
Implemented stream modelXX
Implemented lib-event modelWIPX
Implemented lib-ev modelWIPX
Implemented ext-event modelWIPX
Support for state change eventsX
Support for flow controlsX
Support for multiple flows and switching between active onesX

Requirements

Loop requires:

Installation

To install this library make sure you have composer installed, then run following command:

$> composer require dazzle-php/loop

Tests

Tests can be run via:

$> vendor/bin/phpunit -d memory_limit=1024M

Versioning

Versioning of Dazzle libraries is described in versioning section of Dazzle Project index repository. Please, refer there for detailed information on the subject.

Contributing

Thank you for considering contributing to this repository!

License

Dazzle Loop is open-sourced software licensed under the MIT license.

<hr> <p align="center"> <i>"Everything is possible. The impossible just takes longer."</i> ― Dan Brown </p>