Updated tests and documentation

Author: Tom32i

README.md

@@ -9,9 +9,11 @@ Features:
 - 📢 Listen for event dispatched over websocket with simple `on`/`off` event emitter system.
 - 💬 Fallback to JSON for easy debugging.
 
+**NEW: experimental Golang port available**
+
 ## Requirements
 
-- Node >= v8.0.0
+- Node >= v24.0.0
 
 ## Installation
 
@@ -26,8 +28,7 @@ An event is defined by its _unique_ name and the corresponding codec, responsibl
 
 ```javascript
 // events.js
-import UInt8Codec from 'netcode/src/encoder/codec/UInt8Codec';
-import StringCodec from 'netcode/src/encoder/codec/StringCodec';
+import { UInt8Codec, StringCodec } from 'netcode/encoder';
 
 export default [
 	['id', new UInt8Codec()],
@@ -53,8 +54,7 @@ We setup a server specifying the port and host on which the server will listen a
 Here we use a BinaryEncoder to communicate in binary over websocket, with the previously configured event list.
 
 ```javascript
-import Server from 'netcode/src/server/Server';
-import BinaryEncoder from 'netcode/src/encoder/BinaryEncoder';
+import { Server, BinaryEncoder } from 'netcode/server';
 import events from './events';
 
 // Listen on localhost:8080
