lua-eco

• Index

Contents

• Functions
• Class client
• Class body_form

Modules

• eco
• eco.time
• eco.log
• eco.file
• eco.sys
• eco.sync
• eco.channel
• eco.shared
• eco.uci
• eco.ubus
• eco.socket
• eco.packet
• eco.dns
• eco.ssl
• eco.mqtt
• eco.net
• eco.nl
• eco.genl
• eco.rtnl
• eco.ip
• eco.nl80211
• eco.websocket
• eco.termios
• eco.ssh
• eco.http.server
• eco.http.client
• eco.encoding.hex
• eco.encoding.base64
• eco.hash.md5
• eco.hash.sha1
• eco.hash.sha256
• eco.hash.hmac

Topics

• README

Examples

• channel.lua
• coroutine.lua
• dns.lua
• base64.lua
• hex.lua
• env.lua
• exec.lua
• shell.lua
• dir.lua
• file.lua
• flock.lua
• inotify.lua
• walk.lua
• hmac.lua
• md5.lua
• sha1.lua
• sha256.lua
• hook.lua
• download_file.lua
• get.lua
• post.lua
• post_file.lua
• post_form.lua
• server.lua
• server_multiprocess.lua
• log.lua
• mqtt.lua
• custom-proto.lua
• genl_get_family.lua
• ip-addr-add.lua
• ip-addr-del.lua
• ip-addr-get.lua
• ip-link.lua
• link_del.lua
• link_dump.lua
• link_event.lua
• nl80211_add_interface.lua
• nl80211_del_interface.lua
• nl80211_dump_interface.lua
• nl80211_dump_station.lua
• nl80211_get_freqlist.lua
• nl80211_get_interface.lua
• nl80211_get_station.lua
• nl80211_scan.lua
• nl80211_set_interface.lua
• route_event.lua
• panic_hook.lua
• send-at-command.lua
• shared.lua
• signal.lua
• ping.lua
• ping6.lua
• recver.lua
• sender.lua
• arp-scan.lua
• arping.lua
• capture.lua
• send_tcp.lua
• send_udp.lua
• socketpair_dgram.lua
• socketpair_fork.lua
• socketpair_stream.lua
• client.lua
• server.lua
• client.lua
• server.lua
• client.lua
• dgram_client.lua
• dgram_server.lua
• server.lua
• spawn.lua
• exec.lua
• scp_recv.lua
• scp_send.lua
• client.lua
• server.lua
• cond.lua
• mutex.lua
• wait_group.lua
• termios.lua
• timer.lua
• signatures.lua
• subscribe.lua
• ubus.lua
• client.lua
• server.lua

Module eco.http.client

HTTP/HTTPS/WebSocket client.

This module provides a simple HTTP/1.1 client with optional TLS support.

Supported URL schemes:

• http, https
• ws, wss (HTTP upgrade handshake only)

For https/wss, this module uses eco.ssl.connect internally and sets opts.server_name to the URL host for SNI.

Functions

new ()	Create a new HTTP client.
request (method, url[, body[, opts]])	Perform an HTTP request.
get (url[, opts])	Convenience wrapper for GET.
post (url[, body[, opts]])	Convenience wrapper for POST.
body_with_file (name)	Use a file as request body.
form ()	Create a multipart form body.

Class client

client:close ()	Close the underlying connection.
client:sock ()	Get the underlying connected socket.
client:request (method, url[, body[, opts]])	Perform a request using this client.

Class body_form

body_form:add (name, value)	Add a simple form field.
body_form:add_file (name, path)	Add a file field.

Functions

new ()

Create a new HTTP client.

Returns:

client

request (method, url[, body[, opts]])

Perform an HTTP request.

This is a convenience wrapper that creates a temporary client, performs the request, and closes the connection.

opts options commonly used:

• timeout (number) request timeout in seconds (default 30).
• headers (table) extra request headers.
• body_to_file (string) write response body to the given file path.
• ipv6 (boolean) resolve AAAA records.
• mark (number) SO_MARK for sockets.
• device (string) SO_BINDTODEVICE for sockets.
• nameservers (table) DNS servers (see eco.dns.query).
• TLS: ca, cert, key, insecure (passed to eco.ssl.connect).

Parameters:

• method string HTTP method, e.g. "GET", "POST".
• url string Request URL.
• body string, body_file or body_form Request body. (optional)
• opts table Options table. (optional)

Returns:

table

resp Response table:

• code (number)
• status (string)
• headers (table)
• body (string) (omitted when body_to_file is used)

Or

1. nil On failure.
2. string Error message.

get (url[, opts])

Convenience wrapper for GET.

Parameters:

• url string
• opts table See request. (optional)

Returns:

table resp

Or

1. nil
2. string Error message.

post (url[, body[, opts]])

Convenience wrapper for POST.

Parameters:

• url string
• body string, body_file or body_form (optional)
• opts table See request. (optional)

Returns:

table resp

Or

1. nil
2. string Error message.

body_with_file (name)

Use a file as request body.

The returned object can be used as the body argument of request.

Parameters:

• name string File path.

Returns:

body_file body

Or

1. nil On failure.
2. string Error message.

form ()

Create a multipart form body.

The returned object can be used as the body argument of request.

Returns:

body_form

Class client

client:close ()

Close the underlying connection.

client:sock ()

Get the underlying connected socket.

Returns:

socket sock

Or

1. nil When not connected.
2. string Error message.

client:request (method, url[, body[, opts]])

Perform a request using this client.

For https/wss, TLS options in opts are passed to eco.ssl.connect.

Parameters:

• method string HTTP method.
• url string Request URL.
• body string, body_file or body_form Request body. (optional)
• opts table See request. (optional)

Returns:

table resp

Or

1. nil On failure.
2. string Error message.

Class body_form

body_form:add (name, value)

Add a simple form field.

Parameters:

• name string Field name.
• value string Field value.

Returns:

boolean true

body_form:add_file (name, path)

Add a file field.

Parameters:

• name string Field name.
• path string File path.

Returns:

boolean true On success.

Or

1. nil On failure.
2. string Error message.