Version: 2021.1
LanguageEnglish
  • C#
Method group is Obsolete

ConnectionConfig

class in UnityEngine.Networking

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Obsolete The UNET transport will be removed in the future as soon a replacement is ready.

Description

This class defines parameters of connection between two peers, this definition includes various timeouts and sizes as well as channel configuration.

The NetworkServer and NetworkClient classes can be configured with instances of this class. This causes the settings in the ConnectionConfig to be applied to the transport layer connection of the NetworkConnections owned by these objects.

The NetworkManager has a ConnectionConfig object that is used to configure servers and clients that it creates.

The default channel connection configuration used by the high level components of the networking system is: * channel 0 - Reliable Sequenced channel * channel 1 - Unreliable channel.

Some of the attributes of this ConnectionConfig instance can be modified using the Inspector UI for the NetworkManager in the Editor.

Important: Some parameters of ConnectionConfig should be exactly the same for connected peers. If they are different, a CRCMismatch error is received when trying to establish a connection.

These parameters are:

  • PacketSize
  • FragmentSize
  • ResendTimeout
  • DisconnectTimeout
  • ConnectTimeout
  • PingTimeout
  • ReducedPingTimeout
  • AllCostTimeout
  • IsAckLong
  • UsePlatformSpecificProtocols.