Websocket for Nim
Go to file
jangko 7e668c4c85
fix compile time error when using chronicles sink:json
fixes #73
2021-06-28 15:07:06 +02:00
.github/workflows ci: parallelise autobahn tests 2021-06-20 14:34:49 +07:00
autobahn ci: parallelise autobahn tests 2021-06-20 14:34:49 +07:00
examples implement permessage-deflate compression extension 2021-06-20 14:50:54 +07:00
tests Fix mutual closing (#76) 2021-06-28 14:52:18 +02:00
ws fix compile time error when using chronicles sink:json 2021-06-28 15:07:06 +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 update readme.md reflecting current state of nim-ws 2021-06-20 10:17:05 +07:00
ws.nimble fix compile time error when using chronicles sink:json 2021-06-28 15:07:06 +02:00

Readme.md

Websocket for Nim

Github action

This is an implementation of Websocket protocol for Nim. nim-ws 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 test/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