Document Networking Messages state-change events - #191
Open
Infiland wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #188.
Networking Messages uses implicit connections, and the shared connection-status callback can emit steam_net_message_on_state_change for them. The Networking Messages page currently documents only the session request and failure callbacks, leaving users with an unexplained event.
This documents where the state-change event comes from, clarifies that it is separate from the callbacks registered by steam_net_messages_register_callbacks, and lists the event_type, connection, state, old_state, end_reason, and debug fields.
git diff --check and node --check passed, and every documented field was compared with the native event emitter and the existing Networking Sockets documentation.