| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105 |
- :github_url: hide
- .. DO NOT EDIT THIS FILE!!!
- .. Generated automatically from Godot engine sources.
- .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
- .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/SocketServer.xml.
- .. _class_SocketServer:
- SocketServer
- ============
- **Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- **Inherited By:** :ref:`TCPServer<class_TCPServer>`, :ref:`UDSServer<class_UDSServer>`
- An abstract class for servers based on sockets.
- .. rst-class:: classref-introduction-group
- Description
- -----------
- A socket server.
- .. rst-class:: classref-reftable-group
- Methods
- -------
- .. table::
- :widths: auto
- +-------------------------------------------------+-------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_connection_available<class_SocketServer_method_is_connection_available>`\ (\ ) |const| |
- +-------------------------------------------------+-------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_listening<class_SocketServer_method_is_listening>`\ (\ ) |const| |
- +-------------------------------------------------+-------------------------------------------------------------------------------------------------+
- | |void| | :ref:`stop<class_SocketServer_method_stop>`\ (\ ) |
- +-------------------------------------------------+-------------------------------------------------------------------------------------------------+
- | :ref:`StreamPeerSocket<class_StreamPeerSocket>` | :ref:`take_socket_connection<class_SocketServer_method_take_socket_connection>`\ (\ ) |
- +-------------------------------------------------+-------------------------------------------------------------------------------------------------+
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Method Descriptions
- -------------------
- .. _class_SocketServer_method_is_connection_available:
- .. rst-class:: classref-method
- :ref:`bool<class_bool>` **is_connection_available**\ (\ ) |const| :ref:`🔗<class_SocketServer_method_is_connection_available>`
- Returns ``true`` if a connection is available for taking.
- .. rst-class:: classref-item-separator
- ----
- .. _class_SocketServer_method_is_listening:
- .. rst-class:: classref-method
- :ref:`bool<class_bool>` **is_listening**\ (\ ) |const| :ref:`🔗<class_SocketServer_method_is_listening>`
- Returns ``true`` if the server is currently listening for connections.
- .. rst-class:: classref-item-separator
- ----
- .. _class_SocketServer_method_stop:
- .. rst-class:: classref-method
- |void| **stop**\ (\ ) :ref:`🔗<class_SocketServer_method_stop>`
- Stops listening.
- .. rst-class:: classref-item-separator
- ----
- .. _class_SocketServer_method_take_socket_connection:
- .. rst-class:: classref-method
- :ref:`StreamPeerSocket<class_StreamPeerSocket>` **take_socket_connection**\ (\ ) :ref:`🔗<class_SocketServer_method_take_socket_connection>`
- If a connection is available, returns a StreamPeerSocket with the connection.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
- .. |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.)`
- .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
- .. |void| replace:: :abbr:`void (No return value.)`
|
