Skip to content
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

Set timeout duration as optional argument #4050

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

AndreasWintherMoen
Copy link

What type of PR is this?

/kind cleanup

What this PR does / Why we need it:

Just a small change to add an optional timeoutSeconds argument instead of a hard-coded value in Connect method in Unity SDK. This allows users to set a custom timeout duration if they have a very specific setup that requires it. The default timeout is 30 seconds to ensure backward compatibility.

Copy link

google-cla bot commented Nov 26, 2024

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@github-actions github-actions bot added kind/cleanup Refactoring code, fixing up documentation, etc size/XS labels Nov 26, 2024
@AndreasWintherMoen
Copy link
Author

Fixed CLA. Not sure what other failing check is caused by.

@igooch
Copy link
Collaborator

igooch commented Nov 26, 2024

/gcbrun

@agones-bot
Copy link
Collaborator

Build Succeeded 🥳

Build Id: 9c564924-79d7-4619-8422-2c072a84f252

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4050/head:pr_4050 && git checkout pr_4050
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.46.0-dev-4f3ac39

@gongmax
Copy link
Collaborator

gongmax commented Nov 27, 2024

Hi @AndreasWintherMoen , thanks for contribution! Would you mind add some description to the doc here for the change? Thanks!

@igooch
Copy link
Collaborator

igooch commented Dec 2, 2024

/gcbrun

@agones-bot
Copy link
Collaborator

Build Succeeded 🥳

Build Id: f72c2663-8efe-4435-bbce-6c5f3c25ceb3

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4050/head:pr_4050 && git checkout pr_4050
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.46.0-dev-5cad439

Copy link
Collaborator

@igooch igooch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Changes requested below, missing expiry / publish versions on the documentation (otherwise it immediately publishes to the website).

@igooch igooch enabled auto-merge (squash) December 6, 2024 22:15
@igooch
Copy link
Collaborator

igooch commented Dec 6, 2024

/gcbrun

@agones-bot
Copy link
Collaborator

Build Failed 😭

Build Id: 3a01af20-2153-44ab-be27-c1d4a3b83af3

Status: FAILURE

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

@@ -82,8 +82,8 @@ var agones = agonesGameObject.GetComponent<Agones.AgonesSdk>();
```

To connect to the SDK server, either local or when running on Agones, run the async `Connect()` method.
This will wait for up to 30 seconds if the SDK server has not yet started and the connection cannot be made,
and will return `false` if there was an issue connecting.
By default, this will wait for up to 30 seconds if the SDK server has not yet started and the connection cannot be made. You can specify an optional timeout duration argument to the method, e.g., Connect(60) for a 60-second timeout.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should add feature expiry around the deleted lines, and publish version around the new lines.

{{% feature expiryVersion="1.46.0" %}}
{{% /feature %}}
publish='{{% feature publishVersion="1.46.0" %}}'
{{% /feature %}}

@markmandel
Copy link
Collaborator

Super late to the party on this PR, but I'll ask the question: why? 😄 we've used 30s everywhere else, seems strange to deviate in one place without a pretty strong reason.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/cleanup Refactoring code, fixing up documentation, etc size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants