| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the StreamPeerSSL.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_StreamPeerSSL:
- StreamPeerSSL
- =============
- **Inherits:** :ref:`StreamPeer<class_streampeer>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
- **Category:** Core
- Brief Description
- -----------------
- SSL Stream peer.
- Member Functions
- ----------------
- +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`accept_stream<class_StreamPeerSSL_accept_stream>` **(** :ref:`StreamPeer<class_streampeer>` stream **)** |
- +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`connect_to_stream<class_StreamPeerSSL_connect_to_stream>` **(** :ref:`StreamPeer<class_streampeer>` stream, :ref:`bool<class_bool>` validate_certs=false, :ref:`String<class_string>` for_hostname="" **)** |
- +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`disconnect_from_stream<class_StreamPeerSSL_disconnect_from_stream>` **(** **)** |
- +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_status<class_StreamPeerSSL_get_status>` **(** **)** const |
- +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Enums
- -----
- .. _enum_StreamPeerSSL_Status:
- enum **Status**
- - **STATUS_DISCONNECTED** = **0** --- A status representing a ``StreamPeerSSL`` that is disconnected.
- - **STATUS_CONNECTED** = **1** --- A status representing a ``StreamPeerSSL`` that is connected to a host.
- - **STATUS_ERROR_NO_CERTIFICATE** = **2** --- An errot status that shows the peer did not present a SSL certificate and validation was requested.
- - **STATUS_ERROR_HOSTNAME_MISMATCH** = **3** --- An error status that shows a mismatch in the SSL certificate domain presented by the host and the domain requested for validation.
- Description
- -----------
- SSL Stream peer. This object can be used to connect to SSL servers.
- Member Function Description
- ---------------------------
- .. _class_StreamPeerSSL_accept_stream:
- - :ref:`int<class_int>` **accept_stream** **(** :ref:`StreamPeer<class_streampeer>` stream **)**
- .. _class_StreamPeerSSL_connect_to_stream:
- - :ref:`int<class_int>` **connect_to_stream** **(** :ref:`StreamPeer<class_streampeer>` stream, :ref:`bool<class_bool>` validate_certs=false, :ref:`String<class_string>` for_hostname="" **)**
- Connect to a peer using an underlying :ref:`StreamPeer<class_streampeer>` "stream", when "validate_certs" is true, ``StreamPeerSSL`` will validate that the certificate presented by the peer matches the "for_hostname".
- .. _class_StreamPeerSSL_disconnect_from_stream:
- - void **disconnect_from_stream** **(** **)**
- Disconnect from host.
- .. _class_StreamPeerSSL_get_status:
- - :ref:`int<class_int>` **get_status** **(** **)** const
- Return the status of the connection, one of STATUS\_\* enum.
|
