godot-docs/classes/class_websocketpeer.rst

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

.. _class_WebSocketPeer:

WebSocketPeer
=============

**Inherits:** :ref:`PacketPeer<class_PacketPeer>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Category:** Core

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

A class representing a specific WebSocket connection.

Methods
-------

+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`close<class_WebSocketPeer_method_close>` **(** :ref:`int<class_int>` code=1000, :ref:`String<class_String>` reason="" **)** |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                    | :ref:`get_connected_host<class_WebSocketPeer_method_get_connected_host>` **(** **)** const                                        |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                          | :ref:`get_connected_port<class_WebSocketPeer_method_get_connected_port>` **(** **)** const                                        |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`WriteMode<enum_WebSocketPeer_WriteMode>` | :ref:`get_write_mode<class_WebSocketPeer_method_get_write_mode>` **(** **)** const                                                |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                        | :ref:`is_connected_to_host<class_WebSocketPeer_method_is_connected_to_host>` **(** **)** const                                    |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`set_write_mode<class_WebSocketPeer_method_set_write_mode>` **(** :ref:`WriteMode<enum_WebSocketPeer_WriteMode>` mode **)**  |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                        | :ref:`was_string_packet<class_WebSocketPeer_method_was_string_packet>` **(** **)** const                                          |
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+

Enumerations
------------

.. _enum_WebSocketPeer_WriteMode:

.. _class_WebSocketPeer_constant_WRITE_MODE_TEXT:

.. _class_WebSocketPeer_constant_WRITE_MODE_BINARY:

enum **WriteMode**:

- **WRITE_MODE_TEXT** = **0** --- Specify that WebSockets messages should be transferred as text payload (only valid UTF-8 is allowed).

- **WRITE_MODE_BINARY** = **1** --- Specify that WebSockets messages should be transferred as binary payload (any byte combination is allowed).

Description
-----------

This class represent a specific WebSocket connection, you can do lower level operations with it.

You can choose to write to the socket in binary or text mode, and you can recognize the mode used for writing by the other peer.

Method Descriptions
-------------------

.. _class_WebSocketPeer_method_close:

- void **close** **(** :ref:`int<class_int>` code=1000, :ref:`String<class_String>` reason="" **)**

Close this WebSocket connection. ``code`` is the status code for the closure (see RFC6455 section 7.4 for a list of valid status codes). ``reason`` is the human readable reason for closing the connection (can be any UTF8 string, must be less than 123 bytes).

Note: To achieve a clean close, you will need to keep polling until either :ref:`WebSocketClient.connection_closed<class_WebSocketClient_signal_connection_closed>` or :ref:`WebSocketServer.client_disconnected<class_WebSocketServer_signal_client_disconnected>` is received.

Note: HTML5 export might not support all status codes. Please refer to browsers-specific documentation for more details.

.. _class_WebSocketPeer_method_get_connected_host:

- :ref:`String<class_String>` **get_connected_host** **(** **)** const

Returns the IP Address of the connected peer. (Not available in HTML5 export)

.. _class_WebSocketPeer_method_get_connected_port:

- :ref:`int<class_int>` **get_connected_port** **(** **)** const

Returns the remote port of the connected peer. (Not available in HTML5 export)

.. _class_WebSocketPeer_method_get_write_mode:

- :ref:`WriteMode<enum_WebSocketPeer_WriteMode>` **get_write_mode** **(** **)** const

Get the current selected write mode. See :ref:`WriteMode<enum_WebSocketPeer_WriteMode>`.

.. _class_WebSocketPeer_method_is_connected_to_host:

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

Returns ``true`` if this peer is currently connected.

.. _class_WebSocketPeer_method_set_write_mode:

- void **set_write_mode** **(** :ref:`WriteMode<enum_WebSocketPeer_WriteMode>` mode **)**

Sets the socket to use the given :ref:`WriteMode<enum_WebSocketPeer_WriteMode>`.

.. _class_WebSocketPeer_method_was_string_packet:

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

Returns ``true`` if the last received packet was sent as a text payload. See :ref:`WriteMode<enum_WebSocketPeer_WriteMode>`