Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dazzle-php/stream

Dazzle Async Stream
https://github.com/dazzle-php/stream

async dazzle php php-lib php7 stream stream-handling

Last synced: about 2 months ago
JSON representation

Dazzle Async Stream

Awesome Lists containing this project

README

        

# Dazzle Async Stream

[![Build Status](https://travis-ci.org/dazzle-php/stream.svg)](https://travis-ci.org/dazzle-php/stream)
[![Code Coverage](https://scrutinizer-ci.com/g/dazzle-php/stream/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/dazzle-php/stream/?branch=master)
[![Code Quality](https://scrutinizer-ci.com/g/dazzle-php/stream/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/dazzle-php/stream/?branch=master)
[![Latest Stable Version](https://poser.pugx.org/dazzle-php/stream/v/stable)](https://packagist.org/packages/dazzle-php/stream)
[![Latest Unstable Version](https://poser.pugx.org/dazzle-php/stream/v/unstable)](https://packagist.org/packages/dazzle-php/stream)
[![License](https://poser.pugx.org/dazzle-php/stream/license)](https://packagist.org/packages/dazzle-php/stream/license)

> **Note:** This repository is part of [Dazzle Project](https://github.com/dazzle-php/dazzle) - 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](https://github.com/dazzle-php) for the full extent of Dazzle experience.





## Description

Dazzle Stream is a component that provides consistent interface for streams and allows asynchronous writing and reading.

## Feature Highlights

Dazzle Stream features:

* Consistent interface for using streams,
* Implementation of asynchronous and synchronous streams,
* ...and more.

## Provided Example(s)

### Quickstart

TODO

### Additional

TODO

## Requirements

Dazzle Stream requires:

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

## Installation

To install this library make sure you have [composer](https://getcomposer.org/) installed, then run following command:

```
$> composer require dazzle-php/stream
```

## 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](https://github.com/dazzle-php/dazzle). 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](https://github.com/dazzle-php/stream/blob/master/CONTRIBUTING.md).
- Open tickets can be found in [issues section](https://github.com/dazzle-php/stream/issues).
- Current contributors are listed in [graphs section](https://github.com/dazzle-php/stream/graphs/contributors)
- To contact the author(s) see the information attached in [composer.json](https://github.com/dazzle-php/stream/blob/master/composer.json) file.

## License

Dazzle Stream is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).




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