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

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 ConnectToNetworkPeer(hostId: int, address: string, port: int, exceptionConnectionId: int, relaySlotId: int, network: Networking.Types.NetworkID, source: Networking.Types.SourceID, node: Networking.Types.NodeID, bytesPerSec: int, bucketSizeFactor: float, out error: byte): int;
public static int ConnectToNetworkPeer(int hostId, string address, int port, int exceptionConnectionId, int relaySlotId, Networking.Types.NetworkID network, Networking.Types.SourceID source, Networking.Types.NodeID node, int bytesPerSec, float bucketSizeFactor, out byte error);
public static function ConnectToNetworkPeer(hostId: int, address: string, port: int, exceptionConnectionId: int, relaySlotId: int, network: Networking.Types.NetworkID, source: Networking.Types.SourceID, node: Networking.Types.NodeID, out error: byte): int;
public static int ConnectToNetworkPeer(int hostId, string address, int port, int exceptionConnectionId, int relaySlotId, 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 IP address of the peer, retrieved by calling NetworkMatch.JoinMatch and using the MatchInfo.address.
port Port of the peer, retrieved by calling NetworkMatch.JoinMatch and using the MatchInfo.port.
exceptionConnectionId Set to 0 in the case of a default connection.
relaySlotId Id of the remote peer in relay.
network GUID for the relay match, retrieved by calling NetworkMatch.JoinMatch 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 reserved for the user, retrieved by calling NetworkMatch.JoinMatch and using the MatchInfo.nodeId.
bucketSizeFactor Allowed peak bandwidth (peak bandwidth = factor*bytesPerSec, recommended value is 2.0) If data has not been sent for a long time, it is allowed to send more data, with factor 2 it is allowed send 2*bytesPerSec bytes per sec.
bytesPerSec Average bandwidth (bandwidth will be throttled on this level).

Returns

int A unique connection identifier on success (otherwise zero).

Description

Create a connection to another peer in the Relay group.

Similar to NetworkTransport.Connect but using the Relay server.

Copyright © 2016 Unity Technologies. Publication 5.5-001B
Tutorials Community Answers Knowledge Base Forums Asset Store