aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKim Alvefur <zash@zash.se>2019-03-10 18:05:08 +0100
committerKim Alvefur <zash@zash.se>2019-03-10 18:05:08 +0100
commit99e25a9093b7a1cc66b7784e3b805b60f092f9da (patch)
tree790650ca771e44b7a09f6eb0cdf28f710a9b8c56
parent2326bed3c7b2386aa1706ad0e760827ef2e165ce (diff)
downloadprosody-99e25a9093b7a1cc66b7784e3b805b60f092f9da.tar.gz
prosody-99e25a9093b7a1cc66b7784e3b805b60f092f9da.zip
doc/net.server: Document the new server.listen() API
-rw-r--r--doc/net.server.lua21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/net.server.lua b/doc/net.server.lua
index 7342c549..aa9a4a9d 100644
--- a/doc/net.server.lua
+++ b/doc/net.server.lua
@@ -160,6 +160,26 @@ Returns:
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 @@ return {
closeall = closeall;
hook_signal = hook_signal;
watchfd = watchfd;
+ listen = listen;
}