Version: 2017.3

NetworkClient

class in UnityEngine.Networking

切换到手册

描述

This is a network client class used by the networking system. It contains a NetworkConnection that is used to connection to a network server.

The NetworkClient handle connection state, messages handlers, and connection configuration. There can be many NetworkClient instances in a process at a time, but only one that is connected to a game server (NetworkServer) that uses spawned objects.

NetworkClient has an internal update function where it handles events from the transport layer. This includes asynchronous connect events, disconnect events and incoming data from a server.

The NetworkManager has a NetworkClient instance that it uses for games that it starts, but the NetworkClient may be used by itself.

静态变量

active如果网络客户端当前处于活动状态,则为 true。
allClients当前进程中处于活动状态的所有网络客户端的列表。

变量

connection此客户端正在使用的 NetworkConnection 对象。
handlers已注册的网络消息处理程序。
hostPort网络客户端用于连接到服务器的本地端口。
hostTopology此客户端正在使用的主机拓扑。
isConnected该属性提供客户端的当前连接状态。
networkConnectionClass创建新 NetworkConnection 时要使用的类。
numChannels当前为此客户端配置的 QoS 通道数量。
serverIp此客户端连接到的服务器的 IP 地址。
serverPort此客户端连接到的服务器的端口。

构造函数

NetworkClient创建新 NetworkClient 实例。

公共函数

Configure此方法配置客户端的传输层设置。
Connect将客户端连接到 NetworkServer 实例。
ConnectWithSimulator使用模拟延迟和丢包将客户端连接到 NetworkServer 实例。
Disconnect断开与服务器的连接。
GetConnectionStats检索有关此连接上发送的网络数据包的统计信息。
GetRTT获取此连接的返程时间。
GetStatsIn获取客户端的入站网络统计信息。
GetStatsOut获取客户端的出站网络统计信息。
ReconnectToNewHost该方法供失去与旧主机的连接的客户端使用,以重新连接到游戏的新主机。
RegisterHandler为特定消息类型注册处理程序。
ResetConnectionStats将 NetworkClient.GetConnectionStats() 返回的统计信息重置为 0。
Send该方法会向服务器发送带有消息 ID 的网络消息。此消息在通道 0 上发送,该通道默认为可靠通道。
SendByChannel该方法会在指定通道上向服务器发送带有消息 ID 的网络消息。
SendBytes该方法会将数据以字节数组的形式发送到客户端连接到的服务器。
SendUnreliable该方法会在通道 1 上向服务器发送带有消息 ID 的网络消息,该通道默认为不可靠通道。
SendWriter这会将 NetworkWriter 缓冲区的内容发送到指定通道上的连接服务器。
SetMaxDelay设置允许传输发送缓冲区的最长时间。
SetNetworkConnectionClass该方法设置创建新网络连接时使用的类。
Shutdown关闭客户端。
UnregisterHandler取消注册网络消息处理程序。

静态函数

GetTotalConnectionStats检索有关所有连接上发送的网络数据包的统计信息。
ShutdownAll关闭所有网络客户端。