Software /
code /
prosody
Changeset
9846:9a0da809ed4a
doc/net.server: Document the new server.listen() API
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sun, 10 Mar 2019 18:05:08 +0100 (2019-03-10) |
parents | 9845:774b2ce62318 |
children | 9847:adc0672b700e |
files | doc/net.server.lua |
diffstat | 1 files changed, 21 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/net.server.lua Mon Mar 04 13:46:09 2019 +0100 +++ b/doc/net.server.lua Sun Mar 10 18:05:08 2019 +0100 @@ -160,6 +160,26 @@ local function addserver(address, port, listeners, pattern, sslctx) end +--[[ Binds and listens on the given address and port +Mostly the same as addserver but with all optional arguments in a table + +Arguments: + - address: address to bind to, may be "*" to bind all addresses. will be resolved if it is a string. + - port: port to bind (as number) + - listeners: a table of listeners + - config: table of extra settings + - read_size: the amount of bytes to read or a read pattern + - tls_ctx: is a valid luasec constructor + - tls_direct: boolean true for direct TLS, false (or nil) for starttls + +Returns: + - handle + - nil, "an error message": on failure (e.g. out of file descriptors) +]] +local function listen(address, port, listeners, config) +end + + --[[ Wraps a lua-socket socket client socket in a handle. The socket must be already connected to the remote end. If `sslctx` is given, a SSL session will be negotiated before listeners are called. @@ -255,4 +275,5 @@ closeall = closeall; hook_signal = hook_signal; watchfd = watchfd; + listen = listen; }