Skip to content

Document Networking Messages state-change events #191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DiasFranciscoA merged 1 commit into from
Sep 3, 2026
Merged

Document Networking Messages state-change events #191

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/networking_messages.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
*
* * `steam_net_message_on_session_request`
* * `steam_net_message_on_session_failed`
*
* Networking Messages establishes its underlying connections implicitly. Those connections can also emit `steam_net_message_on_state_change` events through the extension's shared Networking Sockets connection-status callback. That callback is separate from the callbacks registered by this function.
*
* @returns {bool}
*
Expand Down Expand Up @@ -40,6 +42,16 @@
* @member {string} description Debug description. This includes the connection handle, connection type (and peer information), and the app name. This string is used in various internal logging messages.
* @member {string} debug Human-readable, but non-localized explanation for connection termination or problem. This is intended for debugging / diagnostic purposes only, not to display to users. It might have some details specific to the issue.
* @event_end
*
* @event steam
* @desc This event is triggered whenever a connection established implicitly by Networking Messages is created, destroyed, or changes state. It is emitted by the extension's shared Networking Sockets connection-status callback.
* @member {string} event_type The string `"steam_net_message_on_state_change"`
* @member {real} connection The connection handle
* @member {constant.steam_net_connection_state} state The current state
* @member {constant.steam_net_connection_state} old_state The previous state
* @member {real} end_reason The end reason (one of [ESteamNetConnectionEnd](https://partner.steamgames.com/doc/api/steamnetworkingtypes#ESteamNetConnectionEnd))
* @member {string} debug A debug message
* @event_end
*
* @func_end
*/
Expand Down Expand Up @@ -188,4 +200,4 @@
* @section_end
*
* @module_end
*/
*/