| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.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/<name>/doc_classes.
- .. _class_StreamPeerTCP:
- StreamPeerTCP
- =============
- **Inherits:** :ref:`StreamPeer<class_StreamPeer>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
- TCP stream peer.
- Description
- -----------
- TCP stream peer. This object can be used to connect to TCP servers, or also is returned by a TCP server.
- Methods
- -------
- +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`connect_to_host<class_StreamPeerTCP_method_connect_to_host>` **(** :ref:`String<class_String>` host, :ref:`int<class_int>` port **)** |
- +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`disconnect_from_host<class_StreamPeerTCP_method_disconnect_from_host>` **(** **)** |
- +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_connected_host<class_StreamPeerTCP_method_get_connected_host>` **(** **)** |const| |
- +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_connected_port<class_StreamPeerTCP_method_get_connected_port>` **(** **)** |const| |
- +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Status<enum_StreamPeerTCP_Status>` | :ref:`get_status<class_StreamPeerTCP_method_get_status>` **(** **)** |
- +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_connected_to_host<class_StreamPeerTCP_method_is_connected_to_host>` **(** **)** |const| |
- +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_no_delay<class_StreamPeerTCP_method_set_no_delay>` **(** :ref:`bool<class_bool>` enabled **)** |
- +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
- Enumerations
- ------------
- .. _enum_StreamPeerTCP_Status:
- .. _class_StreamPeerTCP_constant_STATUS_NONE:
- .. _class_StreamPeerTCP_constant_STATUS_CONNECTING:
- .. _class_StreamPeerTCP_constant_STATUS_CONNECTED:
- .. _class_StreamPeerTCP_constant_STATUS_ERROR:
- enum **Status**:
- - **STATUS_NONE** = **0** --- The initial status of the ``StreamPeerTCP``. This is also the status after disconnecting.
- - **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 status representing a ``StreamPeerTCP`` in error state.
- Method Descriptions
- -------------------
- .. _class_StreamPeerTCP_method_connect_to_host:
- - :ref:`Error<enum_@GlobalScope_Error>` **connect_to_host** **(** :ref:`String<class_String>` host, :ref:`int<class_int>` port **)**
- Connects to the specified ``host:port`` pair. A hostname will be resolved if valid. Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` on success or :ref:`@GlobalScope.FAILED<class_@GlobalScope_constant_FAILED>` on failure.
- ----
- .. _class_StreamPeerTCP_method_disconnect_from_host:
- - void **disconnect_from_host** **(** **)**
- Disconnects from host.
- ----
- .. _class_StreamPeerTCP_method_get_connected_host:
- - :ref:`String<class_String>` **get_connected_host** **(** **)** |const|
- Returns the IP of this peer.
- ----
- .. _class_StreamPeerTCP_method_get_connected_port:
- - :ref:`int<class_int>` **get_connected_port** **(** **)** |const|
- Returns the port of this peer.
- ----
- .. _class_StreamPeerTCP_method_get_status:
- - :ref:`Status<enum_StreamPeerTCP_Status>` **get_status** **(** **)**
- Returns the status of the connection, see :ref:`Status<enum_StreamPeerTCP_Status>`.
- ----
- .. _class_StreamPeerTCP_method_is_connected_to_host:
- - :ref:`bool<class_bool>` **is_connected_to_host** **(** **)** |const|
- Returns ``true`` if this peer is currently connected or is connecting to a host, ``false`` otherwise.
- ----
- .. _class_StreamPeerTCP_method_set_no_delay:
- - void **set_no_delay** **(** :ref:`bool<class_bool>` enabled **)**
- 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 <https://en.wikipedia.org/wiki/Nagle%27s_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.)`
- .. |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.)`
|
