README

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.

Description

Dazzle Channel is an event-based component that allows sending and receiving messsages asynchronously. It provides abstraction for various IPC models and is designed to be used in multi-threaded, multi-processed systems. It provides complex routing mechanisms, protocols, message encoders and extends behaviour of decorated IPC models by implementing hearbeat mechanisms, reconnect mechanisms and allowing usage of both async and request-reply messaging patterns.

Feature Highlights

Dazzle Channel features:

Message-driven communication,
IPC models abstraction,
Support for sending asynchronous messages,
Support for request-reply pattern,
Built-in offline and online message buffers,
Built-in configurable protocol-based routing mechanisms,
Separation of input and output routers,
Heartbeat mechanism,
Reconnect mechanism,
Event-based & Promise-based API,
...and more.

Provided Example(s)

Quickstart

TODO

Additional

TODO

Requirements

Dazzle Channel requires:

PHP-5.6 or PHP-7.0+,
UNIX or Windows OS.

Installation

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

$> composer require dazzle-php/channel

Tests

Tests can be run via:

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

Versioning

Versioning of Dazzle libraries is being shared between all packages included in Dazzle Project. That means the releases are being made concurrently for all of them. On one hand this might lead to "empty" releases for some packages at times, but don't worry. In the end it is far much easier for contributors to maintain and -- what's the most important -- much more straight-forward for users to understand the compatibility and inter-operability of the packages.

Contributing

Thank you for considering contributing to this repository!

The contribution guide can be found in the contribution tips.
Open tickets can be found in issues section.
Current contributors are listed in graphs section
To contact the author(s) see the information attached in composer.json file.

License

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

"Everything is possible. The impossible just takes longer." ― Dan Brown

dazzle-php / channel

Maintainers

Details