class_streampeerssl.rst 3.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_StreamPeerSSL:
  4. StreamPeerSSL
  5. =============
  6. **Inherits:** :ref:`StreamPeer<class_streampeer>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Member Functions
  11. ----------------
  12. +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  13. | Error | :ref:`accept<class_StreamPeerSSL_accept>` **(** :ref:`StreamPeer<class_streampeer>` stream **)** |
  14. +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | Error | :ref:`connect<class_StreamPeerSSL_connect>` **(** :ref:`StreamPeer<class_streampeer>` stream, :ref:`bool<class_bool>` validate_certs=false, :ref:`String<class_string>` for_hostname="" **)** |
  16. +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`int<class_int>` | :ref:`get_status<class_StreamPeerSSL_get_status>` **(** **)** const |
  18. +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | void | :ref:`disconnect<class_StreamPeerSSL_disconnect>` **(** **)** |
  20. +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. Numeric Constants
  22. -----------------
  23. - **STATUS_DISCONNECTED** = **0**
  24. - **STATUS_CONNECTED** = **1**
  25. - **STATUS_ERROR_NO_CERTIFICATE** = **2**
  26. - **STATUS_ERROR_HOSTNAME_MISMATCH** = **3**
  27. Member Function Description
  28. ---------------------------
  29. .. _class_StreamPeerSSL_accept:
  30. - Error **accept** **(** :ref:`StreamPeer<class_streampeer>` stream **)**
  31. .. _class_StreamPeerSSL_connect:
  32. - Error **connect** **(** :ref:`StreamPeer<class_streampeer>` stream, :ref:`bool<class_bool>` validate_certs=false, :ref:`String<class_string>` for_hostname="" **)**
  33. .. _class_StreamPeerSSL_get_status:
  34. - :ref:`int<class_int>` **get_status** **(** **)** const
  35. .. _class_StreamPeerSSL_disconnect:
  36. - void **disconnect** **(** **)**