The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

UniEvent::HTTP::Client - HTTP client connection

SYNOPSIS

    my $client = UE::HTTP::Client->new();

    $client->request({
        uri => "http://example.com",
        timeout => 3,
        response_callback => sub {
            my ($request, $response, $error) = @_;
            ...
        },
    });

    UE::Loop->default->run;

DESCRIPTION

UniEvent::HTTP::Client represents single http client connection and it is the lowest-level API in UniEvent::HTTP. For high-level API see UniEvent::HTTP::UserAgent.

Client can make many http requests but only one at a time (client doesn't support http pipelining for now). When client makes an http request and request is keep-alive, it doesn't close the connection when request is done. It will keep the connection alive, and if next http request targets the same destination with the same ssl and proxy settings, it will reuse that connection. If next http request targets another destination, connections will be closed and new connection will be established.

Client object will not die until active request is finished, even if it goes out of the scope.

Client inherits UniEvent::Tcp handle.

METHODS

All methods of UniEvent::Tcp also apply. Keep in mind that if you intervene in network I/O via UniEvent::Tcp methods (like manually calling connect(), disconnect(), etc...) you may break Client's behaviour.

new([$loop = default])

Creates new client object which will use $loop UniEvent::Loop.

request($request || \%request_params)

Executes an http request. Argument can be a UniEvent::HTTP::Request object or params to its constructor.

cancel([$error = UniEvent::SystemError::operation_canceled])

Cancels current http request execution (if any). Callbacks will be called with $error error (UniEvent::SystemError::operation_canceled by default). If no request is currently executing, does nothing.

uncompress_response()

A property that controls automatic uncompression of response body. Default is true. If false body remains compressed, usefull for proxy.