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.ConnectAsNetworkHost

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 ConnectAsNetworkHost(hostId: int, address: string, port: int, network: Networking.Types.NetworkID, source: Networking.Types.SourceID, node: Networking.Types.NodeID, out error: byte): void;
public static void ConnectAsNetworkHost(int hostId, string address, int port, Networking.Types.NetworkID network, Networking.Types.SourceID source, Networking.Types.NodeID node, out byte error);

Parameters

hostId Host id associated with this connection (Retrieved when calling NetworkTransport.AddHost).
address IPv4 address of the relay.
port Port of the relay.
network GUID for the relay match, retrieved by calling NetworkMatch.CreateMatch and using the MatchInfo.networkId.
source GUID for the source, can be retrieved by calling Utility.GetSourceID.
error Error (can be casted to NetworkError for more information).
node Slot id for this user, retrieved by calling NetworkMatch.CreateMatch and using the MatchInfo.nodeId.

Description

Create dedicated connection to Relay server.

Calling this function sets the connection as the owner of the network group on the Relay server. This client should call ReceiveRelayEventFromHost periodically to be notified about connection/disconnection events to/from Relay server.