Make mac m1 tests pass with a key sleep.

.github/workflows/build.yml

@@ -1,26 +1,16 @@
-name: Run tests
+name: Github Actions
 on: [push, pull_request]
 jobs:
   build:
-    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
 
-    steps:
-    - uses: actions/checkout@v1
-
-    - name: Cache choosenim
-      id: cache-choosenim
-      uses: actions/cache@v1
-      with:
-        path: ~/.choosenim
-        key: ${{ runner.os }}-choosenim-stable
-
-    - name: Cache nimble
-      id: cache-nimble
-      uses: actions/cache@v1
-      with:
-        path: ~/.nimble
-        key: ${{ runner.os }}-nimble-stable
+    runs-on: ${{ matrix.os }}
 
+    steps:
+    - uses: actions/checkout@v2
     - uses: jiro4989/setup-nim-action@v1
-
     - run: nimble test -y
+    - run: nimble test --gc:orc -y

README.md

@@ -1,7 +1,17 @@
+<img src="docs/nettyBanner.png">
+
 # Netty - reliable UDP connection for Nim.
 
+`nimble install netty`
+
+![Github Actions](https://github.com/treeform/netty/workflows/Github%20Actions/badge.svg)
+
 Netty is a reliable connection over UDP aimed at games. Normally UDP packets can get duplicated, dropped, or come out of order. Netty makes sure packets are not duplicated, re-sends them if they get dropped, and all packets come in order. UDP packets might also get split if they are above 512 bytes and also can fail to be sent if they are bigger than 1-2k. Netty breaks up big packets and sends them in pieces making sure each piece comes reliably in order. Finally sometimes it's impossible for two clients to communicate direclty with TCP because of NATs, but Netty provides hole punching which allows them to connect.
 
+### Documentation
+
+API reference: https://nimdocs.com/treeform/netty
+
 ## Is Netty a implementation of TCP?
 
 TCP is really bad for short latency sensitive messages. TCP was designed for throughput (downloading files) not latency (games). Netty will resend stuff faster than TCP, Netty will not buffer and you also get nat punch-through (which TCP does not have). Netty is basically "like TCP but for games". You should not be using Netty if you are will be sending large mount of data. By default Netty is capped at 250K of data in flight.

src/netty.nim

@@ -268,7 +268,7 @@ func deleteAckedParts(reactor: Reactor) =
 
 proc readParts(reactor: Reactor) =
   var
-    buf = newStringOfCap(reactor.debug.maxUdpPacket)
+    buf = newStringOfCap(reactor.debug.maxUdpPacket + headerSize)
     host: string
     port: Port
 
@@ -279,6 +279,8 @@ proc readParts(reactor: Reactor) =
         buf, reactor.debug.maxUdpPacket + headerSize, host, port
       )
     except:
+      when defined(nettyMagicSleep):
+        sleep(1)
       break
 
     let address = initAddress(host, port.int)

tests/config.nims

@@ -1 +1,4 @@
 --path:"../src"
+# On macOS localhost writes take longer, so sleep in strategic places
+# to make it like Windows and Linux.
+--define:"nettyMagicSleep"