Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

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

NetworkTransport.AddHostWithSimulator

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 method AddHostWithSimulator(topology: Networking.HostTopology, minTimeout: int, maxTimeout: int, port: int = 0, ip: string = null): int;
public static int AddHostWithSimulator(Networking.HostTopology topology, int minTimeout, int maxTimeout, int port = 0, string ip = null);

Parameters

topologyThe HostTopology associated with the host.
minTimeoutMinimum simulated delay in milliseconds.
maxTimeoutMaximum simulated delay in milliseconds.
portPort to bind to (when 0 is selected, the OS will choose a port at random).
ipIP address to bind to.

Returns

int Returns host ID just created.

Description

Create a host and configure them to simulate Internet latency (works on Editor and development build only).

An optional host IP address can be provided. This is usually useful on machines where multiple Ethernet cards are available. The simulated latency will vary according to exponential distribution.

#pragma strict
public class AddHostExample extends MonoBehaviour {
    var channelId: int;
    var hostId: int;
    function Start() {
        // Init Transport using default values.
        NetworkTransport.Init();
        // Create a connection_config and add a Channel.
        var connection_config: ConnectionConfig = new ConnectionConfig();
        channelId = connection_config.AddChannel(QosType.Reliable);
        // Create a topology based on the connection config.
        var topology: HostTopology = new HostTopology(connection_config, 10);
        // Create a host based on the topology we just created, set the delay between 10ms and 200ms, finally bind the socket to port 12345.
        hostId = NetworkTransport.AddHostWithSimulator(topology, 10, 200, 12345, "127.0.0.1");
    }
}
using UnityEngine;
using UnityEngine.Networking;

public class AddHostExample : MonoBehaviour { int channelId; int hostId; void Start() { // Init Transport using default values. NetworkTransport.Init();

// Create a connection_config and add a Channel. ConnectionConfig connection_config = new ConnectionConfig(); channelId = connection_config.AddChannel(QosType.Reliable);

// Create a topology based on the connection config. HostTopology topology = new HostTopology(connection_config, 10);

// Create a host based on the topology we just created, set the delay between 10ms and 200ms, finally bind the socket to port 12345. hostId = NetworkTransport.AddHostWithSimulator(topology, 10, 200, 12345, "127.0.0.1"); } }