The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Mojo::IOLoop::Stream::HTTPClient - Non-blocking I/O HTTP client stream

SYNOPSIS

  use Mojo::IOLoop::Client;
  use Mojo::IOLoop::Stream::HTTPClient;
  use Mojo::Transaction::HTTP;
  
  # Create transaction
  my $tx = Mojo::Transaction::HTTP->new;
  $tx->req->method('GET')
  $tx->url->parse('https://mojolicious.org');
  $tx->on(
    finish => sub {
      my $tx = shift;
      say $tx->res->code;
    }
  );
  
  # Create socket connection
  my $client = Mojo::IOLoop::Client->new;
  $client->on(
    connect => sub {
      my $stream = Mojo::IOLoop::Stream::HTTPClient->new(pop);
      $stream->start;
      $stream->process($tx);
    }
  );
  $client->connect(address => 'mojolicious.org', port => 80);

  # Start reactor if necessary
  $stream->reactor->start unless $stream->reactor->is_running;

DESCRIPTION

Mojo::IOLoop::Stream::HTTPClient is a container for I/O streams used by Mojo::IOLoop to support the HTTP protocol client-side.

EVENTS

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

upgrade

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

Emitted when the connection should be upgraded to the WebSocket protocol.

ATTRIBUTES

Mojo::IOLoop::Stream::HTTPClient inherits all attributes from Mojo::IOLoop::Stream and implements the following ones.

request_timeout

  my $timeout = $stream->request_timeout;
  $stream     = $stream->request_timeout(5);

Maximum amount of time in seconds sending the request and receiving a whole response may take before getting canceled, defaults to 0. Setting the value to 0 will allow to wait indefinitely.

METHODS

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

new

  my $stream = Mojo::IOLoop::Stream::HTTPClient->new($handle);

Construct a new Mojo::IOLoop::Stream::HTTPClient object.

process

  $stream->process(Mojo::Transaction::HTTP->new);

Process a Mojo::Transaction::HTTP object with the current connection.

DEBUGGING

You can set the MOJO_CLIENT_DEBUG environment variable to get some advanced diagnostics information printed to STDERR.

  MOJO_CLIENT_DEBUG=1

SEE ALSO

Mojolicious, Mojolicious::Guides, http://mojolicious.org.