Skip to content

Commit

Permalink
Add Payload docs
Browse files Browse the repository at this point in the history
  • Loading branch information
trowski committed Mar 13, 2018
1 parent 6bd0be7 commit bfa012e
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/message.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
24 changes: 24 additions & 0 deletions docs/payload.md
Original file line number Diff line number Diff line change
@@ -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
}
```

0 comments on commit bfa012e

Please sign in to comment.