Add modern Steam networking APIs

Author: raub

README.md

@@ -239,6 +239,10 @@ call results, so keep pumping callbacks with `steam.runCallbacks()` or
 `{ data, steamIdRemote, messageSize }`. The requested read size is capped to
 avoid unbounded native allocation.
 
+`networking.sockets` and `networking.messages` expose Steam's modern P2P APIs;
+see [Modern P2P networking](docs/api/networking-modern.md). They are separate
+from the legacy `networking` namespace so existing applications remain stable.
+
 `cloud`:
 
 - `cloud.saveTextToFile(fileName, content)`

docs/api/README.md

@@ -24,6 +24,7 @@ promise completion, callback delivery, and convenience helpers.
 | `friends` | [Friends and presence](friends.md) | [ISteamFriends](https://partner.steamgames.com/doc/api/ISteamFriends) |
 | `matchmaking` | [Lobbies](matchmaking.md) | [ISteamMatchmaking](https://partner.steamgames.com/doc/api/ISteamMatchmaking) |
 | `networking` | [Legacy P2P networking](networking.md) | [ISteamNetworking](https://partner.steamgames.com/doc/api/ISteamNetworking) |
+| `networking.sockets`, `networking.messages` | [Modern P2P networking](networking-modern.md) | [ISteamNetworkingSockets](https://partner.steamgames.com/doc/api/ISteamNetworkingSockets), [ISteamNetworkingMessages](https://partner.steamgames.com/doc/api/ISteamNetworkingMessages) |
 | `cloud` | [Cloud files](cloud.md) | [ISteamRemoteStorage](https://partner.steamgames.com/doc/api/ISteamRemoteStorage) |
 | `ugc` | [Workshop and UGC](ugc.md) | [ISteamUGC](https://partner.steamgames.com/doc/api/ISteamUGC) |
 | `userStats` | [Stats and achievements](user-stats.md) | [ISteamUserStats](https://partner.steamgames.com/doc/api/ISteamUserStats) |

docs/api/networking-modern.md

@@ -0,0 +1,32 @@
+# Modern P2P networking
+
+Official references: [ISteamNetworkingSockets](https://partner.steamgames.com/doc/api/ISteamNetworkingSockets) and [ISteamNetworkingMessages](https://partner.steamgames.com/doc/api/ISteamNetworkingMessages).
+
+`networking.sockets` is the modern connection-oriented API. Create a P2P listen
+socket with `createListenSocketP2P()`, connect with `connectP2P()`, accept
+incoming connection handles with `acceptConnection()`, and use the connection
+handle to send or receive messages. `networking.messages` is the modern
+connectionless API: use `sendMessageToUser()` and poll a local channel with
+`receiveMessagesOnChannel()`.
+
+Both interfaces use decimal-string Steam IDs and Node.js `Buffer` payloads.
+Received messages are copied into JavaScript and released by the binding before
+they are returned. Reads accept at most 256 messages per call; sent messages
+cannot exceed Steam's 512 KiB maximum. Send flags and result values are the
+numeric Steamworks constants.
+
+```ts
+import { networking } from '@node-3d/steam-api';
+
+networking.messages.sendMessageToUser(peer, Buffer.from('hello'));
+for (const message of networking.messages.receiveMessagesOnChannel()) {
+	console.log(message.steamIdRemote, message.data.toString());
+}
+```
+
+The socket API reports connection state through Steam callbacks. Keep pumping
+`update()` and call `acceptConnection()` promptly for incoming connections.
+`update()` reports `networking-connection-status-changed` with `connection`,
+`oldState`, `state`, `steamIdRemote`, and `endReason`. The messages API reports
+`networking-messages-session-request` (accept it with `acceptSessionWithUser()`)
+and `networking-messages-session-failed`.

examples/visual/README.md

@@ -1,6 +1,6 @@
 import { install } from '@node-3d/addon-tools';
 
 const prefix = 'https://github.com/node-3d/steam-api/releases/download';
-const tag = '0.3.0';
+const tag = '0.4.0';
 
 await install(`${prefix}/${tag}`);

install.js

@@ -1,7 +1,7 @@
 {
 	"author": "Luis Blanco <luisblanco1337@gmail.com>",
 	"name": "@node-3d/steam-api",
-	"version": "0.3.0",
+	"version": "0.4.0",
 	"description": "Steamworks API bindings for Node.js",
 	"license": "MIT",
 	"main": "dist/index.js",

package-lock.json

@@ -39,7 +39,10 @@ Napi::Object initModule(Napi::Env env, Napi::Object exports) {
 	exports.Set("apps", steam_api::apps::createNamespace(env));
 	exports.Set("friends", steam_api::friends::createNamespace(env));
 	exports.Set("matchmaking", steam_api::matchmaking::createNamespace(env));
-	exports.Set("networking", steam_api::networking::createNamespace(env));
+	Napi::Object networking = steam_api::networking::createNamespace(env);
+	networking.Set("sockets", steam_api::networking::createSocketsNamespace(env));
+	networking.Set("messages", steam_api::networking::createMessagesNamespace(env));
+	exports.Set("networking", networking);
 	exports.Set("cloud", steam_api::cloud::createNamespace(env));
 	exports.Set("ugc", steam_api::ugc::createNamespace(env));
 	exports.Set("userStats", steam_api::user_stats::createNamespace(env));

package.json

@@ -134,6 +134,9 @@ class CallbackBridge {
 		    this, &CallbackBridge::onFloatingGamepadTextInputDismissed
 		);
 		_downloadItemResult.Register(this, &CallbackBridge::onDownloadItemResult);
+		_connectionStatusChanged.Register(this, &CallbackBridge::onConnectionStatusChanged);
+		_messagesSessionRequest.Register(this, &CallbackBridge::onMessagesSessionRequest);
+		_messagesSessionFailed.Register(this, &CallbackBridge::onMessagesSessionFailed);
 		_isRegistered = true;
 	}
 
@@ -171,6 +174,9 @@ class CallbackBridge {
 		_newUrlLaunchParameters.Unregister();
 		_floatingGamepadTextInputDismissed.Unregister();
 		_downloadItemResult.Unregister();
+		_connectionStatusChanged.Unregister();
+		_messagesSessionRequest.Unregister();
+		_messagesSessionFailed.Unregister();
 		_isRegistered = false;
 		_events.clear();
 	}
@@ -417,6 +423,36 @@ class CallbackBridge {
 		_events.push_back(event);
 	}
 
+	void onConnectionStatusChanged(SteamNetConnectionStatusChangedCallback_t *param) {
+		Event event = makeEventData("networking-connection-status-changed");
+		event.fields.push_back(makeInt32Field("connection", param->m_hConn));
+		event.fields.push_back(makeInt32Field("oldState", param->m_eOldState));
+		event.fields.push_back(makeInt32Field("state", param->m_info.m_eState));
+		event.fields.push_back(
+		    makeUint64StringField("steamIdRemote", param->m_info.m_identityRemote.GetSteamID64())
+		);
+		event.fields.push_back(makeInt32Field("endReason", param->m_info.m_eEndReason));
+		_events.push_back(event);
+	}
+
+	void onMessagesSessionRequest(SteamNetworkingMessagesSessionRequest_t *param) {
+		Event event = makeEventData("networking-messages-session-request");
+		event.fields.push_back(
+		    makeUint64StringField("steamIdRemote", param->m_identityRemote.GetSteamID64())
+		);
+		_events.push_back(event);
+	}
+
+	void onMessagesSessionFailed(SteamNetworkingMessagesSessionFailed_t *param) {
+		Event event = makeEventData("networking-messages-session-failed");
+		event.fields.push_back(
+		    makeUint64StringField("steamIdRemote", param->m_info.m_identityRemote.GetSteamID64())
+		);
+		event.fields.push_back(makeInt32Field("state", param->m_info.m_eState));
+		event.fields.push_back(makeInt32Field("endReason", param->m_info.m_eEndReason));
+		_events.push_back(event);
+	}
+
 	bool _isRegistered = false;
 	std::vector<Event> _events;
 	CCallbackManual<CallbackBridge, UserStatsReceived_t> _userStatsReceived;
@@ -448,6 +484,9 @@ class CallbackBridge {
 	CCallbackManual<CallbackBridge, NewUrlLaunchParameters_t> _newUrlLaunchParameters;
 	CCallbackManual<CallbackBridge, FloatingGamepadTextInputDismissed_t> _floatingGamepadTextInputDismissed;
 	CCallbackManual<CallbackBridge, DownloadItemResult_t> _downloadItemResult;
+	CCallbackManual<CallbackBridge, SteamNetConnectionStatusChangedCallback_t> _connectionStatusChanged;
+	CCallbackManual<CallbackBridge, SteamNetworkingMessagesSessionRequest_t> _messagesSessionRequest;
+	CCallbackManual<CallbackBridge, SteamNetworkingMessagesSessionFailed_t> _messagesSessionFailed;
 };
 
 std::unique_ptr<CallbackBridge> callbackBridge;