lights FAQ Forum github.com/luapower/socket2
This package
socket2

Misc
csv
daemon
dollar
font_db
fonts-amiri
fonts-awesome
fonts-dejavuserif
fonts-fireflysung
fonts-fixedsys
fonts-ionicons
fonts-material-icons
fonts-noto-emoji
fonts-open-sans
http
lx
minizip2
resty-core
resty-lrucache
resty.http
resty.mail
resty.string
socket2
website
x-widgets
xlsxwriter

socket2

Portable socket API with IOCP, epoll and kqueue for LuaJIT


local socket = require'socket2'

Portable coroutine-based async socket API. For scheduling it uses IOCP on Windows, epoll on Linux and kqueue on OSX.

Status

Work in progress

The plan here is to create a new ffi-based networking stack for LuaJIT based on socket2, coro, [http] and a TLS module binding to openssl that will replace socket, luasec, socketloop, nginx, libcurl.

API

address lookup
socket.addr(...) -> ai look-up a hostname
ai:free() free the address list
ai:next() -> ai|nil get next address in list
ai:addrs() -> iter() -> ai iterate addresses
ai:type() -> s socket type: ‘tcp’, …
ai:family() -> s address family: ‘inet’, …
ai:protocol() -> s protocol: ‘tcp’, ‘icmp’, …
ai:name() -> s cannonical name
ai:tostring() -> s formatted address
sockets
socket.tcp([family][, protocol]) -> tcp make a TCP socket
socket.udp([family][, protocol]) -> udp make a UDP socket
socket.raw([family][, protocol]) -> raw make a RAW socket
s:type() -> s socket type
s:family() -> s address family
s:protocol() -> s protocol
s:close() close connection and free socket
s:bind(addr | host,port) bind socket to IP/port
TCP sockets
tcp:listen(host, port, [backlog]) put socket in listening mode
tcp:connect(addr | host,port) connect
tcp:send(buf, maxlen) -> len send bytes
tcp:recv(buf, maxlen) -> len receive bytes
UDP sockets
udp:send(buf, maxlen, addr | host,port) -> len send a datagram to an address
udp:recv(buf, maxlen, addr | host,port) -> len receive a datagram from an adress
scheduling
socket.newthread(func) -> co create a coroutine for async I/O
socket.poll(timeout) -> true | false,'timeout' poll for I/O
socket.start(timeout) keep polling until timeout
socket.stop() stop polling
multi-threading
socket.iocp([iocp_h]) -> iocp_h get/set IOCP handle (Windows)
socket.epoll_fd([epfd]) -> epfd get/set epoll fd (Linux)

All function return nil, err, errcode on error.

I/O functions only work inside threads created with socket.newthread().

Address lookup

socket.addr(...) -> ai

The args can be either an existing ai object which is passed through, or:

  • [host], [port], socket_type, [family], [protocol], [flags]

where

  • host can be a hostname, ip address, '*' (the default) which means '0.0.0.0' aka “all interfaces” or false which means '127.0.0.1'.
  • port can be a port number or a service name and defaults to 0 which means “any available port”.
  • socket_type must be 'tcp', 'udp' or 'raw'.
  • family can be 'inet', 'inet6' or 'unix' (defaults to 'inet').
  • protocol can be 'ip', 'ipv6', 'tcp', 'udp', 'raw', 'icmp', 'igmp' or 'icmpv6' (default is based on socket type).
  • flags are a glue.bor() list of passive, cannonname, numerichost, numericserv, all, v4mapped, addrconfig which map to getaddrinfo() flags.

Sockets

socket.tcp([family][, protocol]) -> tcp

Make a TCP socket.

socket.udp([family][, protocol]) -> udp

Make an UDP socket.

socket.raw([family][, protocol]) -> raw

Make a RAW socket.

s:close()

Close the connection and free the socket.

s:bind(addr | [host],[port])

Bind socket to an interface/port.

TCP sockets

tcp:listen([backlog, ]addr | [host],[port])

Put the socket in listening mode, binding the socket if not bound already (in which case host and port args are ignored). The backlog defaults to 1/0 which means “use the maximum allowed”.

tcp:connect(addr | host,port)

Connect to an address, binding the socket to '*' if not bound already.

tcp:send(buf, maxlen) -> len

Send bytes.

tcp:recv(buf, maxlen) -> len

Receive bytes.

UDP sockets

udp:send(buf, maxlen, addr | host,port) -> len

Send a datagram.

udp:recv(buf, maxlen, addr | host,port) -> len

Receive a datagram.

Scheduling

Scheduling is based on synchronous coroutines provided by coro which allows coroutine-based iterators that perform socket I/O to be written.

socket.newthread(func) -> co

Create a coroutine for performing async I/O. The coroutine starts immediately and transfers control back to the parent thread inside the first async I/O operation. When the coroutine finishes, the control is transfered to the loop thread.

Full-duplex I/O on a socket can be achieved by performing reads in one thread and all writes in another.

socket.poll(timeout) -> true | false,'timeout'

Poll for the next I/O event and resume the coroutine that waits for it.

Timeout is in seconds with anything beyond 2^31-1 taken as infinte and defaults to infinite.

socket.start(timeout)

Start polling. Stops after the timeout expires and there’s no more I/O or stop() was called.

socket.stop()

Tell the loop to stop dequeuing and return.

Multi-threading

socket.iocp([iocp_handle]) -> iocp_handle

Get/set the global IOCP handle (Windows).

IOCPs can be shared between OS threads and having a single IOCP for all threads (as opposed to having one IOCP per thread/Lua state) enables the kernel to better distribute the completion events between threads.

To share the IOCP with another Lua state running on a different thread, get the IOCP handle with socket.iocp(), copy it over to the other state, then set it with socket.iocp(copied_iocp).

socket.epoll_fd([epfd]) -> epfd

Get/set the global epoll fd (Linux).

Epoll fds can be shared between OS threads and having a single epfd for all threads is more efficient for the kernel than having one epfd per thread.

To share the epfd with another Lua state running on a different thread, get the epfd with socket.epoll_fd(), copy it over to the other state, then set it with socket.epoll_fd(copied_epfd).


Last updated: 4 months ago | Edit on GitHub

Package:socket2
Pkg type:Lua
Version: c2429df
Last commit:
Author: Cosmin Apreutesei
License: Public Domain

Requires: none

Required by: none


Top