Skip to content

feat: Simpler relay data setters in the adapter #1609

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.

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
merged 4 commits into from
Jan 24, 2022

Conversation

simon-lemay-unity
Copy link
Contributor

MTT-1870

This addresses issue #1259. Basically the use SetRelayServerData is error-prone because it requires being called differently on hosts and clients. This PR introduces SetHostRelayData and SetClientRelayData to make this simpler. They're basically just wrappers around SetRelayServerData, but impose the correct usage depending on if you're a host or a client.

Even though they are meant to replace SetRelayServerData, I am not deprecating it since there is documentation referring to it. Once that PR is part of a released version, I will reach out to the team responsible for the relay documentation and work with them to update it to use the new methods. Once that is online, we'll be able to start the deprecation process for SetRelayServerData. I've entered MTT-2240 in JIRA to track this effort.

Changelog

com.unity.adapter.utp

  • Added new methods to set the relay server data: SetHostRelayData and SetClientRelayData. These are meant to be less error-prone than SetRelayServerData (which remains available).

Testing and Documentation

  • No tests have been added.
  • Documentation will need to be updated, although nothing is deprecated so no hurry there.

@0xFA11 0xFA11 merged commit 6b71c14 into develop Jan 24, 2022
@0xFA11 0xFA11 deleted the feat/simpler-relay-data-setters branch January 24, 2022 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants