Websocket for Nim
Go to file
andri lim 63bcc2902d
Fix CI badge URL (#162)
2024-04-24 12:14:09 +07:00
.github/workflows test refc in CI in Nim 2.0 and later (#161) 2024-02-22 03:42:37 +00:00
autobahn regenerate ssl certificate and private key for autobahn server (#106) 2022-03-11 14:27:13 -06:00
examples Reduce compiler warnings 2024-01-25 17:44:23 +07:00
tests Reduce compiler warnings 2024-01-25 17:44:23 +07:00
websock Reduce compiler warnings 2024-01-25 17:44:23 +07:00
.editorconfig Implement web socket handshake 2020-12-01 18:13:59 +05:30
.gitattributes add deflate compression test cases 2021-06-20 14:50:54 +07:00
.gitignore Add setup/lock files (#120) 2022-07-12 21:33:50 +03:00
Readme.md Fix CI badge URL (#162) 2024-04-24 12:14:09 +07:00
config.nims Add setup/lock files (#120) 2022-07-12 21:33:50 +03:00
nim.cfg move -d:nimRawSetjmp to nim.cfg (#114) 2022-06-20 09:20:01 +02:00
websock.nimble Reduce compiler warnings when using new chronos (#149) 2024-01-22 19:08:17 +07:00
websock.svg add websock logo to readme.md 2021-06-29 08:50:34 +07:00

Readme.md

Websock Logo

Websocket for Nim

GH Action

This is an implementation of Websocket protocol for Nim and chronos.

nim-websock includes both client and server in regular ws and wss(secure) mode.

It also pass all autobahn tests Autobahn summary report.

Building and testing

Install dependencies:

nimble install -d

Starting HTTP server:

nim c -r examples/server.nim

Testing Server Response:

curl --location --request GET 'http://localhost:8888'

Testing Websocket Handshake:

curl --include \
   --no-buffer \
   --header "Connection: Upgrade" \
   --header "Upgrade: websocket" \
   --header "Host: example.com:80" \
   --header "Origin: http://example.com:80" \
   --header "Sec-WebSocket-Key: SGVsbG8sIHdvcmxkIQ==" \
   --header "Sec-WebSocket-Version: 13" \
   http://localhost:8888/ws

Roadmap

  • Framing
    • Text Messages
    • Binary Messages
  • Pings/Pongs
  • Reserved Bits
  • Opcodes
    • Non-control Opcodes
    • Control Opcodes
  • Fragmentation
  • UTF-8 Handling
  • Close Handling
    • Basic close behavior
    • Close frame structure
    • Payload length
    • Valid close codes
    • Invalid close codes
  • Integrate Autobahn Test suite.
  • WebSocket Compression
  • WebSocket Extensions
  • Performance