Inherits: StreamPeer < Reference < Object
TCP stream peer.
TCP stream peer. This object can be used to connect to TCP servers, or also is returned by a TCP server.
connect_to_host ( String host, int port )
get_connected_host ( ) const
get_connected_port ( ) const
get_status ( )
is_connected_to_host ( ) const
set_no_delay ( bool enabled )
STATUS_NONE = 0 --- The initial status of the
StreamPeerTCP. This is also the status after disconnecting.
STATUS_CONNECTING = 1 --- A status representing a
StreamPeerTCPthat is connecting to a host.
STATUS_CONNECTED = 2 --- A status representing a
StreamPeerTCPthat is connected to a host.
STATUS_ERROR = 3 --- A status representing a
StreamPeerTCPin error state.
Connects 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 ( )
Disconnects 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
true if this peer is currently connected or is connecting to a host,
void set_no_delay ( bool enabled )
true, packets will be sent immediately. If
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.