W3cubDocs

/Godot 3.1

StreamPeerTCP

Inherits: StreamPeer < Reference < Object

Category: Core

Brief Description

TCP Stream peer.

Methods

Error connect_to_host ( String host, int port )
void disconnect_from_host ( )
String get_connected_host ( ) const
int get_connected_port ( ) const
Status get_status ( )
bool is_connected_to_host ( ) const
void set_no_delay ( bool enabled )

Enumerations

enum Status:

  • STATUS_NONE = 0 — The initial status of the StreamPeerTCP, also the status after a disconnect.
  • STATUS_CONNECTING = 1 — A status representing a StreamPeerTCP that is connecting to a host.
  • STATUS_CONNECTED = 2 — A status representing a StreamPeerTCP that is connected to a host.
  • STATUS_ERROR = 3 — A status representing a StreamPeerTCP in error state.

Description

TCP Stream peer. This object can be used to connect to TCP servers, or also is returned by a TCP server.

Method Descriptions

Error connect_to_host ( String host, int port )

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

void disconnect_from_host ( )

Disconnect from host.

String get_connected_host ( ) const

Returns the IP of this peer.

int get_connected_port ( ) const

Returns the port of this peer.

Status get_status ( )

Returns the status of the connection, see Status.

bool is_connected_to_host ( ) const

Returns true if this peer is currently connected to a host, false otherwise.

void set_no_delay ( bool enabled )

Disable Nagle algorithm to improve latency for small packets.

Note that for applications that send large packets, or need to transfer a lot of data, this can reduce total bandwidth.

© 2014–2019 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
http://docs.godotengine.org/en/3.1/classes/class_streampeertcp.html