Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Branch: revert-8997-patch-1
Branches Tags
godot-docs
/
classes
/
class_packetpeer.rst

class_packetpeer.rst 8.7 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176 
  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/PacketPeer.xml.
    7. 

  7. 

  8. .. _class_PacketPeer:
    9. 

  9. 

  10. PacketPeer
    11. 

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

  12. 

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

  14. 

  15. **Inherited By:** :ref:`ENetPacketPeer<class_ENetPacketPeer>`, :ref:`MultiplayerPeer<class_MultiplayerPeer>`, :ref:`PacketPeerDTLS<class_PacketPeerDTLS>`, :ref:`PacketPeerExtension<class_PacketPeerExtension>`, :ref:`PacketPeerStream<class_PacketPeerStream>`, :ref:`PacketPeerUDP<class_PacketPeerUDP>`, :ref:`WebRTCDataChannel<class_WebRTCDataChannel>`, :ref:`WebSocketPeer<class_WebSocketPeer>`
    16. 

  16. 

  17. Abstraction and base class for packet-based protocols.
    18. 

  18. 

  19. .. rst-class:: classref-introduction-group
    20. 

  20. 

  21. Description
    22. 

  22. -----------
    23. 

  23. 

  24. PacketPeer is an abstraction and base class for packet-based protocols (such as UDP). It provides an API for sending and receiving packets both as raw data or variables. This makes it easy to transfer data over a protocol, without having to encode data as low-level bytes or having to worry about network ordering.
    25. 

  25. 

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

  27. 

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

  29. 

  30. Properties
    31. 

  31. ----------
    32. 

  32. 

  33. .. table::
    34. 

  34.    :widths: auto
    35. 

  35. 

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

  37.    | :ref:`int<class_int>` | :ref:`encode_buffer_max_size<class_PacketPeer_property_encode_buffer_max_size>` | ``8388608`` |
    38. 

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

  39. 

  40. .. rst-class:: classref-reftable-group
    41. 

  41. 

  42. Methods
    43. 

  43. -------
    44. 

  44. 

  45. .. table::
    46. 

  46.    :widths: auto
    47. 

  47. 

  48.    +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49.    | :ref:`int<class_int>`                         | :ref:`get_available_packet_count<class_PacketPeer_method_get_available_packet_count>` **(** **)** |const|                                 |
    50. 

  50.    +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51.    | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`get_packet<class_PacketPeer_method_get_packet>` **(** **)**                                                                         |
    52. 

  52.    +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    53. 

  53.    | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`get_packet_error<class_PacketPeer_method_get_packet_error>` **(** **)** |const|                                                     |
    54. 

  54.    +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    55. 

  55.    | :ref:`Variant<class_Variant>`                 | :ref:`get_var<class_PacketPeer_method_get_var>` **(** :ref:`bool<class_bool>` allow_objects=false **)**                                   |
    56. 

  56.    +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    57. 

  57.    | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`put_packet<class_PacketPeer_method_put_packet>` **(** :ref:`PackedByteArray<class_PackedByteArray>` buffer **)**                    |
    58. 

  58.    +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    59. 

  59.    | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`put_var<class_PacketPeer_method_put_var>` **(** :ref:`Variant<class_Variant>` var, :ref:`bool<class_bool>` full_objects=false **)** |
    60. 

  60.    +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
    61. 

  61. 

  62. .. rst-class:: classref-section-separator
    63. 

  63. 

  64. ----
    65. 

  65. 

  66. .. rst-class:: classref-descriptions-group
    67. 

  67. 

  68. Property Descriptions
    69. 

  69. ---------------------
    70. 

  70. 

  71. .. _class_PacketPeer_property_encode_buffer_max_size:
    72. 

  72. 

  73. .. rst-class:: classref-property
    74. 

  74. 

  75. :ref:`int<class_int>` **encode_buffer_max_size** = ``8388608``
    76. 

  76. 

  77. .. rst-class:: classref-property-setget
    78. 

  78. 

  79. - void **set_encode_buffer_max_size** **(** :ref:`int<class_int>` value **)**
    80. 

  80. - :ref:`int<class_int>` **get_encode_buffer_max_size** **(** **)**
    81. 

  81. 

  82. Maximum buffer size allowed when encoding :ref:`Variant<class_Variant>`\ s. Raise this value to support heavier memory allocations.
    83. 

  83. 

  84. The :ref:`put_var<class_PacketPeer_method_put_var>` method allocates memory on the stack, and the buffer used will grow automatically to the closest power of two to match the size of the :ref:`Variant<class_Variant>`. If the :ref:`Variant<class_Variant>` is bigger than :ref:`encode_buffer_max_size<class_PacketPeer_property_encode_buffer_max_size>`, the method will error out with :ref:`@GlobalScope.ERR_OUT_OF_MEMORY<class_@GlobalScope_constant_ERR_OUT_OF_MEMORY>`.
    85. 

  85. 

  86. .. rst-class:: classref-section-separator
    87. 

  87. 

  88. ----
    89. 

  89. 

  90. .. rst-class:: classref-descriptions-group
    91. 

  91. 

  92. Method Descriptions
    93. 

  93. -------------------
    94. 

  94. 

  95. .. _class_PacketPeer_method_get_available_packet_count:
    96. 

  96. 

  97. .. rst-class:: classref-method
    98. 

  98. 

  99. :ref:`int<class_int>` **get_available_packet_count** **(** **)** |const|
    100. 

  100. 

  101. Returns the number of packets currently available in the ring-buffer.
    102. 

  102. 

  103. .. rst-class:: classref-item-separator
    104. 

  104. 

  105. ----
    106. 

  106. 

  107. .. _class_PacketPeer_method_get_packet:
    108. 

  108. 

  109. .. rst-class:: classref-method
    110. 

  110. 

  111. :ref:`PackedByteArray<class_PackedByteArray>` **get_packet** **(** **)**
    112. 

  112. 

  113. Gets a raw packet.
    114. 

  114. 

  115. .. rst-class:: classref-item-separator
    116. 

  116. 

  117. ----
    118. 

  118. 

  119. .. _class_PacketPeer_method_get_packet_error:
    120. 

  120. 

  121. .. rst-class:: classref-method
    122. 

  122. 

  123. :ref:`Error<enum_@GlobalScope_Error>` **get_packet_error** **(** **)** |const|
    124. 

  124. 

  125. Returns the error state of the last packet received (via :ref:`get_packet<class_PacketPeer_method_get_packet>` and :ref:`get_var<class_PacketPeer_method_get_var>`).
    126. 

  126. 

  127. .. rst-class:: classref-item-separator
    128. 

  128. 

  129. ----
    130. 

  130. 

  131. .. _class_PacketPeer_method_get_var:
    132. 

  132. 

  133. .. rst-class:: classref-method
    134. 

  134. 

  135. :ref:`Variant<class_Variant>` **get_var** **(** :ref:`bool<class_bool>` allow_objects=false **)**
    136. 

  136. 

  137. Gets a Variant. If ``allow_objects`` is ``true``, decoding objects is allowed.
    138. 

  138. 

  139. Internally, this uses the same decoding mechanism as the :ref:`@GlobalScope.bytes_to_var<class_@GlobalScope_method_bytes_to_var>` method.
    140. 

  140. 

  141. \ **Warning:** Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.
    142. 

  142. 

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

  144. 

  145. ----
    146. 

  146. 

  147. .. _class_PacketPeer_method_put_packet:
    148. 

  148. 

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

  150. 

  151. :ref:`Error<enum_@GlobalScope_Error>` **put_packet** **(** :ref:`PackedByteArray<class_PackedByteArray>` buffer **)**
    152. 

  152. 

  153. Sends a raw packet.
    154. 

  154. 

  155. .. rst-class:: classref-item-separator
    156. 

  156. 

  157. ----
    158. 

  158. 

  159. .. _class_PacketPeer_method_put_var:
    160. 

  160. 

  161. .. rst-class:: classref-method
    162. 

  162. 

  163. :ref:`Error<enum_@GlobalScope_Error>` **put_var** **(** :ref:`Variant<class_Variant>` var, :ref:`bool<class_bool>` full_objects=false **)**
    164. 

  164. 

  165. Sends a :ref:`Variant<class_Variant>` as a packet. If ``full_objects`` is ``true``, encoding objects is allowed (and can potentially include code).
    166. 

  166. 

  167. Internally, this uses the same encoding mechanism as the :ref:`@GlobalScope.var_to_bytes<class_@GlobalScope_method_var_to_bytes>` method.
    168. 

  168. 

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

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

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

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

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

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

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

  176.