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

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 Receive(out hostId: int, out connectionId: int, out channelId: int, buffer: byte[], bufferSize: int, out receivedSize: int, out error: byte): Networking.NetworkEventType;
public static Networking.NetworkEventType Receive(out int hostId, out int connectionId, out int channelId, byte[] buffer, int bufferSize, out int receivedSize, out byte error);

Parameters

hostId id of udp socket where event happened.
connectionId Device connected to.
channelId Channel id for data event.
buffer Data received over the network.
bufferSize Buffer size.
receivedSize Actually received length.
error Possible returned error.

Returns

NetworkEventType Type of event returned from Receive().

Description

Deliver network events to user.

The API process received data returned in the connection. The data is returned in the buffer argument, with the number of bytes permitted set by the bufferSize argument. The exact number of bytes returned is set in receivedSize.

kConnectionEvent will notify about new connection established, kDisconnectEvent will report about disconnection happened, kDataEvent will report about new information delivered.

See Connect for a code example.