lights FAQ Forum github.com/luapower/http
This package
http
client
server

Networking
sock
libtls
libtls_bearssl
bearssl
resolver
http
uri
rsync

http_client

Async http(s) downloader


local client = require'http_client'

HTTP 1.1 coroutine-based async client in Lua.

Features https, gzip compression, persistent connections, pipelining, multiple client IPs, resource limits, auto-redirects, auto-retries, cookie jars, multi-level debugging, caching, cdata-buffer-based I/O. In short, your dream library for web scraping.

Status

Alpha

Configuration

API

client:new(opt) -> client create a client object
client:request(opt) -> req, res make a HTTP request
client:close_all() close all connections

client:new(opt) -> client

Create a client object. The opt table can contain:

libs required: 'sock sock_libtls zlib'
max_conn limit the number of total connections
max_conn_per_target limit the number of connections per target
max_pipelined_requests limit the number of pipelined requests
client_ips a list of client IPs to assign to requests
max_retries number of retries before giving up
max_redirects number of redirects before giving up
debug true to enable client-level debugging
tls_options options for libtls

Note: A target is a combination of (vhost, port, client_ip) on which one or more HTTP connections can be created subject to per-target limits.

Pipelined requests

A pipelined request is a request that is sent in advance of receiving the response for the previous request. Most HTTP servers accept these but in a limited number.

Spawning a new connection for a new request has a lot more initial latency than pipelining the request on an existing connection. On the other hand, pipelined responses come serialized and also the server might decide not to start processing pipelined requests as soon as they arrive because it would have to buffer the results before it can start sending them.

client:request(opt) -> req, res

Make a HTTP request. This must be called from a scheduled socket thread.

The opt table can contain:

connection options options to pass to http:new()
request options options to pass to http:make_request()
client_ip client ip to bind to (optional)
connect_timeout connect timeout (optional)
request_timeout timeout for the request part (optional)
reply_timeout timeout for the reply part (optional)

client:close_all()

Close all connections. This must be called after the socket loop finishes.


Last updated: 4 months ago | Edit on GitHub

Package:http
Pkg type:Lua+ffi
Version: a63baca
Last commit:
Author: Cosmin Apreutesei
License: Public Domain

Requires: glue  libb64  lpeg  luajit  socket  socketloop  time  uri 

Required by: none


Top