| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the TCPServer.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_TCPServer:
- TCPServer
- =========
- **Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- A TCP server.
- Description
- -----------
- A TCP server. Listens to connections on a port and returns a :ref:`StreamPeerTCP<class_StreamPeerTCP>` when it gets an incoming connection.
- \ **Note:** When exporting to Android, make sure to enable the ``INTERNET`` permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android.
- Methods
- -------
- +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_local_port<class_TCPServer_method_get_local_port>` **(** **)** |const| |
- +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_connection_available<class_TCPServer_method_is_connection_available>` **(** **)** |const| |
- +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_listening<class_TCPServer_method_is_listening>` **(** **)** |const| |
- +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`listen<class_TCPServer_method_listen>` **(** :ref:`int<class_int>` port, :ref:`String<class_String>` bind_address="*" **)** |
- +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`stop<class_TCPServer_method_stop>` **(** **)** |
- +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`StreamPeerTCP<class_StreamPeerTCP>` | :ref:`take_connection<class_TCPServer_method_take_connection>` **(** **)** |
- +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- Method Descriptions
- -------------------
- .. _class_TCPServer_method_get_local_port:
- - :ref:`int<class_int>` **get_local_port** **(** **)** |const|
- Returns the local port this server is listening to.
- ----
- .. _class_TCPServer_method_is_connection_available:
- - :ref:`bool<class_bool>` **is_connection_available** **(** **)** |const|
- Returns ``true`` if a connection is available for taking.
- ----
- .. _class_TCPServer_method_is_listening:
- - :ref:`bool<class_bool>` **is_listening** **(** **)** |const|
- Returns ``true`` if the server is currently listening for connections.
- ----
- .. _class_TCPServer_method_listen:
- - :ref:`Error<enum_@GlobalScope_Error>` **listen** **(** :ref:`int<class_int>` port, :ref:`String<class_String>` bind_address="*" **)**
- Listen on the ``port`` binding to ``bind_address``.
- If ``bind_address`` is set as ``"*"`` (default), the server will listen on all available addresses (both IPv4 and IPv6).
- If ``bind_address`` is set as ``"0.0.0.0"`` (for IPv4) or ``"::"`` (for IPv6), the server will listen on all available addresses matching that IP type.
- If ``bind_address`` is set to any valid address (e.g. ``"192.168.1.101"``, ``"::1"``, etc), the server will only listen on the interface with that addresses (or fail if no interface with the given address exists).
- ----
- .. _class_TCPServer_method_stop:
- - void **stop** **(** **)**
- Stops listening.
- ----
- .. _class_TCPServer_method_take_connection:
- - :ref:`StreamPeerTCP<class_StreamPeerTCP>` **take_connection** **(** **)**
- If a connection is available, returns a StreamPeerTCP with the connection.
- .. |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.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
