class_packetpeerextension.rst 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PacketPeerExtension.xml.
  6. .. _class_PacketPeerExtension:
  7. PacketPeerExtension
  8. ===================
  9. **Inherits:** :ref:`PacketPeer<class_PacketPeer>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Methods
  11. -------
  12. +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
  13. | :ref:`int<class_int>` | :ref:`_get_available_packet_count<class_PacketPeerExtension_method__get_available_packet_count>` **(** **)** |virtual| |const| |
  14. +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`int<class_int>` | :ref:`_get_max_packet_size<class_PacketPeerExtension_method__get_max_packet_size>` **(** **)** |virtual| |const| |
  16. +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`int<class_int>` | :ref:`_get_packet<class_PacketPeerExtension_method__get_packet>` **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| |
  18. +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`int<class_int>` | :ref:`_put_packet<class_PacketPeerExtension_method__put_packet>` **(** const uint8_t* p_buffer, :ref:`int<class_int>` p_buffer_size **)** |virtual| |
  20. +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+
  21. Method Descriptions
  22. -------------------
  23. .. _class_PacketPeerExtension_method__get_available_packet_count:
  24. - :ref:`int<class_int>` **_get_available_packet_count** **(** **)** |virtual| |const|
  25. ----
  26. .. _class_PacketPeerExtension_method__get_max_packet_size:
  27. - :ref:`int<class_int>` **_get_max_packet_size** **(** **)** |virtual| |const|
  28. ----
  29. .. _class_PacketPeerExtension_method__get_packet:
  30. - :ref:`int<class_int>` **_get_packet** **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual|
  31. ----
  32. .. _class_PacketPeerExtension_method__put_packet:
  33. - :ref:`int<class_int>` **_put_packet** **(** const uint8_t* p_buffer, :ref:`int<class_int>` p_buffer_size **)** |virtual|
  34. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  35. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  36. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  37. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  38. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  39. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`