Legacy Documentation: Version 5.3
LanguageEnglish
  • C#
  • JS

Script language

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

NetworkTransport.Connect

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again 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 Connect(hostId: int, address: string, port: int, exeptionConnectionId: int, out error: byte): int;
public static int Connect(int hostId, string address, int port, int exeptionConnectionId, out byte error);

Parameters

hostId Host socket id for this connection.
address Ip4 address.
port Port.
exceptionConnectionId 0 in the case of a default connection.
error Possible error, kOK if it is good.

Returns

int ConnectionId on success (otherwise zero).

Description

Try to establish connection to another peer.

Set up a connection to allow access to the NetworkTransport device. Connect is needed prior to a Receive() connection. The error parameter will return a non-kOK value if an error occurs. A connectionId will return with a unique identifier for the host connection.

If any problem occurs Receive() will signal that the connection cannot be established.

The example code shows how to connect to the NetworkTransport and Receive data.

var connectionId = NetworkTransport.Connect(hostId, "10.10.01.17", 2355, 0, error );
if( error != kOk )
{ 
//cannot allocate resources for connection
}

//... var event = NetworkTransport.Receive(recHostId, recConnectionId, channelId, buffer, bufferSize, receivedSize, error ); if( event == kConnectEvent ) { if( recHostId == hostId && recConnectionId == connectionId && error == kOK ) ///connection can be used } if( event == kDisconnectEvent ) { if( recHostId == hostId && recConnectionId == connectionId ) { //connection which identified by connectionId cannot be established if( error == kVersionMismatch ) //treansport protocol is different else if( error == kCRCMismatch ) //peer has different network configuration else if( error == kTimeout ) //cannot connect to other peer in period of time, possible peer has not running } }