Legacy Documentation: Version 5.2
LanguageEnglish
  • C#
  • JS

Script language

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

NetworkConnection

class in UnityEngine.Networking

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

Switch to Manual

Description

High level network connection.

Variables

addressThe IP address associated with the connection.
clientOwnedObjectsA list of the NetworkIdentity objects owned by this connection.
connectionIdUnique identifier for this connection.
hostIdTransport level host id for this connection.
isReadyFlag that tells if the connection has been marked as "ready" by a client calling ClientScene.Ready().
lastMessageTimeThe last time that a message was received on this connection.
logNetworkMessagesSetting this to true will log the contents of network message to the console.
playerControllersThe list of players for this connection.
Networking.NetworkConnectionSetting this to true will log the contents of network packets to the console.

Public Functions

DisconnectDisconnects this connection.
DisposeDisposes of this connection, releasing channel buffers that it holds.
FlushChannelsThis causes the channels of the network connection to flush their data to the transport layer.
GetStatsInGet statistics for incoming traffic.
GetStatsOutGet statistics for outgoing traffic.
HandleBytesThis makes the connection process the data contained in the buffer, and call handler functions.
HandleReaderThis makes the connection process the data contained in the stream, and call handler functions.
InitializeThis inializes the internal data structures of a NetworkConnection object, including channel buffers.
InvokeHandlerThis function invokes the registered handler function for a message.
InvokeHandlerNoDataThis function invokes the registered handler function for a message, without any message data.
RegisterHandlerThis registers a handler function for a message Id.
ResetStatsResets the statistics that are returned from NetworkClient.GetConnectionStats().
SendThis sends a network message with a message Id on the connection. This message is sent on channel zero, which be default is the reliable channel.
SendByChannelThis sends a network message on the connection using a specific transport layer channel.
SendBytesThis sends an array of bytes on the connection.
SendUnreliableThis sends a network message with a message Id on the connection. This message is sent on channel one, which be default is the un-reliable channel.
SendWriterThis sends the contents of a NetworkWriter object on the connection.
SetChannelOptionThis sets an option on the network channel.
SetMaxDelayThe maximum time in seconds that messages are buffered before being sent.
ToStringReturns a string representation of the NetworkConnection object state.
TransportRecieveThis virtual function allows custom network connection classes to process data from the network before it is passed to the application.
TransportSendThis virtual function allows custom network connection classes to process data send by the application before it goes to the network transport layer.
UnregisterHandlerThis removes the handler registered for a message Id.

Protected Functions

HandleBytesThis makes the connection process the data contained in the buffer, and call handler functions.
HandleReaderThis makes the connection process the data contained in the stream, and call handler functions.
Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961