@neko-net/rusty-enet 0.1.3

package/README.md

@@ -0,0 +1,47 @@
+# @neko-net/rusty-enet
+
+Node.js binding for [ENet](http://enet.bespin.org/) via [rusty_enet](https://github.com/neko-net/rusty_enet), built with [napi-rs](https://napi.rs).
+
+ENet is a thin UDP networking layer designed for real-time applications like games, providing optional reliable, sequenced packet delivery over multiple channels.
+
+## Install
+
+```sh
+npm install @neko-net/rusty-enet
+```
+
+Prebuilt binaries for Linux (x64, arm64), macOS (x64, arm64), and Windows (x64, arm64).
+
+## Quick start
+
+```js
+const { EnetHost, PacketKind } = require('@neko-net/rusty-enet');
+
+async function main() {
+  // Server
+  const server = new EnetHost('127.0.0.1:0', { peerLimit: 1, channelLimit: 2 });
+  const port = (await server.getLocalAddr()).split(':').pop();
+
+  // Client
+  const client = new EnetHost('127.0.0.1:0', { peerLimit: 1, channelLimit: 2 });
+  await client.connect(`127.0.0.1:${port}`, 2, 0);
+
+  // Connect events fire on both sides
+  await server.service(); // { eventType: 'Connect', peerId: 0, data: 0 }
+  await client.service(); // { eventType: 'Connect', peerId: 0 }
+
+  // Send a reliable packet
+  await client.send(0, 0, Buffer.from('hello'), PacketKind.Reliable);
+  const recv = await server.service();
+  console.log(recv.packet.toString()); // "hello"
+
+  server.close();
+  client.close();
+}
+
+main();
+```
+
+## License
+
+MIT

package/index.d.ts

@@ -0,0 +1,205 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+/** Packet delivery guarantees. */
+export const enum PacketKind {
+  /**
+   * No reliability or sequencing. Packets may be dropped and are not
+   * retransmitted. Duplicate packets are discarded.
+   */
+  Unreliable = 'Unreliable',
+  /**
+   * No reliability, no sequencing, and no duplicate suppression. Packets may
+   * be dropped and duplicates are delivered as-is.
+   */
+  UnreliableUnsequenced = 'UnreliableUnsequenced',
+  /**
+   * Guaranteed delivery and ordering. Packets are retransmitted until
+   * acknowledged.
+   */
+  Reliable = 'Reliable',
+  /**
+   * Like `Unreliable` but never fragmented; dropped entirely if larger
+   * than the MTU.
+   */
+  AlwaysUnreliable = 'AlwaysUnreliable',
+  /** Like `UnreliableUnsequenced` but never fragmented. */
+  AlwaysUnreliableUnsequenced = 'AlwaysUnreliableUnsequenced'
+}
+/** Event returned by `host.service()`. */
+export const enum EventType {
+  /** A new peer connected. */
+  Connect = 'Connect',
+  /** A peer disconnected. */
+  Disconnect = 'Disconnect',
+  /** A packet was received. */
+  Receive = 'Receive'
+}
+/** Connection lifecycle state of a peer. */
+export const enum PeerState {
+  /** Peer is not connected. */
+  Disconnected = 'Disconnected',
+  /** Connection request has been sent. */
+  Connecting = 'Connecting',
+  /** Acknowledging a connection request. */
+  AcknowledgingConnect = 'AcknowledgingConnect',
+  /** Connection is pending acceptance. */
+  ConnectionPending = 'ConnectionPending',
+  /** Connection has succeeded (handshake complete). */
+  ConnectionSucceeded = 'ConnectionSucceeded',
+  /** Peer is fully connected and can send/receive. */
+  Connected = 'Connected',
+  /** Peer will disconnect after all queued outgoing packets are sent. */
+  DisconnectLater = 'DisconnectLater',
+  /** Disconnect request has been sent, waiting for acknowledgment. */
+  Disconnecting = 'Disconnecting',
+  /** Acknowledging a disconnect request. */
+  AcknowledgingDisconnect = 'AcknowledgingDisconnect',
+  /** Peer has been disconnected but freed. Should no longer be referenced. */
+  Zombie = 'Zombie'
+}
+/** Settings passed to the `EnetHost` constructor. */
+export interface HostSettings {
+  /** Maximum number of connected peers (default: 64). */
+  peerLimit?: number
+  /** Maximum number of channels per peer (default: 0). */
+  channelLimit?: number
+  /** Downstream bandwidth limit in bytes/second (default: 0 = unlimited). */
+  incomingBandwidth?: number
+  /** Upstream bandwidth limit in bytes/second (default: 0 = unlimited). */
+  outgoingBandwidth?: number
+  /** PRNG seed for ENet's internal random number generator. */
+  seed?: number
+}
+/** An event delivered by `host.service()`. */
+export interface EnetEvent {
+  /** What kind of event occurred. */
+  eventType: EventType
+  /** The peer this event relates to. */
+  peerId: number
+  /**
+   * Event-specific data: connect data on `Connect`, disconnect reason on
+   * `Disconnect`.
+   */
+  data?: number
+  /** Channel the packet arrived on (`Receive` only). */
+  channelId?: number
+  /** Received packet data (`Receive` only). */
+  packet?: Buffer
+}
+/** Snapshot of a peer's current state and statistics. */
+export interface PeerInfo {
+  /** Current connection lifecycle state. */
+  state: PeerState
+  /** Number of channels this peer has open. */
+  channelCount: number
+  /** Smoothed round-trip time in milliseconds. */
+  roundTripTimeMs: number
+  /** Variance of the round-trip time in milliseconds. */
+  roundTripTimeVarianceMs: number
+  /** Packet loss as a fixed-point 32.32 value (0 = none, 1<<32 = 100%). */
+  packetLoss: number
+  /** Total packets sent to this peer. */
+  packetsSent: number
+  /** Total packets lost (not acknowledged by this peer). */
+  packetsLost: number
+  /** Current incoming bandwidth limit in bytes/second. */
+  incomingBandwidth: number
+  /** Current outgoing bandwidth limit in bytes/second. */
+  outgoingBandwidth: number
+  /** Remote IP address and port, if known. */
+  address?: string
+}
+export declare class EnetHost {
+  constructor(bindAddr: string, settings?: HostSettings | undefined | null)
+  /**
+   * Waits for the next event from this host.
+   *
+   * Returns `null` after the host has been closed via `close()` or when the
+   * host is dropped.
+   */
+  service(): Promise<EnetEvent | null>
+  /**
+   * Shuts down the host and its background thread.
+   *
+   * After calling `close()`, `service()` will return `null`.
+   */
+  close(): void
+  /** Flushes all queued outgoing packets immediately. */
+  flush(): Promise<void>
+  /**
+   * Initiates a connection to a remote host.
+   *
+   * `channel_count` is the number of channels to allocate for this peer.
+   * `data` is sent along with the connection request and delivered as the
+   * `data` field on the `Connect` event at the remote host.
+   *
+   * Returns the assigned peer ID.
+   */
+  connect(addr: string, channelCount: number, data: number): Promise<number>
+  /** Returns the current `PeerState` of the given peer. */
+  getPeerState(peerId: number): Promise<PeerState>
+  /** Returns a snapshot of the peer's state, timing, and bandwidth stats. */
+  getPeerInfo(peerId: number): Promise<PeerInfo>
+  /** Sends a packet to a peer on a given channel. */
+  send(peerId: number, channelId: number, data: Buffer, kind: PacketKind): Promise<void>
+  /** Sends a packet to all connected peers on a given channel. */
+  broadcast(channelId: number, data: Buffer, kind: PacketKind): Promise<void>
+  /**
+   * Requests a graceful disconnect. The peer will be disconnected once all
+   * queued outgoing packets are sent. `data` is delivered as the disconnect
+   * reason.
+   */
+  disconnect(peerId: number, data: number): Promise<void>
+  /**
+   * Disconnects the peer immediately, discarding any queued outgoing
+   * packets. `data` is delivered as the disconnect reason.
+   */
+  disconnectNow(peerId: number, data: number): Promise<void>
+  /**
+   * Marks the peer for disconnection after all queued outgoing packets are
+   * sent. `data` is delivered as the disconnect reason.
+   */
+  disconnectLater(peerId: number, data: number): Promise<void>
+  /**
+   * Sends a ping to the peer. The round-trip time will be updated in
+   * `get_peer_info()`.
+   */
+  ping(peerId: number): Promise<void>
+  /**
+   * Sets the timeout parameters for a peer.
+   *
+   * `limit`  timeout limit in milliseconds before the peer is disconnected
+   * after an unacknowledged packet.
+   * `min`  minimum timeout in milliseconds.
+   * `max`  maximum timeout in milliseconds.
+   */
+  setTimeout(peerId: number, limit: number, min: number, max: number): Promise<void>
+  /** Sets how often pings are sent to the peer (in milliseconds). */
+  setPingInterval(peerId: number, interval: number): Promise<void>
+  /**
+   * Controls the throttle mechanism for a peer.
+   *
+   * `interval`  interval in milliseconds between throttle adjustments.
+   * `accel`  acceleration factor.
+   * `decel`  deceleration factor.
+   */
+  setThrottle(peerId: number, interval: number, accel: number, decel: number): Promise<void>
+  /** Sets the maximum number of channels for future connections. */
+  setChannelLimit(limit: number): Promise<void>
+  /**
+   * Sets the bandwidth limits for the host in bytes/second.
+   * Pass `null`/`undefined` to leave a limit unchanged.
+   */
+  setBandwidthLimit(incoming?: number | undefined | null, outgoing?: number | undefined | null): Promise<void>
+  /** Sets the maximum transmission unit (MTU) in bytes. */
+  setMtu(mtu: number): Promise<void>
+  /** Returns the maximum number of peers this host allows. */
+  getPeerLimit(): Promise<number>
+  /** Returns the maximum number of channels per peer. */
+  getChannelLimit(): Promise<number>
+  /** Returns the local address this host is bound to (e.g. `"127.0.0.1:12345"`). */
+  getLocalAddr(): Promise<string>
+}

package/index.js

@@ -0,0 +1,318 @@
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+
+/* auto-generated by NAPI-RS */
+
+const { existsSync, readFileSync } = require('fs')
+const { join } = require('path')
+
+const { platform, arch } = process
+
+let nativeBinding = null
+let localFileExisted = false
+let loadError = null
+
+function isMusl() {
+  // For Node 10
+  if (!process.report || typeof process.report.getReport !== 'function') {
+    try {
+      const lddPath = require('child_process').execSync('which ldd').toString().trim()
+      return readFileSync(lddPath, 'utf8').includes('musl')
+    } catch (e) {
+      return true
+    }
+  } else {
+    const { glibcVersionRuntime } = process.report.getReport().header
+    return !glibcVersionRuntime
+  }
+}
+
+switch (platform) {
+  case 'android':
+    switch (arch) {
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, 'rusty-enet.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rusty-enet.android-arm64.node')
+          } else {
+            nativeBinding = require('@neko-net/rusty-enet-android-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'rusty-enet.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rusty-enet.android-arm-eabi.node')
+          } else {
+            nativeBinding = require('@neko-net/rusty-enet-android-arm-eabi')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Android ${arch}`)
+    }
+    break
+  case 'win32':
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(
+          join(__dirname, 'rusty-enet.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rusty-enet.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('@neko-net/rusty-enet-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, 'rusty-enet.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rusty-enet.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('@neko-net/rusty-enet-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'rusty-enet.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rusty-enet.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('@neko-net/rusty-enet-win32-arm64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Windows: ${arch}`)
+    }
+    break
+  case 'darwin':
+    localFileExisted = existsSync(join(__dirname, 'rusty-enet.darwin-universal.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./rusty-enet.darwin-universal.node')
+      } else {
+        nativeBinding = require('@neko-net/rusty-enet-darwin-universal')
+      }
+      break
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'rusty-enet.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rusty-enet.darwin-x64.node')
+          } else {
+            nativeBinding = require('@neko-net/rusty-enet-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'rusty-enet.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rusty-enet.darwin-arm64.node')
+          } else {
+            nativeBinding = require('@neko-net/rusty-enet-darwin-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on macOS: ${arch}`)
+    }
+    break
+  case 'freebsd':
+    if (arch !== 'x64') {
+      throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
+    }
+    localFileExisted = existsSync(join(__dirname, 'rusty-enet.freebsd-x64.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./rusty-enet.freebsd-x64.node')
+      } else {
+        nativeBinding = require('@neko-net/rusty-enet-freebsd-x64')
+      }
+    } catch (e) {
+      loadError = e
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'rusty-enet.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./rusty-enet.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('@neko-net/rusty-enet-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'rusty-enet.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./rusty-enet.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('@neko-net/rusty-enet-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'rusty-enet.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./rusty-enet.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('@neko-net/rusty-enet-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'rusty-enet.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./rusty-enet.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('@neko-net/rusty-enet-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'rusty-enet.linux-arm-musleabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./rusty-enet.linux-arm-musleabihf.node')
+            } else {
+              nativeBinding = require('@neko-net/rusty-enet-linux-arm-musleabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'rusty-enet.linux-arm-gnueabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./rusty-enet.linux-arm-gnueabihf.node')
+            } else {
+              nativeBinding = require('@neko-net/rusty-enet-linux-arm-gnueabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'riscv64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'rusty-enet.linux-riscv64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./rusty-enet.linux-riscv64-musl.node')
+            } else {
+              nativeBinding = require('@neko-net/rusty-enet-linux-riscv64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'rusty-enet.linux-riscv64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./rusty-enet.linux-riscv64-gnu.node')
+            } else {
+              nativeBinding = require('@neko-net/rusty-enet-linux-riscv64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 's390x':
+        localFileExisted = existsSync(
+          join(__dirname, 'rusty-enet.linux-s390x-gnu.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rusty-enet.linux-s390x-gnu.node')
+          } else {
+            nativeBinding = require('@neko-net/rusty-enet-linux-s390x-gnu')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Linux: ${arch}`)
+    }
+    break
+  default:
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError
+  }
+  throw new Error(`Failed to load native binding`)
+}
+
+const { PacketKind, EventType, PeerState, EnetHost } = nativeBinding
+
+module.exports.PacketKind = PacketKind
+module.exports.EventType = EventType
+module.exports.PeerState = PeerState
+module.exports.EnetHost = EnetHost

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@neko-net/rusty-enet",
+  "version": "0.1.3",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/neko-net/rusty_enet_napi.git"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "napi": {
+    "name": "rusty-enet",
+    "triples": {
+      "defaults": false,
+      "additional": [
+        "x86_64-unknown-linux-gnu",
+        "aarch64-unknown-linux-gnu",
+        "x86_64-pc-windows-msvc",
+        "aarch64-pc-windows-msvc",
+        "aarch64-apple-darwin"
+      ]
+    }
+  },
+  "scripts": {
+    "build": "napi build --release",
+    "build:debug": "napi build",
+    "test": "node --test tests/*.test.js",
+    "artifacts": "napi artifacts"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "^2.18.4"
+  },
+  "optionalDependencies": {
+    "@neko-net/rusty-enet-linux-x64-gnu": "0.1.3",
+    "@neko-net/rusty-enet-linux-arm64-gnu": "0.1.3",
+    "@neko-net/rusty-enet-win32-x64-msvc": "0.1.3",
+    "@neko-net/rusty-enet-win32-arm64-msvc": "0.1.3",
+    "@neko-net/rusty-enet-darwin-arm64": "0.1.3"
+  }
+}