Table of Contents

Class StreamPeerTCP

A stream peer that handles TCP connections.

Inheritance
StreamPeerTCP

Remarks

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.

Methods

bind(int, 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 StreamPeerTCP.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.

int bind(int port, String host)

Parameters

port int
host String

connect_to_host(String, int)

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

int connect_to_host(String host, int port)

Parameters

host String
port int

disconnect_from_host

Disconnects from host.

void disconnect_from_host

get_connected_host

Qualifiers: const

Returns the IP of this peer.

String get_connected_host

get_connected_port

Qualifiers: const

Returns the port of this peer.

int get_connected_port

get_local_port

Qualifiers: const

Returns the local port to which this peer is bound.

int get_local_port

get_status

Qualifiers: const

Returns the status of the connection, see Status.

int get_status

poll

Poll the socket, updating its state. See get_status.

int poll

set_no_delay(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.

void set_no_delay(bool enabled)

Parameters

enabled bool