godot-docs/classes/class_websocketserver.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the WebSocketServer.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_WebSocketServer:

WebSocketServer
===============

**Inherits:** :ref:`WebSocketMultiplayerPeer<class_websocketmultiplayerpeer>` **<** :ref:`NetworkedMultiplayerPeer<class_networkedmultiplayerpeer>` **<** :ref:`PacketPeer<class_packetpeer>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------



Member Functions
----------------

+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`  | :ref:`has_peer<class_WebSocketServer_has_peer>` **(** :ref:`int<class_int>` id **)** const                                                                                                               |
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`  | :ref:`is_listening<class_WebSocketServer_is_listening>` **(** **)** const                                                                                                                                |
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`    | :ref:`listen<class_WebSocketServer_listen>` **(** :ref:`int<class_int>` port, :ref:`PoolStringArray<class_poolstringarray>` protocols=PoolStringArray(  ), :ref:`bool<class_bool>` gd_mp_api=false **)** |
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                     | :ref:`stop<class_WebSocketServer_stop>` **(** **)**                                                                                                                                                      |
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Signals
-------

.. _class_WebSocketServer_client_connected:

- **client_connected** **(** :ref:`int<class_int>` id, :ref:`String<class_string>` protocol **)**

.. _class_WebSocketServer_client_disconnected:

- **client_disconnected** **(** :ref:`int<class_int>` id **)**

.. _class_WebSocketServer_data_received:

- **data_received** **(** :ref:`int<class_int>` id **)**


Member Function Description
---------------------------

.. _class_WebSocketServer_has_peer:

- :ref:`bool<class_bool>` **has_peer** **(** :ref:`int<class_int>` id **)** const

.. _class_WebSocketServer_is_listening:

- :ref:`bool<class_bool>` **is_listening** **(** **)** const

.. _class_WebSocketServer_listen:

- :ref:`int<class_int>` **listen** **(** :ref:`int<class_int>` port, :ref:`PoolStringArray<class_poolstringarray>` protocols=PoolStringArray(  ), :ref:`bool<class_bool>` gd_mp_api=false **)**

.. _class_WebSocketServer_stop:

- void **stop** **(** **)**