.. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the StreamPeerTCP.xml source instead. .. The source is found in doc/classes or modules//doc_classes. .. _class_StreamPeerTCP: StreamPeerTCP ============= **Inherits:** :ref:`StreamPeer` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- TCP Stream peer. Member Functions ---------------- +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port **)** | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_from_host` **(** **)** | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_connected_host` **(** **)** const | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_connected_port` **(** **)** const | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_status` **(** **)** const | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_connected_to_host` **(** **)** const | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_no_delay` **(** :ref:`bool` enabled **)** | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ Enums ----- .. _enum_StreamPeerTCP_Status: enum **Status** - **STATUS_NONE** = **0** --- The initial status of the ``StreamPeerTCP``, also the status after a disconnect. - **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 staus representing a ``StreamPeerTCP`` in error state. Description ----------- TCP Stream peer. This object can be used to connect to TCP servers, or also is returned by a tcp server. Member Function Description --------------------------- .. _class_StreamPeerTCP_connect_to_host: - :ref:`int` **connect_to_host** **(** :ref:`String` host, :ref:`int` port **)** Connect to the specified host:port pair. A hostname will be resolved if valid. Returns OK on success or FAILED on failure. .. _class_StreamPeerTCP_disconnect_from_host: - void **disconnect_from_host** **(** **)** Disconnect from host. .. _class_StreamPeerTCP_get_connected_host: - :ref:`String` **get_connected_host** **(** **)** const Return the IP of this peer. .. _class_StreamPeerTCP_get_connected_port: - :ref:`int` **get_connected_port** **(** **)** const Return the port of this peer. .. _class_StreamPeerTCP_get_status: - :ref:`int` **get_status** **(** **)** const Return the status of the connection, one of STATUS\_\* enum. .. _class_StreamPeerTCP_is_connected_to_host: - :ref:`bool` **is_connected_to_host** **(** **)** const .. _class_StreamPeerTCP_set_no_delay: - void **set_no_delay** **(** :ref:`bool` enabled **)** Disable Nagle algorithm to improve latency for small packets. Note that for applications that send large packets, or need to transfer a lot of data, this can reduce total bandwidth.