[MLA-825] Add default values for SideChannel IncomingMessages methods #3751
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
added 3 commits
April 7, 2020 16:22
chriselion
commented
Apr 7, 2020
| /// <returns></returns> | ||
| public string ReadString() | ||
| public string ReadString(string defaultValue = default) |
There was a problem hiding this comment.
Should we default to "" instead?
chriselion
commented
Apr 7, 2020
| /// <returns></returns> | ||
| public IList<float> ReadFloatList() | ||
| public IList<float> ReadFloatList(IList<float> defaultValue = default) |
There was a problem hiding this comment.
Not sure if there's a better default here.
surfnerd
reviewed
Apr 8, 2020
Co-Authored-By: Chris Goy <goyenator@gmail.com>
vincentpierre
approved these changes
Apr 8, 2020
surfnerd
reviewed
Apr 8, 2020
Co-Authored-By: Chris Goy <christopherg@unity3d.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Proposed change(s)
To assist with backwards compatibility across side channels, this adds a default value when reading from IncomingMessages. This will let us add data to the messages in the future, but still allow reading from older versions.
Note that this only falls back to the default if it's at the end of the buffer. Trying to read an int when there's only 1 byte left will still raise/throw, but I think this is the correct behavior in that case.
Useful links (Github issues, JIRA tickets, ML-Agents forum threads etc.)
https://jira.unity3d.com/browse/MLA-825
Types of change(s)
Checklist
Other comments