StreamPeerTCP
Inherits: StreamPeerSocket < StreamPeer < Shared < Object
A stream peer that handles TCP connections.
Description
Section titled “Description”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
Section titled “Methods”| Returns | Method |
|---|---|
| Error | bind(port, host) |
| Error | connect_to_host(host, port) |
| String | get_connected_host() |
| int | get_connected_port() |
| int | get_local_port() |
| void | set_no_delay(enabled) |
Method descriptions
Section titled “Method descriptions”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.
connect_to_host
Section titled “connect_to_host”Error connect_to_host(host: String, port: int)
Connects to the specified host:port pair. A hostname will be resolved if valid. Returns OK on success.
get_connected_host
Section titled “get_connected_host”String get_connected_host() const
Returns the IP of this peer.
get_connected_port
Section titled “get_connected_port”int get_connected_port() const
Returns the port of this peer.
get_local_port
Section titled “get_local_port”int get_local_port() const
Returns the local port to which this peer is bound.
set_no_delay
Section titled “set_no_delay”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.