Mojo::IOLoop::Stream - Non-blocking I/O stream
use Mojo::IOLoop::Stream; # Create stream my $stream = Mojo::IOLoop::Stream->new($handle); $stream->on(read => sub { my ($stream, $bytes) = @_; ... }); $stream->on(close => sub { my $stream = shift; ... }); $stream->on(error => sub { my ($stream, $err) = @_; ... }); # Start and stop watching for new data $stream->start; $stream->stop; # Start reactor if necessary $stream->reactor->start unless $stream->reactor->is_running;
Mojo::IOLoop::Stream is a container for I/O streams used by Mojo::IOLoop.
Mojo::IOLoop::Stream inherits all events from Mojo::EventEmitter and can emit the following new ones.
$stream->on(close => sub { my $stream = shift; ... });
Emitted safely if the stream gets closed.
$stream->on(drain => sub { my $stream = shift; ... });
Emitted safely once all data has been written.
$stream->on(error => sub { my ($stream, $err) = @_; ... });
Emitted safely if an error occurs on the stream.
$stream->on(read => sub { my ($stream, $bytes) = @_; ... });
Emitted safely if new data arrives on the stream.
$stream->on(timeout => sub { my $stream = shift; ... });
Emitted safely if the stream has been inactive for too long and will get closed automatically.
$stream->on(write => sub { my ($stream, $bytes) = @_; ... });
Emitted safely if new data has been written to the stream.
Mojo::IOLoop::Stream implements the following attributes.
my $reactor = $stream->reactor; $stream = $stream->reactor(Mojo::Reactor::Poll->new);
Low level event reactor, defaults to the reactor attribute value of the global Mojo::IOLoop singleton.
reactor
Mojo::IOLoop::Stream inherits all methods from Mojo::EventEmitter and implements the following new ones.
my $stream = Mojo::IOLoop::Stream->new($handle);
Construct a new Mojo::IOLoop::Stream object.
$stream->close;
Close stream immediately.
$stream->close_gracefully;
Close stream gracefully.
my $handle = $stream->handle;
Get handle for stream.
my $success = $stream->is_readable;
Quick non-blocking check if stream is readable, useful for identifying tainted sockets.
my $success = $stream->is_writing;
Check if stream is writing.
$stream->start;
Start watching for new data on the stream.
$stream->stop;
Stop watching for new data on the stream.
my $handle = $stream->steal_handle;
Steal handle from stream and prevent it from getting closed automatically.
my $timeout = $stream->timeout; $stream = $stream->timeout(45);
Maximum amount of time in seconds stream can be inactive before getting closed automatically, defaults to 15. Setting the value to 0 will allow this stream to be inactive indefinitely.
15
0
$stream = $stream->write($bytes); $stream = $stream->write($bytes => 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.