godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (f87858a8f)

Browse Source
This commit is contained in:
Yuri Sizov
2022-12-05 20:38:58 +03:00
parent 913ff5e602
commit a7745c4cc4
843 changed files with 158186 additions and 80821 deletions
Download Patch File Download Diff File Expand all files Collapse all files

111
classes/class_packetpeerdtls.rst
View File

@@ -14,6 +14,8 @@ PacketPeerDTLS
DTLS packet peer.
.. rst-class:: classref-introduction-group
Description
-----------
@@ -23,76 +25,129 @@ This class represents a DTLS peer connection. It can be used to connect to a DTL
\ **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
-------
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`connect_to_peer<class_PacketPeerDTLS_method_connect_to_peer>` **(** :ref:`PacketPeerUDP<class_PacketPeerUDP>` packet_peer, :ref:`bool<class_bool>` validate_certs=true, :ref:`String<class_String>` for_hostname="", :ref:`X509Certificate<class_X509Certificate>` valid_certificate=null **)** |
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`disconnect_from_peer<class_PacketPeerDTLS_method_disconnect_from_peer>` **(** **)** |
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Status<enum_PacketPeerDTLS_Status>` | :ref:`get_status<class_PacketPeerDTLS_method_get_status>` **(** **)** |const| |
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`poll<class_PacketPeerDTLS_method_poll>` **(** **)** |
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. table::
:widths: auto
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`connect_to_peer<class_PacketPeerDTLS_method_connect_to_peer>` **(** :ref:`PacketPeerUDP<class_PacketPeerUDP>` packet_peer, :ref:`bool<class_bool>` validate_certs=true, :ref:`String<class_String>` for_hostname="", :ref:`X509Certificate<class_X509Certificate>` valid_certificate=null **)** |
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`disconnect_from_peer<class_PacketPeerDTLS_method_disconnect_from_peer>` **(** **)** |
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Status<enum_PacketPeerDTLS_Status>` | :ref:`get_status<class_PacketPeerDTLS_method_get_status>` **(** **)** |const| |
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`poll<class_PacketPeerDTLS_method_poll>` **(** **)** |
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Enumerations
------------
.. _enum_PacketPeerDTLS_Status:
.. _class_PacketPeerDTLS_constant_STATUS_DISCONNECTED:
.. _class_PacketPeerDTLS_constant_STATUS_HANDSHAKING:
.. _class_PacketPeerDTLS_constant_STATUS_CONNECTED:
.. _class_PacketPeerDTLS_constant_STATUS_ERROR:
.. _class_PacketPeerDTLS_constant_STATUS_ERROR_HOSTNAME_MISMATCH:
.. rst-class:: classref-enumeration
enum **Status**:
- **STATUS_DISCONNECTED** = **0** --- A status representing a ``PacketPeerDTLS`` that is disconnected.
.. _class_PacketPeerDTLS_constant_STATUS_DISCONNECTED:
- **STATUS_HANDSHAKING** = **1** --- A status representing a ``PacketPeerDTLS`` that is currently performing the handshake with a remote peer.
.. rst-class:: classref-enumeration-constant
- **STATUS_CONNECTED** = **2** --- A status representing a ``PacketPeerDTLS`` that is connected to a remote peer.
:ref:`Status<enum_PacketPeerDTLS_Status>` **STATUS_DISCONNECTED** = ``0``
- **STATUS_ERROR** = **3** --- A status representing a ``PacketPeerDTLS`` in a generic error state.
A status representing a **PacketPeerDTLS** that is disconnected.
- **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.
.. _class_PacketPeerDTLS_constant_STATUS_HANDSHAKING:
.. rst-class:: classref-enumeration-constant
:ref:`Status<enum_PacketPeerDTLS_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<enum_PacketPeerDTLS_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<enum_PacketPeerDTLS_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<enum_PacketPeerDTLS_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:
- :ref:`Error<enum_@GlobalScope_Error>` **connect_to_peer** **(** :ref:`PacketPeerUDP<class_PacketPeerUDP>` packet_peer, :ref:`bool<class_bool>` validate_certs=true, :ref:`String<class_String>` for_hostname="", :ref:`X509Certificate<class_X509Certificate>` valid_certificate=null **)**
.. rst-class:: classref-method
Connects a ``packet_peer`` beginning the DTLS handshake using the underlying :ref:`PacketPeerUDP<class_PacketPeerUDP>` which must be connected (see :ref:`PacketPeerUDP.connect_to_host<class_PacketPeerUDP_method_connect_to_host>`). If ``validate_certs`` is ``true``, ``PacketPeerDTLS`` will validate that the certificate presented by the remote peer and match it with the ``for_hostname`` argument. You can specify a custom :ref:`X509Certificate<class_X509Certificate>` to use for validation via the ``valid_certificate`` argument.
:ref:`Error<enum_@GlobalScope_Error>` **connect_to_peer** **(** :ref:`PacketPeerUDP<class_PacketPeerUDP>` packet_peer, :ref:`bool<class_bool>` validate_certs=true, :ref:`String<class_String>` for_hostname="", :ref:`X509Certificate<class_X509Certificate>` valid_certificate=null **)**
Connects a ``packet_peer`` beginning the DTLS handshake using the underlying :ref:`PacketPeerUDP<class_PacketPeerUDP>` which must be connected (see :ref:`PacketPeerUDP.connect_to_host<class_PacketPeerUDP_method_connect_to_host>`). If ``validate_certs`` is ``true``, **PacketPeerDTLS** will validate that the certificate presented by the remote peer and match it with the ``for_hostname`` argument. You can specify a custom :ref:`X509Certificate<class_X509Certificate>` to use for validation via the ``valid_certificate`` argument.
.. rst-class:: classref-item-separator
----
.. _class_PacketPeerDTLS_method_disconnect_from_peer:
- void **disconnect_from_peer** **(** **)**
.. rst-class:: classref-method
void **disconnect_from_peer** **(** **)**
Disconnects this peer, terminating the DTLS session.
.. rst-class:: classref-item-separator
----
.. _class_PacketPeerDTLS_method_get_status:
- :ref:`Status<enum_PacketPeerDTLS_Status>` **get_status** **(** **)** |const|
.. rst-class:: classref-method
:ref:`Status<enum_PacketPeerDTLS_Status>` **get_status** **(** **)** |const|
Returns the status of the connection. See :ref:`Status<enum_PacketPeerDTLS_Status>` for values.
.. rst-class:: classref-item-separator
----
.. _class_PacketPeerDTLS_method_poll:
- void **poll** **(** **)**
.. rst-class:: classref-method
void **poll** **(** **)**
Poll the connection to check for incoming packets. Call this frequently to update the status and keep the connection working.