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

Script language

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

NetworkTransport.ConnectToNetworkPeer

Other Versions
Leave feedback
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:

  • Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

    Copyright © 2018 Unity Technologies. Publication: 2018.1-002N. Built: 2018-12-04.
    TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information