class_packetpeerdtls.rst 6.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the PacketPeerDTLS.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_PacketPeerDTLS:
  6. PacketPeerDTLS
  7. ==============
  8. **Inherits:** :ref:`PacketPeer<class_PacketPeer>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. DTLS packet peer.
  10. Description
  11. -----------
  12. 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<class_DTLSServer_method_take_connection>`.
  13. Methods
  14. -------
  15. +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  16. | :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 **)** |
  17. +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  18. | void | :ref:`disconnect_from_peer<class_PacketPeerDTLS_method_disconnect_from_peer>` **(** **)** |
  19. +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`Status<enum_PacketPeerDTLS_Status>` | :ref:`get_status<class_PacketPeerDTLS_method_get_status>` **(** **)** |const| |
  21. +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`poll<class_PacketPeerDTLS_method_poll>` **(** **)** |
  23. +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. Enumerations
  25. ------------
  26. .. _enum_PacketPeerDTLS_Status:
  27. .. _class_PacketPeerDTLS_constant_STATUS_DISCONNECTED:
  28. .. _class_PacketPeerDTLS_constant_STATUS_HANDSHAKING:
  29. .. _class_PacketPeerDTLS_constant_STATUS_CONNECTED:
  30. .. _class_PacketPeerDTLS_constant_STATUS_ERROR:
  31. .. _class_PacketPeerDTLS_constant_STATUS_ERROR_HOSTNAME_MISMATCH:
  32. enum **Status**:
  33. - **STATUS_DISCONNECTED** = **0** --- A status representing a ``PacketPeerDTLS`` that is disconnected.
  34. - **STATUS_HANDSHAKING** = **1** --- A status representing a ``PacketPeerDTLS`` that is currently performing the handshake with a remote peer.
  35. - **STATUS_CONNECTED** = **2** --- A status representing a ``PacketPeerDTLS`` that is connected to a remote peer.
  36. - **STATUS_ERROR** = **3** --- A status representing a ``PacketPeerDTLS`` in a generic error state.
  37. - **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.
  38. Method Descriptions
  39. -------------------
  40. .. _class_PacketPeerDTLS_method_connect_to_peer:
  41. - :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 **)**
  42. Connects a ``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.
  43. ----
  44. .. _class_PacketPeerDTLS_method_disconnect_from_peer:
  45. - void **disconnect_from_peer** **(** **)**
  46. Disconnects this peer, terminating the DTLS session.
  47. ----
  48. .. _class_PacketPeerDTLS_method_get_status:
  49. - :ref:`Status<enum_PacketPeerDTLS_Status>` **get_status** **(** **)** |const|
  50. Returns the status of the connection. See :ref:`Status<enum_PacketPeerDTLS_Status>` for values.
  51. ----
  52. .. _class_PacketPeerDTLS_method_poll:
  53. - void **poll** **(** **)**
  54. Poll the connection to check for incoming packets. Call this frequently to update the status and keep the connection working.
  55. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  56. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  57. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`