/ 
Mojolicious-4.11
River stage four • 1014 direct dependents • 1136 total dependents
/ Mojo::IOLoop::Stream

NAME

Mojo::IOLoop::Stream - Non-blocking I/O stream

SYNOPSIS


            

              
              
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;

DESCRIPTION

Mojo::IOLoop::Stream is a container for I/O streams used by Mojo::IOLoop.

EVENTS

Mojo::IOLoop::Stream inherits all events from Mojo::EventEmitter and can emit the following new ones.

close


            

              
              
$stream->on(close => sub {
  my $stream = shift;
  ...
});

Emitted safely if the stream gets closed.

drain


            

              
              
$stream->on(drain => sub {
  my $stream = shift;
  ...
});

Emitted safely once all data has been written.

error


            

              
              
$stream->on(error => sub {
  my ($stream, $err) = @_;
  ...
});

Emitted safely if an error occurs on the stream.

read


            

              
              
$stream->on(read => sub {
  my ($stream, $bytes) = @_;
  ...
});

Emitted safely if new data arrives on the stream.

timeout


            

              
              
$stream->on(timeout => sub {
  my $stream = shift;
  ...
});

Emitted safely if the stream has been inactive for too long and will get closed automatically.

write


            

              
              
$stream->on(write => sub {
  my ($stream, $bytes) = @_;
  ...
});

Emitted safely if new data has been written to the stream.

ATTRIBUTES

Mojo::IOLoop::Stream implements the following attributes.

reactor


            

              
              
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.

METHODS

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.

close


            

              
              
$stream->close;

Close stream immediately.

close_gracefully


            

              
              
$stream->close_gracefully;

Close stream gracefully.

handle


            

              
              
my $handle = $stream->handle;

Get handle for stream.

is_readable


            

              
              
my $success = $stream->is_readable;

Quick non-blocking check if stream is readable, useful for identifying tainted sockets.

is_writing


            

              
              
my $success = $stream->is_writing;

Check if stream is writing.

start


            

              
              
$stream->start;

Start watching for new data on the stream.

stop


            

              
              
$stream->stop;

Stop 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.

timeout


            

              
              
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.

write


            

              
              
$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.

SEE ALSO

Mojolicious, Mojolicious::Guides, http://mojolicio.us.