TCPServer

继承: RefCounted < Object

A TCP server.

描述

A TCP server. Listens to connections on a port and returns a StreamPeerTCP when it gets an incoming connection.

Note: When exporting to Android, make sure to enable the INTERNET permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android.

方法

intget_local_port ( ) const1
boolis_connection_available ( ) const1
boolis_listening ( ) const1
Errorlisten ( port: int, bind_address: String = "*" )
voidstop ( )
StreamPeerTCPtake_connection ( )

方法说明

int get_local_port ( ) const1

Returns the local port this server is listening to.


bool is_connection_available ( ) const1

Returns true if a connection is available for taking.


bool is_listening ( ) const1

Returns true if the server is currently listening for connections.


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

Listen on the port binding to bind_address.

If bind_address is set as "*" (default), the server will listen on all available addresses (both IPv4 and IPv6).

If bind_address is set as "0.0.0.0" (for IPv4) or "::" (for IPv6), the server will listen on all available addresses matching that IP type.

If bind_address is set to any valid address (e.g. "192.168.1.101", "::1", etc.), the server will only listen on the interface with that address (or fail if no interface with the given address exists).


void stop ( )

Stops listening.


StreamPeerTCP take_connection ( )

If a connection is available, returns a StreamPeerTCP with the connection.

2

本方法通常需要用户覆盖才能生效。

1

本方法无副作用,不会修改该实例的任何成员变量。

3

本方法除了能接受在此处描述的参数外,还能够继续接受任意数量的参数。

4

本方法用于构造某个类型。

5

调用本方法无需实例,可直接使用类名进行调用。

6

本方法描述的是使用本类型作为左操作数的有效运算符。

7

这个值是由下列位标志构成位掩码的整数。

8

无返回值。