class_packetpeerextension.rst 3.4 KB

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