Move Server Protocol to livesplit-core
#932
Merged
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
This moves the server protocol to `livesplit-core` and improves on it in various ways: - The protocol is based on JSON messages. This allows for example for more structured commands where it's easier to provide multiple arguments for a command and even have optional arguments. - For each command, there is a corresponding response. It is either a `success` response with possibly the value that you requested, or an `error` response with an error `code`. - On top of the responses you also get sent `event` messages that indicate changes to the timer. These can either be changes triggered via a command that you sent or by changes that happened through other sources, such as the user directly interacting with the timer or an auto splitter. The protocol is still work in progress and we will evolve it into a protocol that fully allows synchronizing timers over the network. The event sink has now been renamed to command sink, because there is now a clear distinction between incoming commands and events that are the results of these commands. Changelog: The protocol used for the server connection has been significantly improved. There is a response for each command and clear errors when something goes wrong. Additionally, there are now event messages that indicate changes to the timer.
CryZe
added
the
enhancement
CryZe
changed the title
livesplit-corelivesplit-core
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.
This moves the server protocol to
livesplit-coreand improves on it in various ways:successresponse with possibly the value that you requested, or anerrorresponse with an errorcode.eventmessages that indicate changes to the timer. These can either be changes triggered via a command that you sent or by changes that happened through other sources, such as the user directly interacting with the timer or an auto splitter.The protocol is still work in progress and we will evolve it into a protocol that fully allows synchronizing timers over the network.
The event sink has now been renamed to command sink, because there is now a clear distinction between incoming commands and events that are the results of these commands.
Changelog: The protocol used for the server connection has been significantly improved. There is a response for each command and clear errors when something goes wrong. Additionally, there are now event messages that indicate changes to the timer.