:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.1/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.1/doc/classes/StreamPeerTLS.xml. .. _class_StreamPeerTLS: StreamPeerTLS ============= **Inherits:** :ref:`StreamPeer` **<** :ref:`RefCounted` **<** :ref:`Object` A stream peer that handles TLS connections. .. rst-class:: classref-introduction-group Description ----------- A stream peer that handles TLS connections. This object can be used to connect to a TLS server or accept a single TLS client connection. \ **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. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`TLS certificates <../tutorials/networking/ssl_certificates>` .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`accept_stream` **(** :ref:`StreamPeer` stream, :ref:`TLSOptions` server_options **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`connect_to_stream` **(** :ref:`StreamPeer` stream, :ref:`String` common_name, :ref:`TLSOptions` client_options=null **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_from_stream` **(** **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Status` | :ref:`get_status` **(** **)** |const| | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StreamPeer` | :ref:`get_stream` **(** **)** |const| | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`poll` **(** **)** | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_StreamPeerTLS_Status: .. rst-class:: classref-enumeration enum **Status**: .. _class_StreamPeerTLS_constant_STATUS_DISCONNECTED: .. rst-class:: classref-enumeration-constant :ref:`Status` **STATUS_DISCONNECTED** = ``0`` A status representing a **StreamPeerTLS** that is disconnected. .. _class_StreamPeerTLS_constant_STATUS_HANDSHAKING: .. rst-class:: classref-enumeration-constant :ref:`Status` **STATUS_HANDSHAKING** = ``1`` A status representing a **StreamPeerTLS** during handshaking. .. _class_StreamPeerTLS_constant_STATUS_CONNECTED: .. rst-class:: classref-enumeration-constant :ref:`Status` **STATUS_CONNECTED** = ``2`` A status representing a **StreamPeerTLS** that is connected to a host. .. _class_StreamPeerTLS_constant_STATUS_ERROR: .. rst-class:: classref-enumeration-constant :ref:`Status` **STATUS_ERROR** = ``3`` A status representing a **StreamPeerTLS** in error state. .. _class_StreamPeerTLS_constant_STATUS_ERROR_HOSTNAME_MISMATCH: .. rst-class:: classref-enumeration-constant :ref:`Status` **STATUS_ERROR_HOSTNAME_MISMATCH** = ``4`` An error status that shows a mismatch in the TLS certificate domain presented by the host and the domain requested for validation. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_StreamPeerTLS_method_accept_stream: .. rst-class:: classref-method :ref:`Error` **accept_stream** **(** :ref:`StreamPeer` stream, :ref:`TLSOptions` server_options **)** Accepts a peer connection as a server using the given ``server_options``. See :ref:`TLSOptions.server`. .. rst-class:: classref-item-separator ---- .. _class_StreamPeerTLS_method_connect_to_stream: .. rst-class:: classref-method :ref:`Error` **connect_to_stream** **(** :ref:`StreamPeer` stream, :ref:`String` common_name, :ref:`TLSOptions` client_options=null **)** Connects to a peer using an underlying :ref:`StreamPeer` ``stream`` and verifying the remote certificate is correctly signed for the given ``common_name``. You can pass the optional ``client_options`` parameter to customize the trusted certification authorities, or disable the common name verification. See :ref:`TLSOptions.client` and :ref:`TLSOptions.client_unsafe`. .. rst-class:: classref-item-separator ---- .. _class_StreamPeerTLS_method_disconnect_from_stream: .. rst-class:: classref-method void **disconnect_from_stream** **(** **)** Disconnects from host. .. rst-class:: classref-item-separator ---- .. _class_StreamPeerTLS_method_get_status: .. rst-class:: classref-method :ref:`Status` **get_status** **(** **)** |const| Returns the status of the connection. See :ref:`Status` for values. .. rst-class:: classref-item-separator ---- .. _class_StreamPeerTLS_method_get_stream: .. rst-class:: classref-method :ref:`StreamPeer` **get_stream** **(** **)** |const| Returns the underlying :ref:`StreamPeer` connection, used in :ref:`accept_stream` or :ref:`connect_to_stream`. .. rst-class:: classref-item-separator ---- .. _class_StreamPeerTLS_method_poll: .. rst-class:: classref-method void **poll** **(** **)** Poll the connection to check for incoming bytes. Call this right before :ref:`StreamPeer.get_available_bytes` for it to work properly. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`