- github_url
hide
Inherits: StreamPeer<class_StreamPeer> < RefCounted<class_RefCounted> < Object<class_Object>
A stream peer that handles TCP connections.
classref-introduction-group
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.
classref-reftable-group
Error<enum_@GlobalScope_Error> |
bind<class_StreamPeerTCP_method_bind>(port: int<class_int>, host: String<class_String> = "*") |
Error<enum_@GlobalScope_Error> |
connect_to_host<class_StreamPeerTCP_method_connect_to_host>(host: String<class_String>, port: int<class_int>) |
void (No return value.) |
:ref:disconnect_from_host<class_StreamPeerTCP_method_disconnect_from_host>() |
String<class_String> |
get_connected_host<class_StreamPeerTCP_method_get_connected_host>() const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
int<class_int> |
get_connected_port<class_StreamPeerTCP_method_get_connected_port>() const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
int<class_int> |
get_local_port<class_StreamPeerTCP_method_get_local_port>() const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
Status<enum_StreamPeerTCP_Status> |
get_status<class_StreamPeerTCP_method_get_status>() const (This method has no side effects. It doesn't modify any of the instance's member variables.) |
Error<enum_@GlobalScope_Error> |
poll<class_StreamPeerTCP_method_poll>() |
void (No return value.) |
:ref:set_no_delay<class_StreamPeerTCP_method_set_no_delay>(enabled: bool<class_bool>) |
classref-section-separator
classref-descriptions-group
classref-enumeration
enum Status:
classref-enumeration-constant
Status<enum_StreamPeerTCP_Status> STATUS_NONE = 0
The initial status of the StreamPeerTCP. This is also the status after disconnecting.
classref-enumeration-constant
Status<enum_StreamPeerTCP_Status> STATUS_CONNECTING = 1
A status representing a StreamPeerTCP that is connecting to a host.
classref-enumeration-constant
Status<enum_StreamPeerTCP_Status> STATUS_CONNECTED = 2
A status representing a StreamPeerTCP that is connected to a host.
classref-enumeration-constant
Status<enum_StreamPeerTCP_Status> STATUS_ERROR = 3
A status representing a StreamPeerTCP in error state.
classref-section-separator
classref-descriptions-group
classref-method
Error<enum_@GlobalScope_Error> bind(port: int<class_int>, host: String<class_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<class_StreamPeerTCP_method_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.
classref-item-separator
classref-method
Error<enum_@GlobalScope_Error> connect_to_host(host: String<class_String>, port: int<class_int>)
Connects to the specified host:port pair. A hostname will be resolved if valid. Returns @GlobalScope.OK<class_@GlobalScope_constant_OK> on success.
classref-item-separator
classref-method
void (No return value.) disconnect_from_host()
Disconnects from host.
classref-item-separator
classref-method
String<class_String> get_connected_host() const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns the IP of this peer.
classref-item-separator
classref-method
int<class_int> get_connected_port() const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns the port of this peer.
classref-item-separator
classref-method
int<class_int> get_local_port() const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns the local port to which this peer is bound.
classref-item-separator
classref-method
Status<enum_StreamPeerTCP_Status> get_status() const (This method has no side effects. It doesn't modify any of the instance's member variables.)
Returns the status of the connection, see Status<enum_StreamPeerTCP_Status>.
classref-item-separator
classref-method
Error<enum_@GlobalScope_Error> poll()
Poll the socket, updating its state. See get_status<class_StreamPeerTCP_method_get_status>.
classref-item-separator
classref-method
void (No return value.) set_no_delay(enabled: bool<class_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.