Websocket for Nim
Go to file
Dmitriy Ryajov 4133d1d87c
bump chronos to 3.0.0
2021-05-21 10:42:41 +07:00
.github/workflows fix github action script 2021-05-21 09:14:36 +07:00
examples WIP: Implement websocket TLS. (#7) 2021-04-13 16:05:58 -06:00
tests WIP: Implement websocket TLS. (#7) 2021-04-13 16:05:58 -06:00
ws WIP: Implement websocket TLS. (#7) 2021-04-13 16:05:58 -06:00
.editorconfig Implement web socket handshake 2020-12-01 18:13:59 +05:30
.gitignore add .gitignore 2021-05-21 10:25:31 +07:00
Readme.md Update Readme.md with roadmap. 2021-05-21 09:47:14 +07:00
ws.nimble bump chronos to 3.0.0 2021-05-21 10:42:41 +07:00

Readme.md

Websocket for Nim

Github action

We're working towards an implementation of the Websocket protocol for Nim. This is very much a work in progress, and not yet in a usable state.

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. (In progress)
  • WebSocket Compression
  • WebSocket Extensions
  • Performance