Sync classref with current source

This commit is contained in:
Rémi Verschelde
2019-10-29 12:48:46 +01:00
parent bbc6682099
commit a72184300f
449 changed files with 14004 additions and 232 deletions

View File

@@ -49,18 +49,24 @@ Signals
Emitted when the connection to the server is closed. ``was_clean_close`` will be ``true`` if the connection was shutdown cleanly.
----
.. _class_WebSocketClient_signal_connection_error:
- **connection_error** **(** **)**
Emitted when the connection to the server fails.
----
.. _class_WebSocketClient_signal_connection_established:
- **connection_established** **(** :ref:`String<class_String>` protocol **)**
Emitted when a connection with the server is established, ``protocol`` will contain the sub-protocol agreed with the server.
----
.. _class_WebSocketClient_signal_data_received:
- **data_received** **(** **)**
@@ -69,6 +75,8 @@ Emitted when a WebSocket message is received.
**Note:** This signal is *not* emitted when used as high-level multiplayer peer.
----
.. _class_WebSocketClient_signal_server_close_request:
- **server_close_request** **(** :ref:`int<class_int>` code, :ref:`String<class_String>` reason **)**
@@ -101,6 +109,8 @@ Property Descriptions
If specified, this :ref:`X509Certificate<class_X509Certificate>` will be the only one accepted when connecting to an SSL host. Any other certificate provided by the server will be regarded as invalid.
----
.. _class_WebSocketClient_property_verify_ssl:
- :ref:`bool<class_bool>` **verify_ssl**
@@ -130,18 +140,24 @@ If ``false`` is passed instead (default), you must call :ref:`PacketPeer<class_P
You can optionally pass a list of ``custom_headers`` to be added to the handshake HTTP request (not supported in HTML5 platform).
----
.. _class_WebSocketClient_method_disconnect_from_host:
- void **disconnect_from_host** **(** :ref:`int<class_int>` code=1000, :ref:`String<class_String>` reason="" **)**
Disconnects this client from the connected host. See :ref:`WebSocketPeer.close<class_WebSocketPeer_method_close>` for more information.
----
.. _class_WebSocketClient_method_get_connected_host:
- :ref:`String<class_String>` **get_connected_host** **(** **)** const
Return the IP address of the currently connected host.
----
.. _class_WebSocketClient_method_get_connected_port:
- :ref:`int<class_int>` **get_connected_port** **(** **)** const