| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
- .. _class_StreamPeerTCP:
- StreamPeerTCP
- =============
- **Inherits:** :ref:`StreamPeer<class_streampeer>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
- **Category:** Core
- Brief Description
- -----------------
- TCP Stream peer.
- Member Functions
- ----------------
- +------------------------------+------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`connect<class_StreamPeerTCP_connect>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port **)** |
- +------------------------------+------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`disconnect<class_StreamPeerTCP_disconnect>` **(** **)** |
- +------------------------------+------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_string>` | :ref:`get_connected_host<class_StreamPeerTCP_get_connected_host>` **(** **)** const |
- +------------------------------+------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_connected_port<class_StreamPeerTCP_get_connected_port>` **(** **)** const |
- +------------------------------+------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_status<class_StreamPeerTCP_get_status>` **(** **)** const |
- +------------------------------+------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_connected<class_StreamPeerTCP_is_connected>` **(** **)** const |
- +------------------------------+------------------------------------------------------------------------------------------------------------------------+
- Numeric Constants
- -----------------
- - **STATUS_NONE** = **0** --- The initial status of the :ref:`StreamPeerTCP<class_streampeertcp>`, also the status after a disconnect.
- - **STATUS_CONNECTING** = **1** --- A status representing a :ref:`StreamPeerTCP<class_streampeertcp>` that is connecting to a host.
- - **STATUS_CONNECTED** = **2** --- A status representing a :ref:`StreamPeerTCP<class_streampeertcp>` that is connected to a host.
- - **STATUS_ERROR** = **3** --- A staus representing a :ref:`StreamPeerTCP<class_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:
- - :ref:`int<class_int>` **connect** **(** :ref:`String<class_string>` host, :ref:`int<class_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:
- - void **disconnect** **(** **)**
- Disconnect from host.
- .. _class_StreamPeerTCP_get_connected_host:
- - :ref:`String<class_string>` **get_connected_host** **(** **)** const
- Return the IP of this peer.
- .. _class_StreamPeerTCP_get_connected_port:
- - :ref:`int<class_int>` **get_connected_port** **(** **)** const
- Return the port of this peer.
- .. _class_StreamPeerTCP_get_status:
- - :ref:`int<class_int>` **get_status** **(** **)** const
- Return the status of the connection, one of STATUS\_\* enum.
- .. _class_StreamPeerTCP_is_connected:
- - :ref:`bool<class_bool>` **is_connected** **(** **)** const
- Return whether this peer is connected. Returns true while connecting and connected.
|
