Skip to content

docs: NetworkConfig.ClientConnectionBufferTimeout [skip ci] #1927

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.

Sign up for GitHub

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
JesseOlmer merged 3 commits into from
May 5, 2022
Merged

docs: NetworkConfig.ClientConnectionBufferTimeout [skip ci] #1927

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5f2d358
docs: NetworkConfig.ClientConnectionBufferTimeout
May 3, 2022
685c57d
docs: ClientConnectionBufferTimeout
May 5, 2022
0a6c009
Merge branch 'develop' into docs/clientconnectiontimeout
May 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions com.unity.netcode.gameobjects/Runtime/Configuration/NetworkConfig.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,18 @@ public class NetworkConfig
public uint TickRate = 30;

/// <summary>
/// The amount of seconds to wait for handshake to complete before timing out a client
/// The amount of seconds for the server to wait for the connection approval handshake to complete before the client is disconnected.
///
Copy link
Copy Markdown
Contributor

@SamuelBellomo SamuelBellomo May 4, 2022

Choose a reason for hiding this comment

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

Suggested change
///
/// This could happen if for example you're calling external services to authenticate your users and those services timeout.

For users that never worked on connected games, this could help.

Copy link
Copy Markdown
Contributor Author

@JesseOlmer JesseOlmer May 5, 2022

Choose a reason for hiding this comment

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

This isn't the appropriate type of comment to add to a Summary section. I'll add some similar flavor to Remarks

/// If the timeout is reached before approval is completed the client will be disconnected.
/// </summary>
[Tooltip("The amount of seconds to wait for the handshake to complete before the client times out")]
/// <remarks>
/// The period begins after the <see cref="NetworkEvent.Connect"/> is received on the server.
/// The period ends once the server finishes processing a <see cref="ConnectionRequestMessage"/> from the client.
///
/// This setting is independent of any Transport-level timeouts that may be in effect.
Copy link
Copy Markdown
Contributor

@SamuelBellomo SamuelBellomo May 4, 2022

Choose a reason for hiding this comment

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

Suggested change
/// This setting is independent of any Transport-level timeouts that may be in effect.
/// This setting is independent of any Transport-level timeouts that may be in effect. To calculate the overall connection timeout for a player connecting to a server, add transport + buffer timeout.

Copy link
Copy Markdown
Contributor Author

@JesseOlmer JesseOlmer May 5, 2022

Choose a reason for hiding this comment

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

In the new draft there are already 3-4 other references to the Transport timeout so I don't feel this explicit calculation one is necessary. It's also not necessarily accurate depending on Transport implementations.

Copy link
Copy Markdown
Contributor

@SamuelBellomo SamuelBellomo May 5, 2022

Choose a reason for hiding this comment

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

How about something like "a player's total connection timeout would be influenced by both transport side (if any) and network manager side timeouts". It'd just help give the big picture to users, right now we're showing this as if they were two tech in silos.

///
/// This setting is server-side only.</remarks>
[Tooltip("The amount of seconds for the server to wait for the connection approval handshake to complete before the client is disconnected")]
public int ClientConnectionBufferTimeout = 10;

/// <summary>
Expand Down