1
0
mirror of https://github.com/danog/byte-stream.git synced 2024-11-26 20:04:51 +01:00

Add Payload docs

This commit is contained in:
Aaron Piotrowski 2018-03-13 10:26:29 -05:00
parent 6bd0be750d
commit bfa012e810
No known key found for this signature in database
GPG Key ID: ADD1EF783EDE9EEB
2 changed files with 28 additions and 0 deletions

View File

@ -2,6 +2,10 @@
title: Message
permalink: /message
---
{:.note}
> `Message` has been deprecated. Use [`Payload`](./payload.md) instead.
`Message` implements both `InputStream` _and_ `Promise`. This allows consuming a message either in chunks (streaming) or consume everything at once (buffering).
## Buffering

24
docs/payload.md Normal file
View File

@ -0,0 +1,24 @@
---
title: Payload
permalink: /payload
---
`Payload` implements `InputStream` while also providing a method `buffer()` for buffering the entire contents. This allows consuming a message either in chunks (streaming) or consume everything at once (buffering). When the object is destructed, any remaining data in the stream is automatically consumed and discarded. This class is useful for small payloads or when the entire contents of a stream is needed before any processing can be done.
## Buffering
Buffering a complete input stream is quite easy, you can simply `yield` the promise returned from `buffer()` just like any other `Promise`. If you have an `InputStream` that's not a `Payload`, simply create a new instance from it using `new Payload($inputStream)`.
```php
$payload = new Payload($inputStream);
$content = yield $payload->buffer();
```
## Streaming
Sometimes it's useful / possible to consume a payload in chunks rather than first buffering it completely. An example might be streaming a large HTTP response body directly to disk.
```php
while (($chunk = yield $payload->read()) !== null) {
// Use $chunk here, works just like any other InputStream
}
```