:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PacketPeerDTLS.xml. .. _class_PacketPeerDTLS: PacketPeerDTLS ============== **Inherits:** :ref:`PacketPeer` **<** :ref:`RefCounted` **<** :ref:`Object` DTLS packet peer. .. rst-class:: classref-introduction-group Description ----------- This class represents a DTLS peer connection. It can be used to connect to a DTLS server, and is returned by :ref:`DTLSServer.take_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. \ **Warning:** TLS certificate revocation and certificate pinning are currently not supported. Revoked certificates are accepted as long as they are otherwise valid. If this is a concern, you may want to use automatically managed certificates with a short validity period. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`connect_to_peer`\ (\ packet_peer\: :ref:`PacketPeerUDP`, hostname\: :ref:`String`, client_options\: :ref:`TLSOptions` = null\ ) | +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`disconnect_from_peer`\ (\ ) | +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Status` | :ref:`get_status`\ (\ ) |const| | +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`poll`\ (\ ) | +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_PacketPeerDTLS_Status: .. rst-class:: classref-enumeration enum **Status**: :ref:`🔗` .. _class_PacketPeerDTLS_constant_STATUS_DISCONNECTED: .. rst-class:: classref-enumeration-constant :ref:`Status` **STATUS_DISCONNECTED** = ``0`` A status representing a **PacketPeerDTLS** that is disconnected. .. _class_PacketPeerDTLS_constant_STATUS_HANDSHAKING: .. rst-class:: classref-enumeration-constant :ref:`Status` **STATUS_HANDSHAKING** = ``1`` A status representing a **PacketPeerDTLS** that is currently performing the handshake with a remote peer. .. _class_PacketPeerDTLS_constant_STATUS_CONNECTED: .. rst-class:: classref-enumeration-constant :ref:`Status` **STATUS_CONNECTED** = ``2`` A status representing a **PacketPeerDTLS** that is connected to a remote peer. .. _class_PacketPeerDTLS_constant_STATUS_ERROR: .. rst-class:: classref-enumeration-constant :ref:`Status` **STATUS_ERROR** = ``3`` A status representing a **PacketPeerDTLS** in a generic error state. .. _class_PacketPeerDTLS_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 DTLS 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_PacketPeerDTLS_method_connect_to_peer: .. rst-class:: classref-method :ref:`Error` **connect_to_peer**\ (\ packet_peer\: :ref:`PacketPeerUDP`, hostname\: :ref:`String`, client_options\: :ref:`TLSOptions` = null\ ) :ref:`🔗` Connects a ``packet_peer`` beginning the DTLS handshake using the underlying :ref:`PacketPeerUDP` which must be connected (see :ref:`PacketPeerUDP.connect_to_host()`). You can optionally specify the ``client_options`` to be used while verifying the TLS connections. See :ref:`TLSOptions.client()` and :ref:`TLSOptions.client_unsafe()`. .. rst-class:: classref-item-separator ---- .. _class_PacketPeerDTLS_method_disconnect_from_peer: .. rst-class:: classref-method |void| **disconnect_from_peer**\ (\ ) :ref:`🔗` Disconnects this peer, terminating the DTLS session. .. rst-class:: classref-item-separator ---- .. _class_PacketPeerDTLS_method_get_status: .. rst-class:: classref-method :ref:`Status` **get_status**\ (\ ) |const| :ref:`🔗` Returns the status of the connection. .. rst-class:: classref-item-separator ---- .. _class_PacketPeerDTLS_method_poll: .. rst-class:: classref-method |void| **poll**\ (\ ) :ref:`🔗` Poll the connection to check for incoming packets. Call this frequently to update the status and keep the connection working. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)` .. |void| replace:: :abbr:`void (No return value.)`