NAME HTTP::Promise - Asynchronous HTTP Request and Promise SYNOPSIS use HTTP::Promise; my $p = HTTP::Promise->new( agent => 'MyBot/1.0' accept_encoding => 'auto', # set to 'none' to disable receiving compressed data accept_language => [qw( fr-FR fr en-GB en ja-JP )], auto_switch_https => 1, # For example, a Cookie::Jar object cookie_jar => $cookie_jar, dnt => 1, # 2Mb. Any data to be sent being bigger than this will trigger a Continue conditional query expect_threshold => 2048000, # Have the file extension reflect the encoding, if any ext_vary => 1, # 100Kb. Anything bigger than this will be automatically saved on file rather than memory max_body_in_memory_size => 102400, # 8Kb max_headers_size => 8192, max_redirect => 3, # For Promise::Me medium => 'mmap', proxy => 'https://proxy.example.org:8080', # The serialiser to use for the promise in Promise::Me # Defaults to storable, but can also be cbor and sereal serialiser => 'sereal', shared_mem_size => 1048576, # You can also use decimals with Time::HiRes timeout => 15, # force the use of files to store the response content use_content_file => 1, # Should we use promise? # use_promise => 0, ); my $prom = $p->get( 'https://www.example.org', $hash_of_query_params )->then(sub { # Nota bene: the last value in this sub will be passed as the argument to the next 'then' my $resp = shift( @_ ); # get the HTTP::Promise::Response object })->catch(sub { my $ex = shift( @_ ); # get a HTTP::Promise::Exception object say "Exception code is: ", $ex->code; }); # or using hash reference of options to prepare the request my $req = HTTP::Promise::Request->new( get => 'https://www.example.org' ) || die( HTTP::Promise::Request->error ); my $prom = $p->request( $req )->then(sub{ #... })->catch(sub{ # ... }); VERSION v0.2.5 DESCRIPTION HTTP::Promise provides with a fast and powerful yet memory-friendly API to make true asynchronous HTTP requests using fork with Promise::Me. It is based on the design of HTTP::Message, but with a much cleaner interface to make requests and manage HTTP entity bodies. Here are the key features: * Support for HTTP/1.0 and HTTP/1.1 * Handles gracefully very large files by reading and sending them in chunks. * Supports "Continue" conditional requests * Support redirects * Reads data in chunks of bytes and not line by line. * Easy-to-use interface to encode and decode with HTTP::Promise::Stream * Multi-lingual and complete HTTP Status codes with HTTP::Promise::Status * MIME guessing module with HTTP::Promise::MIME * Powerful HTTP parser with HTTP::Promise::Parser supporting complex "multipart" HTTP messages. * Has thorough documentation Here is how it is organised in overall: +-------------------------+ +--------------------------+ | | | | | HTTP::Promise::Request | | HTTP::Promise::Response | | | | | +------------|------------+ +-------------|------------+ | | | | | | | +------------------------+ | | | | | +--- HTTP::Promise::Message |---+ | | +------------|-----------+ | | +------------|-----------+ | | | HTTP::Promise::Entity | | | +------------|-----------+ | | +------------|-----------+ | | | HTTP::Promise::Body | | | +------------------------+ It differentiates from other modules by using several XS modules for speed, and has a notion of HTTP entity and body stored either on file or in memory. It also has modules to make it really super easy to create "x-www-form-urlencoded" requests with HTTP::Promise::Body::Form, or "multipart" ones with HTTP::Promise::Body::Form::Data Thus, you can either have a fine granularity by creating your own request using HTTP::Promise::Request, or you can use the high level methods provided by HTTP::Promise, which are: "delete", "get", "head", "options", "patch", "post", "put" and each will occur asynchronously. Each of those methods returns a promise, which means you can chain the results using a chainable then and catch for errors. You can also wait for all of them to finish using await, which is exported by default by HTTP::Promise and all or race. my @results = await( $p1, $p2 ); my @results = HTTP::Promise->all( $p1, $p2 ); # First promise that is resolved or rejected makes this super promise resolved and # return the result my @results = HTTP::Promise->race( $p1, $p2 ); You can also share variables using "share", such as: my $data : shared = {}; # or my( $name, @first_names, %preferences ); share( $name, @first_names, %preferences ); See Promise::Me for more information. It calls resolve when the request has been completed and sends a HTTP::Promise::Response object whose API is similar to that of HTTP::Response. When an error occurs, it is caught and sent by calling "reject" in Promise::Me with an HTTP::Promise::Exception object. Cookies are automatically and transparently managed with Cookie::Jar which can load and store cookies to a json file you specify. You can create a cookie object and pass it to the constructor with the "cookie_jar" option. CONSTRUCTOR new Provided with some optional parameters, and this instantiates a new HTTP::Promise objects and returns it. If an error occurred, it will return "undef" and the error can be retrieved using error method. It accepts the following parameters. Each of those options have a corresponding method, so you can get or change its value later: * "accept_encoding" String. This sets whether we should accept compressed data. You can set it to "none" to disable it. By default, this is "auto", and it will set the "Accept-Encoding" "HTTP" header to all the supported encoding based on the availability of associated modules. You can also set this to a comma-separated list of known encoding, typically: "bzip2,deflate,gzip,rawdeflate,brotli" See HTTP::Promise::Stream for more details. * "agent" String. Set the user agent, i.e. the way this interface identifies itself when communicating with an HTTP server. By default, it uses something like "HTTP-Promise/v0.1.0" * "cookie_jar" Object. Set the class handling the cookie jar. By default it uses Cookie::Jar * "default_headers" HTTP::Promise::Headers, or HTTP::Headers Object. Sets the headers object containing the default headers to use. * "local_address" String. A local IP address or local host name to use when establishing TCP/IP connections. * "local_host" String. Same as "local_address" * "local_port" Integer. A local port to use when establishing TCP/IP connections. * "max_redirect" Integer. This is the maximum number of redirect HTTP::Promise will follow until it gives up. Default value is 7 * "max_size" Integer. Set the size limit for response content. If the response content exceeds the value set here, the request will be aborted and a "Client-Aborted" header will be added to the response object returned. Default value is "undef", i.e. no limit. See also the "threshold" option. * "medium" This can be either "file", "mmap" or "memory". This will be passed on to Promise::Me as "result_shared_mem_size" to store resulting data between processes. See Promise::Me for more details. It defaults to $Promise::Me::SHARE_MEDIUM * "no_proxy" Array reference. Do not proxy requests to the given domains. * "proxy" The url of the proxy to use for the HTTP requests. * "requests_redirectable" Array reference. This sets the list of http methods that are allowed to be redirected. Default to empty, which means that all methods can be redirected. * "serialiser" String. Specify the serialiser to use for Promise::Me. Possible values are: cbor, sereal or storable By default it uses the value set in the global variable $SERIALISER, which is a copy of the $SERIALISER in Promise::Me, which should be by default "storable" * "shared_mem_size" Integer. This will be passed on to Promise::Me. See Promise::Me for more details. It defaults to $Promise::Me::RESULT_MEMORY_SIZE * "ssl_opts" Hash reference. Sets an hash reference of ssl options. The default values are set as follows: 1. "verify_hostname" When enabled, this ensures it connects to servers that have a valid certificate matching the expected hostname. 1.1. If environment variable "PERL_LWP_SSL_VERIFY_HOSTNAME" is set, the ssl option property "verify_hostname" takes its value. 1.2. If environment variable "HTTPS_CA_FILE" or "HTTPS_CA_DIR" are set to a true value, then the ssl option property "verify_hostname" is set to 0 and option property "SSL_verify_mode" is set to 1 1.3 If none of the above applies, it defaults "verify_hostname" to 1 2. "SSL_ca_file" This is the path to a file containing the Certificate Authority certificates. If environment variable "PERL_LWP_SSL_CA_FILE" or "HTTPS_CA_FILE" is set, then the ssl option property "SSL_ca_file" takes its value. 3. "SSL_ca_path" This is the path to a directory of files containing Certificate Authority certificates. If environment variable "PERL_LWP_SSL_CA_PATH" or "HTTPS_CA_DIR" is set, then the ssl option property "SSL_ca_path" takes its value. Other options can be set and are processed directly by the SSL Socket implementation in use. See IO::Socket::SSL or Net::SSL for details. * "threshold" Integer. Sets the content length threshold beyond which, the response content will be stored to a locale file. It can then be fetch with "file". Default to global variable $CONTENT_SIZE_THRESHOLD, which is "undef" by default. See also the "max_size" option. * "timeout" Integer. Sets the timeout value. Defaults to 180 seconds, i.e. 3 minutes. * "use_content_file" Boolean. Enables the use of a temporary local file to store the response content, no matter the size o the response content. * "use_promise" Boolean. When true, this will have HTTP::Promise HTTP methods return a HTTP::Promise, and when false, it returns directly the HTTP::Promise::Response. Defaults to true. METHODS The following methods are available. This interface provides similar interface as LWP::UserAgent while providing more granular control. accept_encoding String. Sets or gets whether we should accept compressed data. You can set it to "none" to disable it. By default, this is "auto", and it will set the "Accept-Encoding" "HTTP" header to all the supported encoding based on the availability of associated modules. You can also set this to a comma-separated list of known encoding, typically: "bzip2,deflate,gzip,rawdeflate,brotli" See HTTP::Promise::Stream for more details. Returns a scalar object of the current value. accept_language An array of acceptable language. This will be used to set the "Accept-Language" header. See also HTTP::Promise::Headers::AcceptLanguage agent This is a string. Sets or gets the agent id used to identify when making the server connection. It defaults to "HTTP-Promise/v0.1.0" my $p = HTTP::Promise->new( agent => 'MyBot/1.0' ); $p->agent( 'Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:99.0) Gecko/20100101 Firefox/99.0' ); The "User-Agent" header field is only set to this provided value if it is not already set. accept_language Sets or gets an array of acceptable response content languages. For example: $http->accept_language( [qw( fr-FR ja-JP en-GB en )] ); Would result into an "Accept-Language" header set to "fr-FR;q=0.9,ja-JP;q=0.8,en-GB;q=0.7,en;q=0.6" The "Accept-Language" header would only be set if it is not set already. auto_switch_https Boolean. If set to a true value, or if left to "undef" (default value), this will set the "Upgrade-Insecure-Requests" header field to 1 buffer_size The size of the buffer to use when reading data from the filehandle or socket. connection_header Sets or gets the value for the header "Connection". It can be "close" or "keep-alive" If it is let "undef", this module will try to guess the proper value based on the "protocol" in HTTP::Promise::Request and "version" in HTTP::Promise::Request used. For protocol "HTTP/1.0", "Connection" value would be "close", but above "HTTP/1.1" the connection can be set to "keep-alive" and thus be re-used. cookie_jar Sets or gets the Cookie jar class object to use. This is typically Cookie::Jar or maybe HTTP::Cookies This defaults to Cookie::Jar use Cookie::Jar; my $jar = Cookie::Jar->new; my $p = HTTP::Promise->new( cookie_jar => $jar ); $p->cookie_jar( $jar ); decodable This calls "decodable" in HTTP::Promise::Stream passing it whatever arguments that were provided. default_header Sets one more default headers. This is a shortcut to "$p->default_headers->header" $p->default_header( $field ); $p->default_header( $field => $value ); $p->default_header( 'Accept-Encoding' => scalar( HTTP::Promise->decodable ) ); $p->default_header( 'Accept-Language' => 'fr, en, ja' ); default_headers Sets or gets the default header object, which is set to "undef" by default. This can be either an HTTP::Promise::Headers or HTTP::Headers object. use HTTP::Promise::Headers; my $headers = HTTP::Promise::Headers->new( 'Accept-Encoding' => scalar( HTTP::Promise->decodable ), 'Accept-Language' => 'fr, en, ja', ); my $p = HTTP::Promise->new( default_headers => $headers ); default_protocol Sets or gets the default protocol to use. For example: "HTTP/1.1" delete Provided with an "uri" and an optional hash of header name/value pairs, and this will issue a "DELETE" http request to the given "uri". It returns a promise, which can be used to call one or more then and catch # or $p->delete( $uri, $field1 => $value1, $field2 => $value2 ) $p->delete( $uri )->then(sub { my( $resolve, $reject ) = @$_; # an HTTP::Promise::Response is returned my $resp = shift( @_ ); # Do something with the $resp object })->catch(sub { my $ex = shift( @_ ); # An HTTP::Promise::Exception object is passed with an error code say( "Error code; ", $ex->code, " and message: ", $ex->message ); }); However, if "use_promise" is set to false, this will return an HTTP::Promise::Response object directly. dnt Boolean. If set to a true value, this will set the "DNT" header to 1 expect_threshold Sets or gets the body size threshold beyond which, this module will issue a conditional "Expect" HTTP header in order to ensure the remote HTTP server is ok. ext_vary Boolean. When this is set to a true value, this will have the files use extensions that reflect not just their content, but also their encoding when applicable. For example, if an HTTP response HTML content is gzip encoded into a file, the file extensions will be "html.gz" Default set to $EXTENSION_VARY, which by default is true. file If a temporary file has been set, the response content file can be retrieved with this method. my $p = HTTP::Promise->new( threshold => 512000 ); # 500kb # If the response payload exceeds 500kb, HTTP::Promise will save the content to a # temporary file # or my $p = HTTP::Promise->new( use_content_file => 1 ); # always use a temporary file # Returns a Module::Generic::File object my $f = $p->file; from Get or set the email address for the human user who controls the requesting user agent. The address should be machine-usable, as defined in RFC2822 . The "from" value is sent as the "From" header in the requests The default value is "undef", so no "From" field is set by default. my $p = HTTP::Promise->new( from => 'john.doe@example.com' ); $p->from( 'john.doe@example.com' ); get Provided with an "uri" and an optional hash of header name/value pairs, and this will issue a "GET" http request to the given "uri". It returns a promise, which can be used to call one or more then and catch # or $p->get( $uri, $field1 => $value1, $field2 => $value2 ) $p->get( $uri )->then(sub { my( $resolve, $reject ) = @$_; # an HTTP::Promise::Response is returned my $resp = shift( @_ ); # Do something with the $resp object })->catch(sub { my $ex = shift( @_ ); # An HTTP::Promise::Exception object is passed with an error code say( "Error code; ", $ex->code, " and message: ", $ex->message ); }); However, if "use_promise" is set to false, this will return an HTTP::Promise::Response object directly. head Provided with an "uri" and an optional hash of header name/value pairs, and this will issue a "HEAD" http request to the given "uri". It returns a promise, which can be used to call one or more then and catch # or $p->head( $uri, $field1 => $value1, $field2 => $value2 ) $p->head( $uri )->then(sub { my( $resolve, $reject ) = @$_; # an HTTP::Promise::Response is returned my $resp = shift( @_ ); # Do something with the $resp object })->catch(sub { my $ex = shift( @_ ); # An HTTP::Promise::Exception object is passed with an error code say( "Error code; ", $ex->code, " and message: ", $ex->message ); }); However, if "use_promise" is set to false, this will return an HTTP::Promise::Response object directly. httpize_datetime Provided with a DateTime or Module::Generic::DateTime object, and this will ensure the "DateTime" object stringifies to a valid HTTP datetime. It returns the "DateTime" object provided upon success, or upon error, sets an error and returns "undef" inactivity_timeout Sets or gets the inactivity timeout in seconds. If timeout is reached, the connection is closed. is_protocol_supported Provided with a protocol, such as "http", or "https", and this returns true if the protocol is supported or false otherwise. This basically returns true if the protocol is either "http" or "https" and false otherwise, because "HTTP::Promise" supports only HTTP protocol. languages This is an alias for "accept_language" local_address Get or set the local interface to bind to for network connections. The interface can be specified as a hostname or an IP address. This value is passed as the "LocalHost" argument to IO::Socket. The default value is "undef". my $p = HTTP::Promise->new( local_address => 'localhost' ); $p->local_address( '127.0.0.1' ); local_host This is the same as "local_address". You can use either interchangeably. local_port Get or set the local port to use to bind to for network connections. This value is passed as the "LocalPort" argument to IO::Socket max_body_in_memory_size Sets or gets the maximum HTTP response body size beyond which the data will automatically be saved in a temporary file. max_headers_size Sets or gets the maximum HTTP response headers size, beyond which an error is triggered. max_redirect An integer. Sets or gets the maximum number of allowed redirection possible. Default is 7. my $p = HTTP::Promise->new( max_redirect => 5 ); $p->max_redirect(12); my $max = $p->max_redirect; max_size Get or set the size limit for response content. The default is "undef", which means that there is no limit. If the returned response content is only partial, because the size limit was exceeded, then a "Client-Aborted" header will be added to the response. The content might end up longer than "max_size" as we abort once appending a chunk of data makes the length exceed the limit. The "Content-Length" header, if present, will indicate the length of the full content and will normally not be the same as "length( $resp->content )" my $p = HTTP::Promise->max_size(512000); # 512kb $p->max_size(512000); my $max = $p->max_size; mirror Provided with an "uri" and a "filepath" and this will issue a conditional request to the remote server to return the remote content if it has been modified since the last modification time of the "filepath". Of course, if that file does not exists, then it is downloaded. If the remote resource has been changed since last time, it is downloaded again and its content stored into the "filepath" Just like other http methods, this returns a promise object. It can then be used to call one or more then and catch $p->mirror( $uri => '/some/where/file.txt' )->then(sub { my( $resolve, $reject ) = @$_; # an HTTP::Promise::Response is returned my $resp = shift( @_ ); # Do something with the $resp object })->catch(sub { my $ex = shift( @_ ); # An HTTP::Promise::Exception object is passed with an error code say( "Error code; ", $ex->code, " and message: ", $ex->message ); }); However, if "use_promise" is set to false, this will return an HTTP::Promise::Response object directly. no_proxy Sets or gets a list of domain names for which the proxy will not apply. By default this is empty. This returns an array object my $p = HTTP::Promise->new( no_proxy => [qw( example.com www2.example.net )] ); $p->no_proxy( [qw( localhost example.net )] ); my $ar = $p->no_proxy; say $ar->length, " proxy exception(s) set."; options Provided with an "uri", and this will issue an "OPTIONS" http request to the given "uri". It returns a promise, which can be used to call one or more then and catch # or $p->head( $uri, $field1 => $value1, $field2 => $value2 ) $p->options( $uri )->then(sub { my( $resolve, $reject ) = @$_; # an HTTP::Promise::Response is returned my $resp = shift( @_ ); # Do something with the $resp object })->catch(sub { my $ex = shift( @_ ); # An HTTP::Promise::Exception object is passed with an error code say( "Error code; ", $ex->code, " and message: ", $ex->message ); }); However, if "use_promise" is set to false, this will return an HTTP::Promise::Response object directly. patch Provided with an "uri" and an optional hash of form data, followed by an hash of header name/value pairs and this will issue a "PATCH" http request to the given "uri". If a special header name "Content" is provided, its value will be used to create the key-value pairs form data. It returns a promise, which can be used to call one or more then and catch # or $p->patch( $uri, \@form, $field1 => $value1, $field2 => $value2 ) # or $p->patch( $uri, \%form, $field1 => $value1, $field2 => $value2 ) # or $p->patch( $uri, $field1 => $value1, $field2 => $value2 ) # or $p->patch( $uri, $field1 => $value1, $field2 => $value2, Content => \@form ) # or $p->patch( $uri, $field1 => $value1, $field2 => $value2, Content => \%form ) $p->patch( $uri )->then(sub { my( $resolve, $reject ) = @$_; # an HTTP::Promise::Response is returned my $resp = shift( @_ ); # Do something with the $resp object })->catch(sub { my $ex = shift( @_ ); # An HTTP::Promise::Exception object is passed with an error code say( "Error code; ", $ex->code, " and message: ", $ex->message ); }); However, if "use_promise" is set to false, this will return an HTTP::Promise::Response object directly. post Provided with an "uri" and an optional hash of form data, followed by an hash of header name/value pairs and this will issue a "POST" http request to the given "uri". If a special header name "Content" is provided, its value will be used to create the key-value pairs form data. THat "Content" value can either be an array reference, or an hash reference of key-value pairs. If if is just a string, it will be used as-is as the request body. How the form data is formatted depends on the "Content-Type" set in the headers passed. If the "Content-Type" header is "form-data" or "multipart/form-data", the form data will be formatted as a "multipart/form-data" post, otherwise they will be formatted as a "application/x-www-form-urlencoded" post. It returns a promise, which can be used to call one or more then and catch # or $p->post( $uri, \@form, $field1 => $value1, $field2 => $value2 ) # or $p->post( $uri, \%form, $field1 => $value1, $field2 => $value2 ) # or $p->post( $uri, $field1 => $value1, $field2 => $value2 ) # or $p->post( $uri, $field1 => $value1, $field2 => $value2, Content => \@form ) # or $p->post( $uri, $field1 => $value1, $field2 => $value2, Content => \%form ) # or $p->post( $uri, $field1 => $value1, $field2 => $value2, Content => $content ) $p->post( $uri )->then(sub { my( $resolve, $reject ) = @$_; # an HTTP::Promise::Response is returned my $resp = shift( @_ ); # Do something with the $resp object })->catch(sub { my $ex = shift( @_ ); # An HTTP::Promise::Exception object is passed with an error code say( "Error code; ", $ex->code, " and message: ", $ex->message ); }); However, if "use_promise" is set to false, this will return an HTTP::Promise::Response object directly. prepare_headers Provided with an HTTP::Promise::Request object, and this will set the following request headers, if they are not set already. You can override this method if you create a module of your own that inherits from HTTP::Promise. It returns the HTTP::Promise::Request received, or upon error, it sets an error and returns "undef" Headers set, if not set already are: * "Accept" This uses the values set with "accept" * "Accept-Language" This uses the values set with "accept_language" or "languages" * "Accept-Encoding" This uses the value returned from "decodable" in HTTP::Promise::Stream to find out the encoding installed and supported on your system. * "DNT" This uses the value set with "dnt" * "Upgrade-Insecure-Requests" This uses the value set with "auto_switch_https" or "upgrade_insecure_requests" * "User-Agent" This uses the value set with "agent" proxy Array reference. This sets the scheme and their proxy or proxies. Default to "undef". For example: my $p = HTTP::Promise->new( proxy => [ [qw( http ftp )] => 'https://proxy.example.com:8001' ] ); my $p = HTTP::Promise->new( proxy => [ http => 'https://proxy.example.com:8001' ] ); my $p = HTTP::Promise->new( proxy => [ ftp => 'http://ftp.example.com:8001/', [qw( http https )] => 'https://proxy.example.com:8001' ] ); my $proxy = $p->proxy( 'https' ); proxy_authorization Sets or gets the proxy authorization string. This is computed automatically when you set a user and a password to the proxy URI by setting the value to "proxy" put Provided with an "uri" and an optional hash of form data, followed by an hash of header name/value pairs and this will issue a "PUT" http request to the given "uri". If a special header name "Content" is provided, its value will be used to create the key-value pairs form data. THat "Content" value can either be an array reference, or an hash reference of key-value pairs. If if is just a string, it will be used as-is as the request body. How the form data is formatted depends on the "Content-Type" set in the headers passed. If the "Content-Type" header is "form-data" or "multipart/form-data", the form data will be formatted as a "multipart/form-data" post, otherwise they will be formatted as a "application/x-www-form-urlencoded" put. It returns a promise, which can be used to call one or more then and catch # or $p->put( $uri, \@form, $field1 => $value1, $field2 => $value2 ) # or $p->put( $uri, \%form, $field1 => $value1, $field2 => $value2 ) # or $p->put( $uri, $field1 => $value1, $field2 => $value2 ) # or $p->put( $uri, $field1 => $value1, $field2 => $value2, Content => \@form ) # or $p->put( $uri, $field1 => $value1, $field2 => $value2, Content => \%form ) # or $p->put( $uri, $field1 => $value1, $field2 => $value2, Content => $content ) $p->put( $uri )->then(sub { my( $resolve, $reject ) = @$_; # an HTTP::Promise::Response is returned my $resp = shift( @_ ); # Do something with the $resp object })->catch(sub { my $ex = shift( @_ ); # An HTTP::Promise::Exception object is passed with an error code say( "Error code; ", $ex->code, " and message: ", $ex->message ); }); However, if "use_promise" is set to false, this will return an HTTP::Promise::Response object directly. request This method will issue the propre request in accordance with the request object provided. It will process redirects and authentication responses transparently. This means it may end up sending multiple request, up to the limit set with the object option "max_redirect" This method takes the following parameters: 1. a request object, which is typically HTTP::Promise::Request, or HTTP::Request, but any class that implements a similar interface is acceptable 2. an optional hash or hash reference of parameters: "read_size" Integer. If provided, this will instruct to read the response by that much bytes at a time. "use_content_file" Boolean. If true, this will instruct the use of a temporary file to store the response content. That file may then be retrieved with the method "file". You can also control the use of a temporary file to store the response content with the "threshold" object option. It returns a promise object just like other methods. For example: use HTTP::Promise::Request; my $req = HTTP::Promise::Request->new( get => 'https://example.com' ); my $p = HTTP::Promise->new; my $prom = $p->request( $req )->then(sub { my( $resolve, $reject ) = @$_; # Get the HTTP::Promise::Response object my $resp = shift( @_ ); # Do something with the response object })->catch(sub { # Get a HTTP::Promise::Exception object my $ex = shift( @_ ); say "Got an error code ", $ex->code, " with message: ", $ex->message; }); However, if "use_promise" is set to false, this will return an HTTP::Promise::Response object directly. requests_redirectable Array reference. Sets or gets the list of http method that are allowed to be redirected. By default this is an empty list, i.e. all http methods are allowed to be redirected. Defaults to "GET" and "HEAD" as per rfc 2616 This returns an array object my $p = HTTP::Promise->new( requests_redirectable => [qw( HEAD GET POST )] ); $p->requests_redirectable( [qw( HEAD GET POST )] ); my $ok_redir = $p->requests_redirectable; # Add put $ok_redir->push( 'PUT' ); # Remove POST we just added $ok_redir->remove( 'POST' ); send Provided with an HTTP::Promise::Request, and an optional hash or hash reference of options and this will attempt to connect to the specified uri Supported options: * "expect_threshold" A number specifying the request body size threshold beyond which, this will issue a conditional "Expect" HTTP header. * "total_attempts" Total number of attempts. This is a value that is decreased for each redirected requests it receives until the maximum is reached. The maximum is specified with "max_redirect" After connected to the remote server, it will send the request using "print" in HTTP::Promise::Request, and reads the HTTP response, possibly "chunked". It returns a new HTTP::Promise::Response object, or upon error, this sets an error and returns "undef" send_te Boolean. Enables or disables the "TE" http header. Defaults to true. If true, the "TE" will be added to the outgoing http request. my $p = HTTP::Promise->new( send_te => 1 ); $p->send_te(1); my $bool = $p->send_te; serialiser String. Sets or gets the serialiser to use for Promise::Me. Possible values are: cbor, sereal or storable By default, the value is set to the global variable $SERIALISER, which is a copy of the $SERIALISER in Promise::Me, which should be by default "storable" simple_request This method takes the same parameters as "request" and differs in that it will not try to handle redirects or authentication. It returns a promise object just like other methods. For example: use HTTP::Promise::Request; my $req = HTTP::Promise::Request->new( get => 'https://example.com' ); my $p = HTTP::Promise->new; my $prom = $p->simple_request( $req )->then(sub { my( $resolve, $reject ) = @$_; # Get the HTTP::Promise::Response object my $resp = shift( @_ ); # Do something with the response object })->catch(sub { # Get a HTTP::Promise::Exception object my $ex = shift( @_ ); say "Got an error code ", $ex->code, " with message: ", $ex->message; }); However, if "use_promise" is set to false, this will return an HTTP::Promise::Response object directly. ssl_opts Hash reference object. Sets or gets the ssl options properties used when making requests over ssl. The default values are set as follows: 1. "verify_hostname" When enabled, this ensures it connects to servers that have a valid certificate matching the expected hostname. 1.1. If environment variable "PERL_LWP_SSL_VERIFY_HOSTNAME" is set, the ssl option property "verify_hostname" takes its value. 1.2. If environment variable "HTTPS_CA_FILE" or "HTTPS_CA_DIR" are set to a true value, then the ssl option property "verify_hostname" is set to 0 and option property "SSL_verify_mode" is set to 1 1.3 If none of the above applies, it defaults "verify_hostname" to 1 2. "SSL_ca_file" This is the path to a file containing the Certificate Authority certificates. If environment variable "PERL_LWP_SSL_CA_FILE" or "HTTPS_CA_FILE" is set, then the ssl option property "SSL_ca_file" takes its value. 3. "SSL_ca_path" This is the path to a directory of files containing Certificate Authority certificates. If environment variable "PERL_LWP_SSL_CA_PATH" or "HTTPS_CA_DIR" is set, then the ssl option property "SSL_ca_path" takes its value. Other options can be set and are processed directly by the SSL Socket implementation in use. See IO::Socket::SSL or Net::SSL for details. stop_if Sets or gets a callback code reference (reference to a perl subroutine or an anonymous subroutine) that will be used to determine if we should keep trying upon reading data from the filehandle and an "EINTR" error occurs. If the callback returns true, further attempts will stop and return an error. The default is to continue trying. threshold Integer. Sets the content length threshold beyond which, the response content will be stored to a locale file. It can then be fetch with "file". Default to global variable $CONTENT_SIZE_THRESHOLD, which is "undef" by default. See also the "max_size" option. my $p = HTTP::Promise->new( threshold => 512000 ); $p->threshold(512000); my $limit = $p->threshold; timeout Integer. Sets the timeout value. Defaults to 180 seconds, i.e. 3 minutes. The request is aborted if no activity on the connection to the server is observed for "timeout" seconds. When a request times out, a response object is still returned. The response object will have a standard http status code of 500, i.e. server error. This response will have the "Client-Warning" header set to the value of "Internal response". Returns a number object my $p = HTTP::Promise->new( timeout => 10 ); $p->timeout(10); my $timeout = $p->timeout; upgrade_insecure_requests This is an alias for "auto_switch_https" uri_escape URI-escape the given string using "uri_escape" in URI::Escape::XS uri_unescape URI-unescape the given string using "uri_unescape" in URI::Escape::XS use_content_file Boolean. Enables or disables the use of a temporary file to store the response content. Defaults to false. When true, the response content will be stored into a temporary file, whose object is a Module::Generic::File object and can be retrieved with "file". use_promise Boolean. When true, this will have HTTP::Promise HTTP methods return a HTTP::Promise, and when false, it returns directly the HTTP::Promise::Response. Defaults to true. CLASS FUNCTIONS fetch This method can be exported, such as: use HTTP::Promise qw( fetch ); my $prom = fetch( 'http://example.com/something.json' ); # or fetch( 'http://example.com/something.json' )->then(sub { my( $resolve, $reject ) = @$_; my $resp = shift( @_ ); my $data = $resp->decoded_content; })->then(sub { my $json = shift( @_ ); print( STDOUT "JSON data:\n$json\n" ); }); You can also call it with an object, such as: my $http = HTTP::Promise->new; my $prom = $http->fetch( 'http://example.com/something.json' ); "fetch" performs the same way as "get", by default, and accepts the same possible parameters. It sets an error and returns "undef" upon error, or return a promise However, if "use_promise" is set to false, this will return an HTTP::Promise::Response object directly. You can, however, specify, another method by providing the "method" option with value being an HTTP method, i.e. "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT". See also Mozilla documentation on fetch AUTHOR Jacques Deguest CREDITS This module is inspired by the design and workflow of Gisle Aas and his implementation of HTTP::Message, but built completely differently. HTTP::Promise::Entity and HTTP::Promise::Body have been inspired by Erik Dorfman (a.k.a. Eryq) and Dianne Skoll's implementation of MIME::Entity BUGS You can report bugs at SEE ALSO HTTP::Promise, HTTP::Promise::Request, HTTP::Promise::Response, HTTP::Promise::Message, HTTP::Promise::Entity, HTTP::Promise::Headers, HTTP::Promise::Body, HTTP::Promise::Body::Form, HTTP::Promise::Body::Form::Data, HTTP::Promise::Body::Form::Field, HTTP::Promise::Status, HTTP::Promise::MIME, HTTP::Promise::Parser, HTTP::Promise::IO, HTTP::Promise::Stream, HTTP::Promise::Exception Promise::Me, Cookie::Jar, Module::Generic::File, Module::Generic::Scalar, Module::Generic HTTP::XSHeaders, File::MMagic::XS, CryptX, HTTP::Parser2::XS, URI::Encode::XS, URI::Escape::XS, URL::Encode::XS IO::Compress::Bzip2, IO::Compress::Deflate, IO::Compress::Gzip, IO::Compress::Lzf, IO::Compress::Lzip, IO::Compress::Lzma, IO::Compress::Lzop, IO::Compress::RawDeflate, IO::Compress::Xz, IO::Compress::Zip, IO::Compress::Zstd rfc6266 on Content-Disposition , rfc7230 on Message Syntax and Routing , rfc7231 on Semantics and Content , rfc7232 on Conditional Requests , rfc7233 on Range Requests , rfc7234 on Caching , rfc7235 on Authentication , rfc7578 on multipart/form-data , rfc7540 on HTTP/2.0 COPYRIGHT & LICENSE Copyright (c) 2021 DEGUEST Pte. Ltd. You can use, copy, modify and redistribute this package and associated files under the same terms as Perl itself.