Websocket for Nim
Go to file
jangko 88e99ff028
fixes failing utf8 test case
it was a buggy test case, not related to windows
but by chance discovered on windows.
2021-06-12 13:39:24 +07:00
.github/workflows Fix partial frame handling and allow extensions to hijack the flow (#56) 2021-06-11 14:04:09 -06:00
autobahn Fix partial frame handling and allow extensions to hijack the flow (#56) 2021-06-11 14:04:09 -06:00
examples Fix partial frame handling and allow extensions to hijack the flow (#56) 2021-06-11 14:04:09 -06:00
tests fixes failing utf8 test case 2021-06-12 13:39:24 +07:00
ws don't await `nil` futures 2021-06-11 20:53:34 -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 add autobahn summary report link to readme.md 2021-05-22 12:12:42 +07:00
ws.nimble Fix autobahn tls tests (#57) 2021-06-11 18:40:56 -06: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.

See what is available and what is missing in 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. (In progress)
  • WebSocket Compression
  • WebSocket Extensions
  • Performance