Version: 5.5 (switch to 5.6b)
LanguageEnglish
  • C#
  • JS

Script language

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

NetworkTransport.AddWebsocketHost

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 static function AddWebsocketHost(topology: Networking.HostTopology, port: int): int;
public static int AddWebsocketHost(Networking.HostTopology topology, int port);
public static function AddWebsocketHost(topology: Networking.HostTopology, port: int, ip: string = null): int;
public static int AddWebsocketHost(Networking.HostTopology topology, int port, string ip = null);

Parameters

port Port to bind to.
topology The HostTopology associated with the host.
ip IP address to bind to.

Returns

int Web socket host id.

Description

Created web socket host.

This function is only supported for the Editor and Standalone Player on Windows, Linux and macOS. Topology is used to define how many clients can connect, and how many messages should be preallocated in the send and receive pool. All other parameters are ignored.