class_streampeerextension.rst 4.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  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/StreamPeerExtension.xml.
  6. .. _class_StreamPeerExtension:
  7. StreamPeerExtension
  8. ===================
  9. **Inherits:** :ref:`StreamPeer<class_StreamPeer>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Methods
  11. -------
  12. +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  13. | :ref:`int<class_int>` | :ref:`_get_available_bytes<class_StreamPeerExtension_method__get_available_bytes>` **(** **)** |virtual| |const| |
  14. +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`int<class_int>` | :ref:`_get_data<class_StreamPeerExtension_method__get_data>` **(** uint8_t* r_buffer, :ref:`int<class_int>` r_bytes, int32_t* r_received **)** |virtual| |
  16. +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`int<class_int>` | :ref:`_get_partial_data<class_StreamPeerExtension_method__get_partial_data>` **(** uint8_t* r_buffer, :ref:`int<class_int>` r_bytes, int32_t* r_received **)** |virtual| |
  18. +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`int<class_int>` | :ref:`_put_data<class_StreamPeerExtension_method__put_data>` **(** const uint8_t* p_data, :ref:`int<class_int>` p_bytes, int32_t* r_sent **)** |virtual| |
  20. +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`int<class_int>` | :ref:`_put_partial_data<class_StreamPeerExtension_method__put_partial_data>` **(** const uint8_t* p_data, :ref:`int<class_int>` p_bytes, int32_t* r_sent **)** |virtual| |
  22. +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. Method Descriptions
  24. -------------------
  25. .. _class_StreamPeerExtension_method__get_available_bytes:
  26. - :ref:`int<class_int>` **_get_available_bytes** **(** **)** |virtual| |const|
  27. ----
  28. .. _class_StreamPeerExtension_method__get_data:
  29. - :ref:`int<class_int>` **_get_data** **(** uint8_t* r_buffer, :ref:`int<class_int>` r_bytes, int32_t* r_received **)** |virtual|
  30. ----
  31. .. _class_StreamPeerExtension_method__get_partial_data:
  32. - :ref:`int<class_int>` **_get_partial_data** **(** uint8_t* r_buffer, :ref:`int<class_int>` r_bytes, int32_t* r_received **)** |virtual|
  33. ----
  34. .. _class_StreamPeerExtension_method__put_data:
  35. - :ref:`int<class_int>` **_put_data** **(** const uint8_t* p_data, :ref:`int<class_int>` p_bytes, int32_t* r_sent **)** |virtual|
  36. ----
  37. .. _class_StreamPeerExtension_method__put_partial_data:
  38. - :ref:`int<class_int>` **_put_partial_data** **(** const uint8_t* p_data, :ref:`int<class_int>` p_bytes, int32_t* r_sent **)** |virtual|
  39. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  40. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  41. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  42. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  43. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  44. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`