Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

TCPServer

继承: RefCounted < Object

TCP 服务器。

描述

TCP 服务器。监听端口上的连接,并在获得传入连接时返回 StreamPeerTCP

注意:导出到安卓时,在导出项目或使用一键部署之前,请务必在安卓导出预设中开启 INTERNET 权限。否则 Android 会阻止任何形式的网络通信。

方法

int

get_local_port() const

bool

is_connection_available() const

bool

is_listening() const

Error

listen(port: int, bind_address: String = "*")

void

stop()

StreamPeerTCP

take_connection()


方法说明

int get_local_port() const 🔗

返回该服务器正在监听的本地端口。


bool is_connection_available() const 🔗

如果有连接可供获取,则返回 true


bool is_listening() const 🔗

如果服务器当前正在侦听连接,则返回 true


Error listen(port: int, bind_address: String = "*") 🔗

port 上监听与 bind_address 绑定的地址。

如果 bind_address 被设置为 "*"(默认),该服务器将监听所有可用地址(包括 IPv4 和 IPv6)。

如果 bind_address 被设置为 "0.0.0.0"(用于 IPv4)或 "::"(用于 IPv6),该服务器将监听所有符合该 IP 类型的可用地址。

如果 bind_address 被设置为任何有效的地址(如 "192.168.1.101""::1" 等),该服务器将只在具有该地址的接口上监听(如果不存在具有该地址的接口则失败)。


void stop() 🔗

停止监听。


StreamPeerTCP take_connection() 🔗

如果连接可用,则返回带有该连接的 StreamPeerTCP。