Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Tree: 9ffd5f53c4
Branches Tags
godot-docs
/
classes
/
class_packetpeerdtls.rst

class_packetpeerdtls.rst 8.1 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PacketPeerDTLS.xml.
    7. 

  7. 

  8. .. _class_PacketPeerDTLS:
    9. 

  9. 

  10. PacketPeerDTLS
    11. 

  11. ==============
    12. 

  12. 

  13. **Inherits:** :ref:`PacketPeer<class_PacketPeer>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

  15. DTLS packet peer.
    16. 

  16. 

  17. .. rst-class:: classref-introduction-group
    18. 

  18. 

  19. Description
    20. 

  20. -----------
    21. 

  21. 

  22. 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>`.
    23. 

  23. 

  24. \ **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.
    25. 

  25. 

  26. \ **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.
    27. 

  27. 

  28. .. rst-class:: classref-reftable-group
    29. 

  29. 

  30. Methods
    31. 

  31. -------
    32. 

  32. 

  33. .. table::
    34. 

  34.    :widths: auto
    35. 

  35. 

  36.    +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37.    | :ref:`Error<enum_@GlobalScope_Error>`     | :ref:`connect_to_peer<class_PacketPeerDTLS_method_connect_to_peer>`\ (\ packet_peer\: :ref:`PacketPeerUDP<class_PacketPeerUDP>`, hostname\: :ref:`String<class_String>`, client_options\: :ref:`TLSOptions<class_TLSOptions>` = null\ ) |
    38. 

  38.    +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39.    | |void|                                    | :ref:`disconnect_from_peer<class_PacketPeerDTLS_method_disconnect_from_peer>`\ (\ )                                                                                                                                                     |
    40. 

  40.    +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41.    | :ref:`Status<enum_PacketPeerDTLS_Status>` | :ref:`get_status<class_PacketPeerDTLS_method_get_status>`\ (\ ) |const|                                                                                                                                                                 |
    42. 

  42.    +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43.    | |void|                                    | :ref:`poll<class_PacketPeerDTLS_method_poll>`\ (\ )                                                                                                                                                                                     |
    44. 

  44.    +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45. 

  46. .. rst-class:: classref-section-separator
    47. 

  47. 

  48. ----
    49. 

  49. 

  50. .. rst-class:: classref-descriptions-group
    51. 

  51. 

  52. Enumerations
    53. 

  53. ------------
    54. 

  54. 

  55. .. _enum_PacketPeerDTLS_Status:
    56. 

  56. 

  57. .. rst-class:: classref-enumeration
    58. 

  58. 

  59. enum **Status**: :ref:`🔗<enum_PacketPeerDTLS_Status>`
    60. 

  60. 

  61. .. _class_PacketPeerDTLS_constant_STATUS_DISCONNECTED:
    62. 

  62. 

  63. .. rst-class:: classref-enumeration-constant
    64. 

  64. 

  65. :ref:`Status<enum_PacketPeerDTLS_Status>` **STATUS_DISCONNECTED** = ``0``
    66. 

  66. 

  67. A status representing a **PacketPeerDTLS** that is disconnected.
    68. 

  68. 

  69. .. _class_PacketPeerDTLS_constant_STATUS_HANDSHAKING:
    70. 

  70. 

  71. .. rst-class:: classref-enumeration-constant
    72. 

  72. 

  73. :ref:`Status<enum_PacketPeerDTLS_Status>` **STATUS_HANDSHAKING** = ``1``
    74. 

  74. 

  75. A status representing a **PacketPeerDTLS** that is currently performing the handshake with a remote peer.
    76. 

  76. 

  77. .. _class_PacketPeerDTLS_constant_STATUS_CONNECTED:
    78. 

  78. 

  79. .. rst-class:: classref-enumeration-constant
    80. 

  80. 

  81. :ref:`Status<enum_PacketPeerDTLS_Status>` **STATUS_CONNECTED** = ``2``
    82. 

  82. 

  83. A status representing a **PacketPeerDTLS** that is connected to a remote peer.
    84. 

  84. 

  85. .. _class_PacketPeerDTLS_constant_STATUS_ERROR:
    86. 

  86. 

  87. .. rst-class:: classref-enumeration-constant
    88. 

  88. 

  89. :ref:`Status<enum_PacketPeerDTLS_Status>` **STATUS_ERROR** = ``3``
    90. 

  90. 

  91. A status representing a **PacketPeerDTLS** in a generic error state.
    92. 

  92. 

  93. .. _class_PacketPeerDTLS_constant_STATUS_ERROR_HOSTNAME_MISMATCH:
    94. 

  94. 

  95. .. rst-class:: classref-enumeration-constant
    96. 

  96. 

  97. :ref:`Status<enum_PacketPeerDTLS_Status>` **STATUS_ERROR_HOSTNAME_MISMATCH** = ``4``
    98. 

  98. 

  99. An error status that shows a mismatch in the DTLS certificate domain presented by the host and the domain requested for validation.
    100. 

  100. 

  101. .. rst-class:: classref-section-separator
    102. 

  102. 

  103. ----
    104. 

  104. 

  105. .. rst-class:: classref-descriptions-group
    106. 

  106. 

  107. Method Descriptions
    108. 

  108. -------------------
    109. 

  109. 

  110. .. _class_PacketPeerDTLS_method_connect_to_peer:
    111. 

  111. 

  112. .. rst-class:: classref-method
    113. 

  113. 

  114. :ref:`Error<enum_@GlobalScope_Error>` **connect_to_peer**\ (\ packet_peer\: :ref:`PacketPeerUDP<class_PacketPeerUDP>`, hostname\: :ref:`String<class_String>`, client_options\: :ref:`TLSOptions<class_TLSOptions>` = null\ ) :ref:`🔗<class_PacketPeerDTLS_method_connect_to_peer>`
    115. 

  115. 

  116. 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>`). You can optionally specify the ``client_options`` to be used while verifying the TLS connections. See :ref:`TLSOptions.client<class_TLSOptions_method_client>` and :ref:`TLSOptions.client_unsafe<class_TLSOptions_method_client_unsafe>`.
    117. 

  117. 

  118. .. rst-class:: classref-item-separator
    119. 

  119. 

  120. ----
    121. 

  121. 

  122. .. _class_PacketPeerDTLS_method_disconnect_from_peer:
    123. 

  123. 

  124. .. rst-class:: classref-method
    125. 

  125. 

  126. |void| **disconnect_from_peer**\ (\ ) :ref:`🔗<class_PacketPeerDTLS_method_disconnect_from_peer>`
    127. 

  127. 

  128. Disconnects this peer, terminating the DTLS session.
    129. 

  129. 

  130. .. rst-class:: classref-item-separator
    131. 

  131. 

  132. ----
    133. 

  133. 

  134. .. _class_PacketPeerDTLS_method_get_status:
    135. 

  135. 

  136. .. rst-class:: classref-method
    137. 

  137. 

  138. :ref:`Status<enum_PacketPeerDTLS_Status>` **get_status**\ (\ ) |const| :ref:`🔗<class_PacketPeerDTLS_method_get_status>`
    139. 

  139. 

  140. Returns the status of the connection. See :ref:`Status<enum_PacketPeerDTLS_Status>` for values.
    141. 

  141. 

  142. .. rst-class:: classref-item-separator
    143. 

  143. 

  144. ----
    145. 

  145. 

  146. .. _class_PacketPeerDTLS_method_poll:
    147. 

  147. 

  148. .. rst-class:: classref-method
    149. 

  149. 

  150. |void| **poll**\ (\ ) :ref:`🔗<class_PacketPeerDTLS_method_poll>`
    151. 

  151. 

  152. Poll the connection to check for incoming packets. Call this frequently to update the status and keep the connection working.
    153. 

  153. 

  154. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    155. 

  155. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    156. 

  156. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    157. 

  157. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    158. 

  158. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    159. 

  159. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    160. 

  160. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
    161. 

  161. .. |void| replace:: :abbr:`void (No return value.)`
    162. 

  162.