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.
STATUS_NONE = 0
The initial status of the StreamPeerTCP. This is also the status after disconnecting.
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.
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.
Connects to the specified host:port
pair. A hostname will be resolved if valid. Returns @GlobalScope.OK on success.
Disconnects from host.
Returns the IP of this peer.
Returns the port of this peer.
Returns the local port to which this peer is bound.
Returns the status of the connection, see Status.
Poll the socket, updating its state. See get_status().
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.