123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263 |
- .. 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_TCP_Server:
- TCP_Server
- ==========
- **Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
- **Category:** Core
- Brief Description
- -----------------
- TCP Server.
- Member Functions
- ----------------
- +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_connection_available<class_TCP_Server_is_connection_available>` **(** **)** const |
- +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`listen<class_TCP_Server_listen>` **(** :ref:`int<class_int>` port, :ref:`StringArray<class_stringarray>` accepted_hosts=StringArray([]) **)** |
- +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`stop<class_TCP_Server_stop>` **(** **)** |
- +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Object<class_object>` | :ref:`take_connection<class_TCP_Server_take_connection>` **(** **)** |
- +------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
- Description
- -----------
- TCP Server class. Listens to connections on a port and returns a :ref:`StreamPeerTCP<class_streampeertcp>` when got a connection.
- Member Function Description
- ---------------------------
- .. _class_TCP_Server_is_connection_available:
- - :ref:`bool<class_bool>` **is_connection_available** **(** **)** const
- Return true if a connection is available for taking.
- .. _class_TCP_Server_listen:
- - :ref:`int<class_int>` **listen** **(** :ref:`int<class_int>` port, :ref:`StringArray<class_stringarray>` accepted_hosts=StringArray([]) **)**
- Listen on a port using protocol, alternatively give a white-list of accepted hosts.
- .. _class_TCP_Server_stop:
- - void **stop** **(** **)**
- Stop listening.
- .. _class_TCP_Server_take_connection:
- - :ref:`Object<class_object>` **take_connection** **(** **)**
- If a connection is available, return a StreamPeerTCP with the connection/
|