packet_peer.h 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  1. /**************************************************************************/
  2. /* packet_peer.h */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #pragma once
  31. #include "core/io/stream_peer.h"
  32. #include "core/object/class_db.h"
  33. #include "core/templates/ring_buffer.h"
  34. #include "core/extension/ext_wrappers.gen.inc"
  35. #include "core/object/gdvirtual.gen.inc"
  36. #include "core/variant/native_ptr.h"
  37. class PacketPeer : public RefCounted {
  38. GDCLASS(PacketPeer, RefCounted);
  39. Variant _bnd_get_var(bool p_allow_objects = false);
  40. static void _bind_methods();
  41. Error _put_packet(const Vector<uint8_t> &p_buffer);
  42. Vector<uint8_t> _get_packet();
  43. Error _get_packet_error() const;
  44. mutable Error last_get_error = OK;
  45. int encode_buffer_max_size = 8 * 1024 * 1024;
  46. Vector<uint8_t> encode_buffer;
  47. public:
  48. virtual int get_available_packet_count() const = 0;
  49. virtual Error get_packet(const uint8_t **r_buffer, int &r_buffer_size) = 0; ///< buffer is GONE after next get_packet
  50. virtual Error put_packet(const uint8_t *p_buffer, int p_buffer_size) = 0;
  51. virtual int get_max_packet_size() const = 0;
  52. /* helpers / binders */
  53. virtual Error get_packet_buffer(Vector<uint8_t> &r_buffer);
  54. virtual Error put_packet_buffer(const Vector<uint8_t> &p_buffer);
  55. virtual Error get_var(Variant &r_variant, bool p_allow_objects = false);
  56. virtual Error put_var(const Variant &p_packet, bool p_full_objects = false);
  57. void set_encode_buffer_max_size(int p_max_size);
  58. int get_encode_buffer_max_size() const;
  59. PacketPeer() {}
  60. ~PacketPeer() {}
  61. };
  62. class PacketPeerExtension : public PacketPeer {
  63. GDCLASS(PacketPeerExtension, PacketPeer);
  64. protected:
  65. static void _bind_methods();
  66. public:
  67. virtual Error get_packet(const uint8_t **r_buffer, int &r_buffer_size) override; ///< buffer is GONE after next get_packet
  68. GDVIRTUAL2R(Error, _get_packet, GDExtensionConstPtr<const uint8_t *>, GDExtensionPtr<int>);
  69. virtual Error put_packet(const uint8_t *p_buffer, int p_buffer_size) override;
  70. GDVIRTUAL2R(Error, _put_packet, GDExtensionConstPtr<const uint8_t>, int);
  71. EXBIND0RC(int, get_available_packet_count);
  72. EXBIND0RC(int, get_max_packet_size);
  73. };
  74. class PacketPeerStream : public PacketPeer {
  75. GDCLASS(PacketPeerStream, PacketPeer);
  76. //the way the buffers work sucks, will change later
  77. mutable Ref<StreamPeer> peer;
  78. mutable RingBuffer<uint8_t> ring_buffer;
  79. mutable Vector<uint8_t> input_buffer;
  80. mutable Vector<uint8_t> output_buffer;
  81. Error _poll_buffer() const;
  82. protected:
  83. static void _bind_methods();
  84. public:
  85. virtual int get_available_packet_count() const override;
  86. virtual Error get_packet(const uint8_t **r_buffer, int &r_buffer_size) override;
  87. virtual Error put_packet(const uint8_t *p_buffer, int p_buffer_size) override;
  88. virtual int get_max_packet_size() const override;
  89. void set_stream_peer(const Ref<StreamPeer> &p_peer);
  90. Ref<StreamPeer> get_stream_peer() const;
  91. void set_input_buffer_max_size(int p_max_size);
  92. int get_input_buffer_max_size() const;
  93. void set_output_buffer_max_size(int p_max_size);
  94. int get_output_buffer_max_size() const;
  95. PacketPeerStream();
  96. };