Websocket for Nim
Go to file
Tanguy 8927db93f6
Read frames instead of messages on close
Since #109, there can be only one concurrent user
of recvMsg. So in case someone is already reading,
better to readFrames
2022-05-19 14:27:44 +02:00
.github/workflows CI: test with multiple Nim versions (#99) 2022-01-02 05:49:29 +01:00
autobahn regenerate ssl certificate and private key for autobahn server (#106) 2022-03-11 14:27:13 -06:00
examples Fix for styleCheck:usages (#96) 2021-12-27 11:27:21 +01:00
tests add http header hook 2022-03-16 08:24:16 +07:00
websock Read frames instead of messages on close 2022-05-19 14:27:44 +02: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 .gitignore 2021-05-21 10:25:31 +07:00
Readme.md add websock logo to readme.md 2021-06-29 08:50:34 +07:00
websock.nimble CI: test with multiple Nim versions (#99) 2022-01-02 05:49:29 +01:00
websock.svg add websock logo to readme.md 2021-06-29 08:50:34 +07:00

Readme.md

Websock Logo

Websocket for Nim

Github action

This is an implementation of Websocket protocol for Nim. nim-websock have 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