Legacy Documentation: Version 2018.2 (Go to current version)
LanguageEnglish
  • C#

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

hostIdHost ID associated with this connection (retrieved when calling NetworkTransport.AddHost).
addressIP address of the peer, retrieved by calling NetworkMatch.JoinMatch and using the MatchInfo.address.
portPort of the peer, retrieved by calling NetworkMatch.JoinMatch and using the MatchInfo.port.
exceptionConnectionIdSet to 0 in the case of a default connection.
relaySlotIdID of the remote peer in relay.
networkGUID for the relay match, retrieved by calling NetworkMatch.JoinMatch and using the MatchInfo.networkId.
sourceGUID for the source, can be retrieved by calling Utility.GetSourceID.
errorError (can be cast to NetworkError for more information).
nodeSlot ID reserved for the user, retrieved by calling NetworkMatch.JoinMatch and using the MatchInfo.nodeId.
bucketSizeFactorAllowed 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.
bytesPerSecAverage 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.

Did you find this page useful? Please give it a rating: