mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-03 05:48:42 +03:00
132 lines
6.2 KiB
ReStructuredText
132 lines
6.2 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. 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.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------+----------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`blocking_handshake<class_StreamPeerSSL_property_blocking_handshake>` |
|
|
+-------------------------+----------------------------------------------------------------------------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`accept_stream<class_StreamPeerSSL_method_accept_stream>` **(** :ref:`StreamPeer<class_StreamPeer>` base **)** |
|
|
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`connect_to_stream<class_StreamPeerSSL_method_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_method_disconnect_from_stream>` **(** **)** |
|
|
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Status<enum_StreamPeerSSL_Status>` | :ref:`get_status<class_StreamPeerSSL_method_get_status>` **(** **)** const |
|
|
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`poll<class_StreamPeerSSL_method_poll>` **(** **)** |
|
|
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_StreamPeerSSL_Status:
|
|
|
|
.. _class_StreamPeerSSL_constant_STATUS_DISCONNECTED:
|
|
|
|
.. _class_StreamPeerSSL_constant_STATUS_HANDSHAKING:
|
|
|
|
.. _class_StreamPeerSSL_constant_STATUS_CONNECTED:
|
|
|
|
.. _class_StreamPeerSSL_constant_STATUS_ERROR:
|
|
|
|
.. _class_StreamPeerSSL_constant_STATUS_ERROR_HOSTNAME_MISMATCH:
|
|
|
|
enum **Status**:
|
|
|
|
- **STATUS_DISCONNECTED** = **0** --- A status representing a ``StreamPeerSSL`` that is disconnected.
|
|
|
|
- **STATUS_HANDSHAKING** = **1**
|
|
|
|
- **STATUS_CONNECTED** = **2** --- A status representing a ``StreamPeerSSL`` that is connected to a host.
|
|
|
|
- **STATUS_ERROR** = **3**
|
|
|
|
- **STATUS_ERROR_HOSTNAME_MISMATCH** = **4** --- 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.
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`../tutorials/networking/ssl_certificates`
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_StreamPeerSSL_property_blocking_handshake:
|
|
|
|
- :ref:`bool<class_bool>` **blocking_handshake**
|
|
|
|
+----------+---------------------------------------+
|
|
| *Setter* | set_blocking_handshake_enabled(value) |
|
|
+----------+---------------------------------------+
|
|
| *Getter* | is_blocking_handshake_enabled() |
|
|
+----------+---------------------------------------+
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_StreamPeerSSL_method_accept_stream:
|
|
|
|
- :ref:`Error<enum_@GlobalScope_Error>` **accept_stream** **(** :ref:`StreamPeer<class_StreamPeer>` base **)**
|
|
|
|
----
|
|
|
|
.. _class_StreamPeerSSL_method_connect_to_stream:
|
|
|
|
- :ref:`Error<enum_@GlobalScope_Error>` **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_method_disconnect_from_stream:
|
|
|
|
- void **disconnect_from_stream** **(** **)**
|
|
|
|
Disconnect from host.
|
|
|
|
----
|
|
|
|
.. _class_StreamPeerSSL_method_get_status:
|
|
|
|
- :ref:`Status<enum_StreamPeerSSL_Status>` **get_status** **(** **)** const
|
|
|
|
Returns the status of the connection, one of STATUS\_\* enum.
|
|
|
|
----
|
|
|
|
.. _class_StreamPeerSSL_method_poll:
|
|
|
|
- void **poll** **(** **)**
|
|
|
|
Poll the connection to check for incoming bytes. Call this right before "get_available_bytes()" for it to work properly.
|
|
|