GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Mojo::IOLoop::Stream(3) User Contributed Perl Documentation Mojo::IOLoop::Stream(3)
 

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 if the stream gets closed.

  $stream->on(drain => sub {
    my $stream = shift;
    ...
  });
Emitted once all data has been written.

  $stream->on(error => sub {
    my ($stream, $err) = @_;
    ...
  });
Emitted if an error occurs on the stream, fatal if unhandled.

  $stream->on(read => sub {
    my ($stream, $bytes) = @_;
    ...
  });
Emitted if new data arrives on the stream.

  $stream->on(timeout => sub {
    my $stream = shift;
    ...
  });
Emitted if the stream has been inactive for too long and will get closed automatically.

  $stream->on(write => sub {
    my ($stream, $bytes) = @_;
    ...
  });
Emitted 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. Note that this attribute is weakened.

Mojo::IOLoop::Stream inherits all methods from Mojo::EventEmitter and implements the following new ones.

  my $num = $stream->bytes_read;
Number of bytes received.

  my $num = $stream->bytes_written;
Number of bytes written.

  $stream->close;
Close stream immediately.

  $stream->close_gracefully;
Close stream gracefully.

  my $handle = $stream->handle;
Get handle for stream, usually an IO::Socket::IP or IO::Socket::SSL object.

  my $bool = $stream->is_readable;
Quick non-blocking check if stream is readable, useful for identifying tainted sockets.

  my $bool = $stream->is_writing;
Check if stream is writing.

  my $stream = Mojo::IOLoop::Stream->new($handle);
Construct a new Mojo::IOLoop::Stream object.

  $stream->start;
Start or resume watching for new data on the stream.

  my $handle = $stream->steal_handle;
Steal "handle" and prevent it from getting closed automatically.

  $stream->stop;
Stop watching for new data on the stream.

  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.

  $stream = $stream->write($bytes);
  $stream = $stream->write($bytes => sub {...});
Write data to stream, the optional drain callback will be executed once all data has been written.

Mojolicious, Mojolicious::Guides, <https://mojolicious.org>.
2018-11-28 perl v5.28.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.