If someone wants to maintain / take ownership of this project, reach out to me (issue, email). I like Lua very much, but I don't have enough time / resources to stay engaged with it.
This project provides Lua modules for Websocket Version 13 conformant clients and servers.
The minified version is only ~10k bytes in size.
Clients are available in three different flavours:
Servers are available as two different flavours:
A webserver is NOT part of lua-websockets. If you are looking for a feature rich webserver framework, have a look at orbit or others. It is no problem to work with a "normal" webserver and lua-websockets side by side (two processes, different ports), since websockets are not subject of the 'Same origin policy'.
This implements a basic echo server via Websockets protocol. Once you are connected with the server, all messages you send will be returned ('echoed') by the server immediately.
localcopas=require'copas'-- create a copas webserver and start listeninglocalserver=require'websocket'.server.copas.listen
{
-- listen on port 8080port=8080,
-- the protocols field holds-- key: protocol name-- value: callback on new connectionprotocols= {
-- this callback is called, whenever a new client connects.-- ws is a new websocket instanceecho=function(ws)
whiletruedolocalmessage=ws:receive()
ifmessagethenws:send(message)
elsews:close()
returnendendend
}
}
-- use the copas loopcopas.loop()This implements a basic echo server via Websockets protocol. Once you are connected with the server, all messages you send will be returned ('echoed') by the server immediately.
localev=require'ev'-- create a copas webserver and start listeninglocalserver=require'websocket'.server.ev.listen
{
-- listen on port 8080port=8080,
-- the protocols field holds-- key: protocol name-- value: callback on new connectionprotocols= {
-- this callback is called, whenever a new client connects.-- ws is a new websocket instanceecho=function(ws)
ws:on_message(function(ws,message)
ws:send(message)
end)
-- this is optionalws:on_close(function()
ws:close()
end)
end
}
}
-- use the lua-ev loopev.Loop.default:loop()
The folder test-server contains two re-implementations of the libwebsocket test-server.c example.
cd test-server
lua test-server-ev.luacd test-server
lua test-server-copas.luaConnect to the from Javascript (e.g. chrome's debugging console) like this:
varechoWs=newWebSocket('ws://127.0.0.1:8002','echo');The client and server modules depend on:
- luasocket
- luabitop (if not using Lua 5.2 nor luajit)
- luasec
- copas (optionally)
- lua-ev (optionally)
$ git clone git://github.com/lipp/lua-websockets.git
$ cd lua-websockets
$ luarocks make rockspecs/lua-websockets-scm-1.rockspecA squishy file for squish is
provided. Creating the minified version (~10k) can be created with:
$ squish --gzipThe minifed version has be to be installed manually though.
Running tests requires:
docker build .The first run will take A WHILE.