Go back to shared UDP sockets, expose unref(), make UDP sockets exclusive by default

Author: KurtThiemann

.gitignore

@@ -1,4 +1,4 @@
 .idea/
 node_modules/
-test.js
+example.js
 

README.md

@@ -26,10 +26,14 @@ let client = new QueryClient();
 
 let basic = await client.queryBasic('localhost', 25565, AbortSignal.timeout(5000));
 let full = await client.queryFull('localhost', 25565, AbortSignal.timeout(5000));
+
+await client.close();
 ```
 Basic and full query requests will return a [`BasicStatResponse`](src/Packet/Query/BasicStatResponse.js) 
 and [`FullStatResponse`](src/Packet/Query/FullStatResponse.js) object respectively.
 
+Note that the query client needs to be closed manually, since it keeps its UDP socket open to reuse it for future queries.
+
 ### Java Edition Ping
 The [Server List Ping protocol](https://wiki.vg/Server_List_Ping) is what the Minecraft client uses to show the server status in the in-game server list.
 This protocol changed multiple times over the years, so you'd ideally want to know the version of the server you are pinging to use the correct protocol version.
@@ -94,5 +98,9 @@ import {BedrockPingClient} from 'craftping';
 let client = new BedrockPingClient();
 
 let status = await client.ping('localhost', 19132, AbortSignal.timeout(5000));
+
+await client.close();
 ```
 Pinging a Bedrock server will return an [`UnconnectedPong`](src/Packet/BedrockPing/UnconnectedPong.js) object.
+
+Note that the Bedrock ping client also needs to be closed manually, since it keeps its UDP socket open to reuse it for future requests.

index.js

@@ -65,4 +65,4 @@ export { default as TCPSocket } from "./src/TCPSocket/TCPSocket.js";
 // UDPSocket
 export { default as UDPClient } from "./src/UDPSocket/UDPClient.js";
 export { default as UDPMessage } from "./src/UDPSocket/UDPMessage.js";
-export { default as UDPSocket } from "./src/UDPSocket/UDPSocket.js";
+export { default as SharedUDPSocket } from "./src/UDPSocket/SharedUDPSocket.js";

package-lock.json

@@ -6,6 +6,19 @@ import * as crypto from "node:crypto";
 export default class BedrockPing extends UDPClient {
     /** @type {BigInt} */ sessionId;
 
+    /**
+     * @inheritDoc
+     */
+    appliesTo(message) {
+        let data = message.getData();
+        if (data.byteLength < 9) {
+            return false;
+        }
+
+        let timestamp = data.readBigInt64BE(1);
+        return timestamp === this.sessionId;
+    }
+
     /**
      * @return {Promise<UnconnectedPong>}
      */
@@ -14,24 +27,11 @@ export default class BedrockPing extends UDPClient {
         // to identify which reply belongs to which request.
         this.sessionId = crypto.randomBytes(8).readBigInt64BE();
         let startTime = BigInt(Date.now());
-        await this.sendPacket(new UnconnectedPing().setTime(this.sessionId).generateClientGUID());
+        await this.send(new UnconnectedPing().setTime(this.sessionId).generateClientGUID().write());
         this.signal?.throwIfAborted();
 
         // The time field in the response contains the session ID, but we replace it with the start time
         // in case anyone relies on the time field containing an actual timestamp.
         return new UnconnectedPong().read(await this.readData()).setTime(startTime);
     }
-
-    /**
-     * @inheritDoc
-     */
-    shouldAcceptPacket(packet) {
-        let data = packet.getData();
-        if (data.byteLength < 9) {
-            return false;
-        }
-
-        let timestamp = data.readBigInt64BE(1);
-        return timestamp === this.sessionId;
-    }
 }

src/BedrockPing/BedrockPing.js

@@ -1,36 +1,24 @@
-import UDPSocket from "../UDPSocket/UDPSocket.js";
 import BedrockPing from "./BedrockPing.js";
+import SharedUDPSocket from "../UDPSocket/SharedUDPSocket.js";
 
-export default class BedrockPingClient {
-    /** @type {import("node:dgram").SocketOptions}} */ socketOptions;
-    /** @type {import("node:dgram").BindOptions}} */ bindOptions;
-
-    /**
-     * @param {import("node:dgram").SocketOptions} socketOptions
-     * @param {import("node:dgram").BindOptions} bindOptions
-     */
-    constructor(socketOptions = {type: "udp4"}, bindOptions = {}) {
-        this.socketOptions = socketOptions;
-        this.bindOptions = bindOptions;
-    }
-
+export default class BedrockPingClient extends SharedUDPSocket {
     /**
      * @param {string} address
      * @param {number} port
      * @param {?AbortSignal} signal
      * @return {Promise<UnconnectedPong>}
      */
     async ping(address, port, signal = null) {
-        let ping = new BedrockPing(address, port, signal, this.socketOptions, this.bindOptions);
-        await ping.bind(signal);
+        let ping = new BedrockPing(address, port, this, signal);
+        await ping.connect();
         let result;
         try {
             result = await ping.ping();
         } catch (e) {
-            await ping.close();
+            ping.close();
             throw e;
         }
-        await ping.close();
+        ping.close();
         return result;
     }
 }

src/BedrockPing/BedrockPingClient.js

@@ -10,14 +10,27 @@ export default class Query extends UDPClient {
     /** @type {number} */ sessionId;
     /** @type {number} */ challengeToken;
 
+    /**
+     * @inheritDoc
+     */
+    appliesTo(message) {
+        let data = message.getData();
+        if (data.byteLength < 5) {
+            return false;
+        }
+
+        let session = data.readUInt32BE(1);
+        return session === this.sessionId;
+    }
+
     /**
      * @return {Promise<this>}
      */
     async handshake() {
         let handshakeRequest = new HandshakeRequest().generateSessionId();
         this.sessionId = handshakeRequest.getSessionId();
 
-        await this.sendPacket(handshakeRequest);
+        await this.send(handshakeRequest.write());
         this.signal?.throwIfAborted();
 
         let handshakeResponse = new HandshakeResponse().read(await this.readData());
@@ -31,9 +44,10 @@ export default class Query extends UDPClient {
     async queryBasic() {
         await this.handshake();
 
-        await this.sendPacket(new BasicStatRequest()
+        await this.send(new BasicStatRequest()
             .setSessionId(this.sessionId)
-            .setChallengeToken(this.challengeToken));
+            .setChallengeToken(this.challengeToken)
+            .write());
 
         this.signal?.throwIfAborted();
         return new BasicStatResponse().read(await this.readData());
@@ -45,24 +59,12 @@ export default class Query extends UDPClient {
     async queryFull() {
         await this.handshake();
 
-        await this.sendPacket(new FullStatRequest()
+        await this.send(new FullStatRequest()
             .setSessionId(this.sessionId)
-            .setChallengeToken(this.challengeToken));
+            .setChallengeToken(this.challengeToken)
+            .write());
 
         this.signal?.throwIfAborted();
         return new FullStatResponse().read(await this.readData());
     }
-
-    /**
-     * @inheritDoc
-     */
-    shouldAcceptPacket(packet) {
-        let data = packet.getData();
-        if (data.byteLength < 5) {
-            return false;
-        }
-
-        let session = data.readUInt32BE(1);
-        return session === this.sessionId;
-    }
 }