StreamPeerTCP

继承： StreamPeer < RefCounted < Object

A stream peer that handles TCP connections.

描述

A stream peer that handles TCP connections. This object can be used to connect to TCP servers, or also is returned by a TCP server.

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.

方法
Errorbind ( port: int, host: String = "*" )
Errorconnect_to_host ( host: String, port: int )
voiddisconnect_from_host ( )
Stringget_connected_host ( ) const1
intget_connected_port ( ) const1
intget_local_port ( ) const1
Statusget_status ( ) const1
Errorpoll ( )
voidset_no_delay ( enabled: bool )

枚举

enum Status:

Status STATUS_NONE = 0

The initial status of the StreamPeerTCP. This is also the status after disconnecting.

Status STATUS_CONNECTING = 1

A status representing a StreamPeerTCP that is connecting to a host.

Status STATUS_CONNECTED = 2

A status representing a StreamPeerTCP that is connected to a host.

Status STATUS_ERROR = 3

A status representing a StreamPeerTCP in error state.

方法说明

Error bind ( port: int, host: String = "*" )

Opens the TCP socket, and binds it to the specified local address.

This method is generally not needed, and only used to force the subsequent call to connect_to_host to use the specified host and port as source address. This can be desired in some NAT punchthrough techniques, or when forcing the source network interface.

Error connect_to_host ( host: String, port: int )

Connects to the specified host:port pair. A hostname will be resolved if valid. Returns @GlobalScope.OK on success.

void disconnect_from_host ( )

Disconnects from host.

String get_connected_host ( ) const1

Returns the IP of this peer.

int get_connected_port ( ) const1

Returns the port of this peer.

int get_local_port ( ) const1

Returns the local port to which this peer is bound.

Status get_status ( ) const1

Returns the status of the connection, see Status.

Error poll ( )

Poll the socket, updating its state. See get_status.

void set_no_delay ( enabled: bool )

If enabled is true, packets will be sent immediately. If enabled is false (the default), packet transfers will be delayed and combined using Nagle's algorithm.

Note: It's recommended to leave this disabled for applications that send large packets or need to transfer a lot of data, as enabling this can decrease the total available bandwidth.

2

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

1

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

3

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

4

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

5

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

6

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

7

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

8

无返回值。