Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

NetworkConnection.Initialize

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

public method Initialize(networkAddress: string, networkHostId: int, networkConnectionId: int, hostTopology: Networking.HostTopology): void;
public void Initialize(string networkAddress, int networkHostId, int networkConnectionId, Networking.HostTopology hostTopology);

Parameters

hostTopologyThe topology to be used.
networkAddressThe host or IP connected to.
networkHostIdThe transport hostId for the connection.
networkConnectionIdThe transport connectionId for the connection.

Description

This inializes the internal data structures of a NetworkConnection object, including channel buffers.

This is called by NetworkServer and NetworkClient on connection objects, but if used outside of that context, this function should be called before the connection is used.

This function can be overriden to perform additional initialization for the connection, but the base class Initialize function should always be called as it is required to setup internal state.