mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 19:29:06 +00:00
61 lines
2.7 KiB
ReStructuredText
61 lines
2.7 KiB
ReStructuredText
.. _class_TCP_Server:
|
|
|
|
TCP_Server
|
|
==========
|
|
|
|
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
TCP Server.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`listen<class_TCP_Server_listen>` **(** :ref:`int<class_int>` port, :ref:`StringArray<class_stringarray>` accepted_hosts=StringArray() **)** |
|
|
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_connection_available<class_TCP_Server_is_connection_available>` **(** **)** const |
|
|
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Object<class_object>` | :ref:`take_connection<class_TCP_Server_take_connection>` **(** **)** |
|
|
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`stop<class_TCP_Server_stop>` **(** **)** |
|
|
+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
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_listen:
|
|
|
|
- :ref:`int<class_int>` **listen** **(** :ref:`int<class_int>` port, :ref:`StringArray<class_stringarray>` accepted_hosts=StringArray() **)**
|
|
|
|
Listen on a port, alternatively give a white-list of accepted hosts.
|
|
|
|
.. _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_take_connection:
|
|
|
|
- :ref:`Object<class_object>` **take_connection** **(** **)**
|
|
|
|
If a connection is available, return a StreamPeerTCP with the connection/
|
|
|
|
.. _class_TCP_Server_stop:
|
|
|
|
- void **stop** **(** **)**
|
|
|
|
Stop listening.
|
|
|
|
|