Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 75b51ec2f4
Branches Tags
godot-docs
/
classes
/
class_websocketclient.rst

class_websocketclient.rst 11 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the WebSocketClient.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_WebSocketClient:
    8. 

  8. 

  9. WebSocketClient
    10. 

  10. ===============
    11. 

  11. 

  12. **Inherits:** :ref:`WebSocketMultiplayerPeer<class_WebSocketMultiplayerPeer>` **<** :ref:`MultiplayerPeer<class_MultiplayerPeer>` **<** :ref:`PacketPeer<class_PacketPeer>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. A WebSocket client implementation.
    15. 

  15. 

  16. Description
    17. 

  17. -----------
    18. 

  18. 

  19. This class implements a WebSocket client compatible with any RFC 6455-compliant WebSocket server.
    20. 

  20. 

  21. This client can be optionally used as a multiplayer peer for the :ref:`MultiplayerAPI<class_MultiplayerAPI>`.
    22. 

  22. 

  23. After starting the client (:ref:`connect_to_url<class_WebSocketClient_method_connect_to_url>`), you will need to :ref:`MultiplayerPeer.poll<class_MultiplayerPeer_method_poll>` it at regular intervals (e.g. inside :ref:`Node._process<class_Node_method__process>`).
    24. 

  24. 

  25. You will receive appropriate signals when connecting, disconnecting, or when new data is available.
    26. 

  26. 

  27. \ **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.
    28. 

  28. 

  29. Properties
    30. 

  30. ----------
    31. 

  31. 

  32. +-----------------------------------------------+----------------------------------------------------------------------------------------+
    33. 

  33. | :ref:`X509Certificate<class_X509Certificate>` | :ref:`trusted_ssl_certificate<class_WebSocketClient_property_trusted_ssl_certificate>` |
    34. 

  34. +-----------------------------------------------+----------------------------------------------------------------------------------------+
    35. 

  35. | :ref:`bool<class_bool>`                       | :ref:`verify_ssl<class_WebSocketClient_property_verify_ssl>`                           |
    36. 

  36. +-----------------------------------------------+----------------------------------------------------------------------------------------+
    37. 

  37. 

  38. Methods
    39. 

  39. -------
    40. 

  40. 

  41. +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`connect_to_url<class_WebSocketClient_method_connect_to_url>` **(** :ref:`String<class_String>` url, :ref:`PackedStringArray<class_PackedStringArray>` protocols=PackedStringArray(), :ref:`bool<class_bool>` gd_mp_api=false, :ref:`PackedStringArray<class_PackedStringArray>` custom_headers=PackedStringArray() **)** |
    43. 

  43. +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | void                                  | :ref:`disconnect_from_host<class_WebSocketClient_method_disconnect_from_host>` **(** :ref:`int<class_int>` code=1000, :ref:`String<class_String>` reason="" **)**                                                                                                                                                              |
    45. 

  45. +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | :ref:`String<class_String>`           | :ref:`get_connected_host<class_WebSocketClient_method_get_connected_host>` **(** **)** |const|                                                                                                                                                                                                                                 |
    47. 

  47. +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. | :ref:`int<class_int>`                 | :ref:`get_connected_port<class_WebSocketClient_method_get_connected_port>` **(** **)** |const|                                                                                                                                                                                                                                 |
    49. 

  49. +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    50. 

  50. 

  51. Signals
    52. 

  52. -------
    53. 

  53. 

  54. .. _class_WebSocketClient_signal_connection_closed:
    55. 

  55. 

  56. - **connection_closed** **(** :ref:`bool<class_bool>` was_clean_close **)**
    57. 

  57. 

  58. Emitted when the connection to the server is closed. ``was_clean_close`` will be ``true`` if the connection was shutdown cleanly.
    59. 

  59. 

  60. ----
    61. 

  61. 

  62. .. _class_WebSocketClient_signal_connection_error:
    63. 

  63. 

  64. - **connection_error** **(** **)**
    65. 

  65. 

  66. Emitted when the connection to the server fails.
    67. 

  67. 

  68. ----
    69. 

  69. 

  70. .. _class_WebSocketClient_signal_connection_established:
    71. 

  71. 

  72. - **connection_established** **(** :ref:`String<class_String>` protocol **)**
    73. 

  73. 

  74. Emitted when a connection with the server is established, ``protocol`` will contain the sub-protocol agreed with the server.
    75. 

  75. 

  76. ----
    77. 

  77. 

  78. .. _class_WebSocketClient_signal_data_received:
    79. 

  79. 

  80. - **data_received** **(** **)**
    81. 

  81. 

  82. Emitted when a WebSocket message is received.
    83. 

  83. 

  84. \ **Note:** This signal is *not* emitted when used as high-level multiplayer peer.
    85. 

  85. 

  86. ----
    87. 

  87. 

  88. .. _class_WebSocketClient_signal_server_close_request:
    89. 

  89. 

  90. - **server_close_request** **(** :ref:`int<class_int>` code, :ref:`String<class_String>` reason **)**
    91. 

  91. 

  92. Emitted when the server requests a clean close. You should keep polling until you get a :ref:`connection_closed<class_WebSocketClient_signal_connection_closed>` signal to achieve the clean close. See :ref:`WebSocketPeer.close<class_WebSocketPeer_method_close>` for more details.
    93. 

  93. 

  94. Property Descriptions
    95. 

  95. ---------------------
    96. 

  96. 

  97. .. _class_WebSocketClient_property_trusted_ssl_certificate:
    98. 

  98. 

  99. - :ref:`X509Certificate<class_X509Certificate>` **trusted_ssl_certificate**
    100. 

  100. 

  101. +----------+------------------------------------+
    102. 

  102. | *Setter* | set_trusted_ssl_certificate(value) |
    103. 

  103. +----------+------------------------------------+
    104. 

  104. | *Getter* | get_trusted_ssl_certificate()      |
    105. 

  105. +----------+------------------------------------+
    106. 

  106. 

  107. 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.
    108. 

  108. 

  109. \ **Note:** Specifying a custom ``trusted_ssl_certificate`` is not supported in HTML5 exports due to browsers restrictions.
    110. 

  110. 

  111. ----
    112. 

  112. 

  113. .. _class_WebSocketClient_property_verify_ssl:
    114. 

  114. 

  115. - :ref:`bool<class_bool>` **verify_ssl**
    116. 

  116. 

  117. +----------+-------------------------------+
    118. 

  118. | *Setter* | set_verify_ssl_enabled(value) |
    119. 

  119. +----------+-------------------------------+
    120. 

  120. | *Getter* | is_verify_ssl_enabled()       |
    121. 

  121. +----------+-------------------------------+
    122. 

  122. 

  123. If ``true``, SSL certificate verification is enabled.
    124. 

  124. 

  125. \ **Note:** You must specify the certificates to be used in the Project Settings for it to work when exported.
    126. 

  126. 

  127. Method Descriptions
    128. 

  128. -------------------
    129. 

  129. 

  130. .. _class_WebSocketClient_method_connect_to_url:
    131. 

  131. 

  132. - :ref:`Error<enum_@GlobalScope_Error>` **connect_to_url** **(** :ref:`String<class_String>` url, :ref:`PackedStringArray<class_PackedStringArray>` protocols=PackedStringArray(), :ref:`bool<class_bool>` gd_mp_api=false, :ref:`PackedStringArray<class_PackedStringArray>` custom_headers=PackedStringArray() **)**
    133. 

  133. 

  134. Connects to the given URL requesting one of the given ``protocols`` as sub-protocol. If the list empty (default), no sub-protocol will be requested.
    135. 

  135. 

  136. If ``true`` is passed as ``gd_mp_api``, the client will behave like a multiplayer peer for the :ref:`MultiplayerAPI<class_MultiplayerAPI>`, connections to non-Godot servers will not work, and :ref:`data_received<class_WebSocketClient_signal_data_received>` will not be emitted.
    137. 

  137. 

  138. If ``false`` is passed instead (default), you must call :ref:`PacketPeer<class_PacketPeer>` functions (``put_packet``, ``get_packet``, etc.) on the :ref:`WebSocketPeer<class_WebSocketPeer>` returned via ``get_peer(1)`` and not on this object directly (e.g. ``get_peer(1).put_packet(data)``).
    139. 

  139. 

  140. You can optionally pass a list of ``custom_headers`` to be added to the handshake HTTP request.
    141. 

  141. 

  142. \ **Note:** To avoid mixed content warnings or errors in HTML5, you may have to use a ``url`` that starts with ``wss://`` (secure) instead of ``ws://``. When doing so, make sure to use the fully qualified domain name that matches the one defined in the server's SSL certificate. Do not connect directly via the IP address for ``wss://`` connections, as it won't match with the SSL certificate.
    143. 

  143. 

  144. \ **Note:** Specifying ``custom_headers`` is not supported in HTML5 exports due to browsers restrictions.
    145. 

  145. 

  146. ----
    147. 

  147. 

  148. .. _class_WebSocketClient_method_disconnect_from_host:
    149. 

  149. 

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

  151. 

  152. Disconnects this client from the connected host. See :ref:`WebSocketPeer.close<class_WebSocketPeer_method_close>` for more information.
    153. 

  153. 

  154. ----
    155. 

  155. 

  156. .. _class_WebSocketClient_method_get_connected_host:
    157. 

  157. 

  158. - :ref:`String<class_String>` **get_connected_host** **(** **)** |const|
    159. 

  159. 

  160. Returns the IP address of the currently connected host.
    161. 

  161. 

  162. ----
    163. 

  163. 

  164. .. _class_WebSocketClient_method_get_connected_port:
    165. 

  165. 

  166. - :ref:`int<class_int>` **get_connected_port** **(** **)** |const|
    167. 

  167. 

  168. Returns the IP port of the currently connected host.
    169. 

  169. 

  170. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    171. 

  171. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    172. 

  172. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    173. 

  173. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    174. 

  174. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    175. 

  175. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    176.