:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StreamPeerTCP.xml. .. _class_StreamPeerTCP: StreamPeerTCP ============= **Inherits:** :ref:`StreamPeer` **<** :ref:`RefCounted` **<** :ref:`Object` A stream peer that handles TCP connections. .. rst-class:: classref-introduction-group 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. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`bind`\ (\ port\: :ref:`int`, host\: :ref:`String` = "*"\ ) | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`connect_to_host`\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`disconnect_from_host`\ (\ ) | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_connected_host`\ (\ ) |const| | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_connected_port`\ (\ ) |const| | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_local_port`\ (\ ) |const| | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Status` | :ref:`get_status`\ (\ ) |const| | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`poll`\ (\ ) | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_no_delay`\ (\ enabled\: :ref:`bool`\ ) | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_StreamPeerTCP_Status: .. rst-class:: classref-enumeration enum **Status**: :ref:`🔗` .. _class_StreamPeerTCP_constant_STATUS_NONE: .. rst-class:: classref-enumeration-constant :ref:`Status` **STATUS_NONE** = ``0`` The initial status of the **StreamPeerTCP**. This is also the status after disconnecting. .. _class_StreamPeerTCP_constant_STATUS_CONNECTING: .. rst-class:: classref-enumeration-constant :ref:`Status` **STATUS_CONNECTING** = ``1`` A status representing a **StreamPeerTCP** that is connecting to a host. .. _class_StreamPeerTCP_constant_STATUS_CONNECTED: .. rst-class:: classref-enumeration-constant :ref:`Status` **STATUS_CONNECTED** = ``2`` A status representing a **StreamPeerTCP** that is connected to a host. .. _class_StreamPeerTCP_constant_STATUS_ERROR: .. rst-class:: classref-enumeration-constant :ref:`Status` **STATUS_ERROR** = ``3`` A status representing a **StreamPeerTCP** in error state. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_StreamPeerTCP_method_bind: .. rst-class:: classref-method :ref:`Error` **bind**\ (\ port\: :ref:`int`, host\: :ref:`String` = "*"\ ) :ref:`🔗` 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 :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_StreamPeerTCP_method_connect_to_host: .. rst-class:: classref-method :ref:`Error` **connect_to_host**\ (\ host\: :ref:`String`, port\: :ref:`int`\ ) :ref:`🔗` Connects to the specified ``host:port`` pair. A hostname will be resolved if valid. Returns :ref:`@GlobalScope.OK` on success. .. rst-class:: classref-item-separator ---- .. _class_StreamPeerTCP_method_disconnect_from_host: .. rst-class:: classref-method |void| **disconnect_from_host**\ (\ ) :ref:`🔗` Disconnects from host. .. rst-class:: classref-item-separator ---- .. _class_StreamPeerTCP_method_get_connected_host: .. rst-class:: classref-method :ref:`String` **get_connected_host**\ (\ ) |const| :ref:`🔗` Returns the IP of this peer. .. rst-class:: classref-item-separator ---- .. _class_StreamPeerTCP_method_get_connected_port: .. rst-class:: classref-method :ref:`int` **get_connected_port**\ (\ ) |const| :ref:`🔗` Returns the port of this peer. .. rst-class:: classref-item-separator ---- .. _class_StreamPeerTCP_method_get_local_port: .. rst-class:: classref-method :ref:`int` **get_local_port**\ (\ ) |const| :ref:`🔗` Returns the local port to which this peer is bound. .. rst-class:: classref-item-separator ---- .. _class_StreamPeerTCP_method_get_status: .. rst-class:: classref-method :ref:`Status` **get_status**\ (\ ) |const| :ref:`🔗` Returns the status of the connection. .. rst-class:: classref-item-separator ---- .. _class_StreamPeerTCP_method_poll: .. rst-class:: classref-method :ref:`Error` **poll**\ (\ ) :ref:`🔗` Poll the socket, updating its state. See :ref:`get_status()`. .. rst-class:: classref-item-separator ---- .. _class_StreamPeerTCP_method_set_no_delay: .. rst-class:: classref-method |void| **set_no_delay**\ (\ enabled\: :ref:`bool`\ ) :ref:`🔗` 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. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`