werkint / reactphp-stream
This package is abandoned and no longer maintained.
The author suggests using the werkint/reactphp-stream package instead.
Basic readable and writable stream interfaces that support piping.
v0.4.4
2016-08-22 09:51 UTC
Requires
- php: >=5.3.8
- evenement/evenement: ^2.0|^1.0
Requires (Dev)
- clue/stream-filter: ~1.2
- react/event-loop: ^0.4|^0.3
- react/promise: ^2.0|^1.0
Suggests
- react/event-loop: ^0.4
- react/promise: ^2.0
- dev-master
- v0.4.4
- v0.4.1
- v0.4.0
- 0.3.x-dev
- v0.3.4
- v0.3.3
- v0.3.2
- v0.3.1
- v0.3.0
- v0.2.6
- v0.2.5
- v0.2.4
- v0.2.3
- v0.2.2
- v0.2.1
- v0.2.0
- v0.1.1
- v0.1.0
- dev-no-full-drain
- dev-inject-buffer
- dev-buffer-close
- dev-immediate-writes
- dev-composite-close
- dev-fu-feof
- dev-close-buffer-once
- dev-no-bufferedsink
- dev-nbio
- dev-no-end
- dev-changelog
This package is not auto-updated.
Last update: 2019-02-20 19:06:05 UTC
README
Basic readable and writable stream interfaces that support piping.
In order to make the event loop easier to use, this component introduces the concept of streams. They are very similar to the streams found in PHP itself, but have an interface more suited for async I/O.
Mainly it provides interfaces for readable and writable streams, plus a file descriptor based implementation with an in-memory write buffer.
This component depends on événement
, which is an implementation of the
EventEmitter
.
Readable Streams
EventEmitter Events
data
: Emitted whenever data was read from the source.end
: Emitted when the source has reached theeof
.error
: Emitted when an error occurs.close
: Emitted when the connection is closed.
Methods
isReadable()
: Check if the stream is still in a state allowing it to be read from. It becomes unreadable when the connection ends, closes or an error occurs.pause()
: Remove the data source file descriptor from the event loop. This allows you to throttle incoming data.resume()
: Re-attach the data source after apause()
.pipe(WritableStreamInterface $dest, array $options = [])
: Pipe this readable stream into a writable stream. Automatically sends all incoming data to the destination. Automatically throttles based on what the destination can handle.
Writable Streams
EventEmitter Events
drain
: Emitted if the write buffer became full previously and is now ready to accept more data.error
: Emitted whenever an error occurs.close
: Emitted whenever the connection is closed.pipe
: Emitted whenever a readable stream ispipe()
d into this stream.
Methods
isWritable()
: Check if the stream can still be written to. It cannot be written to after an error or when it is closed.write($data)
: Write some data into the stream. If the stream cannot handle it, it should buffer the data or emit anderror
event. If the internal buffer is full after adding$data
,write
should return false, indicating that the caller should stop sending data until the bufferdrain
s.end($data = null)
: Optionally write some final data to the stream, empty the buffer, then close it.
Usage
$loop = React\EventLoop\Factory::create(); $source = new React\Stream\Stream(fopen('omg.txt', 'r'), $loop); $dest = new React\Stream\Stream(fopen('wtf.txt', 'w'), $loop); $source->pipe($dest); $loop->run();