@@ -68,15 +68,14 @@ server.on('client:join', client => {
 
 Now we've got a server running at `localhost:8080` that listen for a `say` text event and send a `id` integer event to every client that connects.
 
-_See an [full example of server setup](demo-server.js)._
+_See an [full example of server setup](demo/server.js)._
 
 ### Write a Client
 
 Now we write a client, for the browser, that connects to our running server on `ws://localhost:8080` and use a BinaryEncoder with the same event list as the server.
 
 ```javascript
-import Client from 'netcode/src/client/Client';
-import BinaryEncoder from 'netcode/src/encoder/BinaryEncoder';
+import { Client, BinaryEncoder } from 'netcode/client';
 import events from './events';
 
 const client = new Client('ws://localhost:8080', new BinaryEncoder(events))
@@ -91,7 +90,7 @@ Now we've got client that listen for the `id` event and sent a sentence in a `sa
 
 Connection is alive and well!
 
-_See an [full example of client setup](demo-client.js)._
+_See an [full example of client setup](demo/client.js)._
 
 ## Complete documentation
 

demo/client.js

@@ -1,4 +1,4 @@
-import { Client, BinaryEncoder, UInt8Codec, UIntLongCodec, BooleanCodec, StringLongCodec } from 'netcode/client';
+import { Client, BinaryEncoder, UInt8Codec, UIntLongCodec, Int16Codec, BooleanCodec, StringLongCodec } from 'netcode/client';
 
 window.addEventListener('load', () => {
     const target = document.getElementById('output');
@@ -19,6 +19,7 @@ window.addEventListener('load', () => {
         ['inverse', new BooleanCodec()],
         ['greeting', new StringLongCodec()],
         ['total', new UInt8Codec()],
+        ['int16', new Int16Codec()],
     ]);
 
 
@@ -51,6 +52,12 @@ window.addEventListener('load', () => {
         console.info(`There is ${total} people connected.`);
     });
 
+    // Listen for a "int16" event
+    client.on('int16', ({ detail: value }) => {
+        console.info(`int16 codec: ${value}.`);
+        client.send('int16', -32768);
+    });
+
     // Listen for an "inverse" event
     client.on('inverse', ({ detail: status }) => {
         // Answer with an "inverse" event
@@ -59,7 +66,6 @@ window.addEventListener('load', () => {
 
         // Send a "greeting" event
         client.send('greeting', 'Hello, I\'m client 😊! Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut imperdiet molestie libero, ut sollicitudin tortor dignissim quis. Nulla iaculis nisi turpis, a malesuada nibh faucibus a. Nunc tellus lorem, varius sit amet tellus eu, dictum consectetur nulla.');
-        // client.send('greeting', 'Hi!');
     });
 
     // Listen for a "greeting" event
@@ -70,7 +76,7 @@ window.addEventListener('load', () => {
     // Listen for oppening connection
     client.on('open', () => {
         console.info('Connection open.');
-        setTimeout(() => client.close(1000, 'All good :)'), 20 * 1000);
+        setTimeout(() => client.close(1000, 'All good :)'), 10 * 1000);
     });
 
     // Listen for connection close

demo/server.go

@@ -21,85 +21,88 @@ func main() {
 
 	encoder := netcode.CreateBinaryEncoder([]*netcode.RegisteredCodec{
 		{0, "id", netcode.UInt8Codec{}},
-		{1, "ping", netcode.UIntLongCodec{6}},
-		{2, "pong", netcode.UIntLongCodec{6}},
-		{3, "inverse", netcode.BooleanCodec{}},
-		{4, "greeting", netcode.StringLongCodec{}},
-		{5, "total", netcode.UInt8Codec{}},
+		{0, "ping", netcode.UIntLongCodec{6}},
+		{0, "pong", netcode.UIntLongCodec{6}},
+		{0, "inverse", netcode.BooleanCodec{}},
+		{0, "greeting", netcode.StringLongCodec{}},
+		{0, "total", netcode.UInt8Codec{}},
+		{0, "int16", netcode.Int16Codec{}},
 	}, netcode.UInt8Codec{})
 
-	demo := Demo{
+	d := Demo{
 		netcode.CreateSockets(encoder, uint(math.Pow(2, 8))),
 	}
 
-	go demo.run()
+	go d.run()
 
-	netcode.Start(*port, "/", func(conn *websocket.Conn, request *http.Request) {
-		socket, err := demo.sockets.Add(conn)
+	netcode.Start(*port, "/", d.SocketHandler, netcode.CheckOrigin, netcode.ErrorHandler)
+}
 
-		if err != nil {
-			log.Fatal(err)
-		}
+func (d *Demo) SocketHandler(w http.ResponseWriter, r *http.Request, c *websocket.Conn) {
+	socket, err := d.sockets.Add(c)
 
-		netcode.CreateBeacon(socket, time.Second*3, func(ping time.Duration) {
-			log.Printf("Client #%d ping: %s.", socket.ID, ping)
-		})
+	if err != nil {
+		log.Fatal(err)
+	}
 
-		demo.onClientJoin(socket)
+	netcode.CreateBeacon(socket, time.Second*3, func(ping time.Duration) {
+		log.Printf("Client #%d ping: %s.", socket.ID, ping)
 	})
+
+	d.onClientJoin(socket)
 }
 
-func (demo *Demo) run() {
+func (d *Demo) run() {
 	log.Printf("Demo is running")
 	for {
 		select {
-		case m := <-demo.sockets.In:
+		case m := <-d.sockets.In:
 			switch m.Message.Name {
 			case "ping":
-				demo.handlePing(m.Socket, m.Message)
+				d.handlePing(m.Socket, m.Message)
 			case "greeting":
-				demo.handleGreeting(m.Socket, m.Message)
+				d.handleGreeting(m.Socket, m.Message)
+			case "int16":
+				d.handleInt16(m.Socket, m.Message)
 			default:
 				log.Printf("[socket #%d] '%s': %v", m.Socket.ID, m.Message.Name, m.Message.Data)
 			}
-		case socket := <-demo.sockets.Out:
-			demo.onClientLeave(socket)
-			// switch e.Name {
-			// case "socket:join":
-			// 	demo.onClientJoin(e.Data.(*netcode.Socket))
-			// case "socket:leave":
-			// 	demo.onClientLeave(e.Data.(*netcode.Socket))
-			// default:
-			// 	log.Printf("event '%s': %v", e.Name, e.Data)
-			// }
+		case socket := <-d.sockets.Out:
+			d.onClientLeave(socket)
 		}
 	}
 }
 
-func (demo *Demo) broadcastTotal() {
-	demo.sockets.SendAll(
-		&netcode.Message{"total", uint8(demo.sockets.Count())},
+func (d *Demo) broadcastTotal() {
+	d.sockets.SendAll(
+		&netcode.Message{"total", uint8(d.sockets.Count())},
 	)
 }
 
-func (demo *Demo) onClientJoin(s *netcode.Socket) {
+func (d *Demo) onClientJoin(s *netcode.Socket) {
 	log.Printf("Client #%d joined.", s.ID)
 	s.Send(&netcode.Message{"id", uint8(s.ID)})
-	demo.broadcastTotal()
+	d.broadcastTotal()
+
+	s.Send(&netcode.Message{"int16", int16(math.MaxInt16)})
 }
 
-func (demo *Demo) onClientLeave(s *netcode.Socket) {
+func (d *Demo) onClientLeave(s *netcode.Socket) {
 	log.Printf("Client #%d left.", s.ID)
-	demo.broadcastTotal()
+	d.broadcastTotal()
 }
 
-func (demo *Demo) handlePing(s *netcode.Socket, m *netcode.Message) {
-	log.Printf("Client #%d ping: %d.", s.ID, m.Data)
+func (d *Demo) handlePing(s *netcode.Socket, m *netcode.Message) {
+	log.Printf("Client #%d ping: %d.", s.ID, m.Data.(uint))
 	s.Send(&netcode.Message{"pong", uint(time.Now().UnixMilli())})
 	s.Send(&netcode.Message{"inverse", true})
 }
 
-func (demo *Demo) handleGreeting(s *netcode.Socket, m *netcode.Message) {
-	log.Printf("Client #%d greets you: '%s'.", s.ID, m.Data)
+func (d *Demo) handleGreeting(s *netcode.Socket, m *netcode.Message) {
+	log.Printf("Client #%d greets you: '%s'.", s.ID, m.Data.(string))
 	s.Send(&netcode.Message{"greeting", "Hello, I'm server! 😊 Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut imperdiet molestie libero, ut sollicitudin tortor dignissim quis. Nulla iaculis nisi turpis, a malesuada nibh faucibus a. Nunc tellus lorem, varius sit amet tellus eu, dictum consectetur nulla."})
 }
+
+func (d *Demo) handleInt16(s *netcode.Socket, m *netcode.Message) {
+	log.Printf("Client #%d sends int16: %d.", s.ID, m.Data.(int16))
+}

demo/server.js

@@ -3,6 +3,7 @@ import {
     BinaryEncoder,
     UInt8Codec,
     UIntLongCodec,
+    Int16Codec,
     BooleanCodec,
     StringLongCodec,
 } from 'netcode/server';
@@ -15,6 +16,7 @@ const encoder = new BinaryEncoder([
     ['inverse', new BooleanCodec()],
     ['greeting', new StringLongCodec()],
     ['total', new UInt8Codec()],
+    ['int16', new Int16Codec()],
 ]);
 
 // Create the server
@@ -47,10 +49,17 @@ server.on('client:join', client => {
         client.send('greeting', 'Hello, I\'m server! 😊 Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut imperdiet molestie libero, ut sollicitudin tortor dignissim quis. Nulla iaculis nisi turpis, a malesuada nibh faucibus a. Nunc tellus lorem, varius sit amet tellus eu, dictum consectetur nulla.');
     });
 
+    // Listen for "int16" event
+    client.on('int16', message => {
+        console.info('Client %s sends int16: %s', client.id, message);
+    });
+
     // Send event "id" to the client
     client.send('id', client.id);
 
     broadcastTotal();
+
+    client.send('int16', 32767);
 });
 
 // Listen for disconnecting clients

doc/API.md

@@ -9,9 +9,10 @@ The `Server` class takes the following arguments:
 | port      | _Number_                       | 8080              | Port to listen on.                                   |
 | host      | _String_                       | 0.0.0.0           | Host to listen on.                                   |
 | encoder   | _BinaryEncoder \| JsonEncoder_ | new JsonEncoder() | Encoder to use to read/write event messages.         |
-| ping      | _Number_                       | 30                | Ping frequency in seconds (0 for no ping).           |
-| maxLength | _Number_                       | 512               | Paquet max length in bit (should be a power of two). |
-| protocols | _Array String[]_               | `['websocket']`   | Protocols tu use                                     |
+| pingInterval      | _Number_                       | 30                | Ping frequency in seconds (0 for no ping).           |
+| maxPayload | _Number_                       | 512               | Paquet max length in bit (should be a power of two). |
+| clients | _ClientDirectory_               | `new MapClientDirectory()`   | Client directory                                    |
+| autoStart | _Boolean_               | `true`   | Should the server start listening immediatly?                                    |
 
 ### Methods
 
@@ -27,8 +28,6 @@ Listen for event.
 
 Remove listener for this event / callback.
 
-_Note: If you're on node `< 10.0.0`, use `removeListener` method instead of `off`_
-
 ### Events
 
 | Name | Callback parameters | Description |
@@ -76,4 +75,4 @@ _Note: If you're on node `< 10.0.0`, use `removeListener` method instead of `off
 | `close` | client _{Client_} | Client connection is closed. |
 | * | - eventData _{Number\|String\|Boolean\|Object}_<br />- client _Client_ | Every event sent through the websocket pipe will emit an event on the other end of the socket. |
 
-_Note: `open`, `error` and `close` are reserved event names and the Encoder will throw an exeption if you define a custom event with either of these names._
+_Note: `open`, `error` and `close` are reserved event names and the Encoder will throw an exeption if you define a custom event with either of these names._

doc/codecs.md

@@ -10,14 +10,20 @@ Packaged codecs are available in the `netcode/server` and `netcode/client` packa
 
 | Class                      | Data format                        | Example                                                      | Size (in byte)          |
 | -------------------------- | ---------------------------------- | ------------------------------------------------------------ | ----------------------- |
-| `Codec`                    | No data (just send the event name) | `['pause', new Codec()]`<br />`send('pause')`                | 0                       |
-| `BooleanCodec`             | `true\|false`                       | `['active', new BooleanCodec()]`<br />`send('active', true)` | 1                       |
-| `StringCodec`              | String up to 255 characters        | `['player:name', new StringCodec()]`<br />`send('player:name', 'DarkShadow73')` | 1 + (String length * 2) |
-| `StringLongCodec`          | String up to 65536 characters      | `['url', new StringLongCodec()]`<br />`send('url', 'https://my.long.url/hash/xxx...')` | 2 + (String length * 2) |
+| `NullCodec`                    | No data (just send the event name) | `['pause', new NullCodec()]`<br />`send('pause')`                | 0                       |
+| `BooleanCodec`             | `true\|false`                       | `['active', new BooleanCodec()]`<br />`send('active', true)` |                     |
 | `UInt8Codec`                | Integer from 0 to 255              | `['id', new UInt8Codec()]`<br />`send('id', 42)`              | 1                       |
 | `UInt16Codec`               | Integer from 0 to 65536            | `['score', new UInt16Codec()]`<br />`send('score', 9999)`     | 2                       |
 | `UInt32Codec`               | Integer from 0 to 4294967295       | `['position', new UInt32Codec()]`<br />`send('position', 4294967295)` | 4                       |
 | `UIntLongCodec(byteLength)` | Integer encoded as string          | `['timestamp', new UIntLongCodec(13)`]<br />`send('timestamp', Date.now())` | byteLength              |
+| `Int8Codec`                | Integer from -128 to 127              | `['value', new Int8Codec()]`<br />`send('value', -42)`              | 1                       |
+| `Int16Codec`               | Integer from -32768 to 32767            | `['malus', new Int16Codec()]`<br />`send('malus', -999)`     | 2                       |
+| `Int32Codec`               | Integer from -2147483648 to 2147483647       | `['position', new Int32Codec()]`<br />`send('position', -123456)` | 4                       |1                       |
+| `Float32Codec`<br />⚠ Subject to precision issues               | Float on 32bit     | `['position', new Float32Codec()]`<br />`send('position', 84.19999694824219)` | 4                       |
+| `Float64Codec`               | Float on 64bit           | `['position', new Float64Codec()]`<br />`send('position', -12456789.123456789087654321012345678901)`     | 2                       |
+| `FloatPrecisionCodec(IntCodec, precision)`               | Float encoded as int           | `['position', FloatPrecisionCodec(Int8Codec, 3)]`<br />`send('position', -0.657)`     | 2
+| `StringCodec`              | String up to 255 characters        | `['player:name', new StringCodec()]`<br />`send('player:name', 'DarkShadow73')` | 1 + (String length * 2) |
+| `StringLongCodec`          | String up to 65536 characters      | `['url', new StringLongCodec()]`<br />`send('url', 'https://my.long.url/hash/xxx...')` | 2 + (String length * 2) |
 
 ## Custom codecs
 

doc/go.md

@@ -0,0 +1,18 @@
+# Go port
+
+Netcode server is also available in Golang.
+
+It's fully compatible with the netcode browser client.
+
+## Current features
+
+- [x] Server
+- [x] Sockets (equivalent of Client / Client Directory)
+- [x] Binary encoder
+- [ ] Json encoder
+- [x] Packaged codecs (compatible with javascript codec)
+- [x] Beacon (ping at regular interval)
+
+## Notes
+
+Netcode in golang is relying on [github.com/gorilla/websocket](github.com/gorilla/websocket) for Websocket implementation.