Mojo::IOLoop::Stream - IOLoop stream
use Mojo::IOLoop::Stream; # Create stream my $stream = Mojo::IOLoop::Stream->new($handle); $stream->on(read => sub { my ($stream, $chunk) = @_; ... }); $stream->on(close => sub { my $stream = shift; ... }); $stream->on(error => sub { my ($stream, $error) = @_; ... }); # Start and stop watching for new data $stream->resume; $stream->pause;
Mojo::IOLoop::Stream is a container for streaming handles used by Mojo::IOLoop. Note that this module is EXPERIMENTAL and might change without warning!
Mojo::IOLoop::Stream can emit the following events.
close
$stream->on(close => sub { my $stream = shift; });
Emitted if the stream gets closed.
drain
$stream->on(drain => sub { my $stream = shift; });
Emitted once all data has been written.
error
$stream->on(error => sub { my ($stream, $error) = @_; });
Emitted if an error happens on the stream.
read
$stream->on(read => sub { my ($stream, $chunk) = @_; });
Emitted if new data arrives on the stream.
Mojo::IOLoop::Stream implements the following attributes.
iowatcher
my $watcher = $stream->iowatcher; $stream = $stream->iowatcher(Mojo::IOWatcher->new);
Low level event watcher, usually a Mojo::IOWatcher or Mojo::IOWatcher::EV object.
Mojo::IOLoop::Stream inherits all methods from Mojo::EventEmitter and implements the following new ones.
new
my $stream = Mojo::IOLoop::Stream->new($handle);
Construct a new Mojo::IOLoop::Stream object.
handle
my $handle = $stream->handle;
Get handle for stream.
is_writing
my $success = $stream->is_writing;
Check if stream is writing.
pause
$stream->pause;
Stop watching for new data on the stream.
resume
$stream->resume;
Start watching for new data on the stream.
steal_handle
my $handle = $stream->steal_handle;
Steal handle from stream and prevent it from getting closed automatically.
write
$stream->write('Hello!'); $stream->write('Hello!', sub {...});
Write data to stream, the optional drain callback will be invoked once all data has been written.
Mojolicious, Mojolicious::Guides, http://mojolicio.us.
To install Mojolicious, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Mojolicious
CPAN shell
perl -MCPAN -e shell install Mojolicious
For more information on module installation, please visit the detailed CPAN module installation guide.