KH2: Reduce unnecessary packets sent/requested by the client #4035
+17
−12
Conversation
This file contains 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
The client does not have any special handling of the SetReply messages that would be received from the server in response to sending Set messages with want_reply=True.
finishedGame() now reads ctx.sending directly instead of reading it from `message[0]["locations"]`.
github-actions
bot
added
the
waiting-on: peer-review
Exempt-Medic
added
waiting-on: world-maintainer
palex00
approved these changes
Oct 8, 2024
Exempt-Medic
removed
the
waiting-on: peer-review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What is this fixing or adding?
While connected to the game and AP server, the KH2 client would send both a
Setmessage (for storing the current world int) and aLocationChecksmessage every 0.5 seconds, even if the value in theSetmessage was unchanged or if there were no newly checked locations to send to the server.The
Setmessage behaviour was identified from the PopTracker package that was listening to updates to the key via aSetNotifymessage, which would receive messages multiple times a second. ThisSetmessage was also requesting a reply from the server (SetReply), but not doing anything with this reply.The
LocationChecksmessage behaviour has only been identified by reading the code.This patch changes the client to only send the
Setmessage when the value to set changes and to only send theLocationChecksmessage when there are locations to send. TheSetmessage also no longer requests a reply from the server.Because the
LocationChecksmessage is no longer always created, thefinishedGame()function now readsctx.sendingdirectly rather than reading it from the create message.How was this tested?
It has not been tested because I do not own KH2.