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
31#ifndef PACKET_PEER_H
32#define PACKET_PEER_H
33
34#include "core/io/stream_peer.h"
35#include "core/object/class_db.h"
36#include "core/templates/ring_buffer.h"
37
38#include "core/extension/ext_wrappers.gen.inc"
39#include "core/object/gdvirtual.gen.inc"
40#include "core/variant/native_ptr.h"
41
42class PacketPeer : public RefCounted {
43 GDCLASS(PacketPeer, RefCounted);
44
45 Variant _bnd_get_var(bool p_allow_objects = false);
46
47 static void _bind_methods();
48
49 Error _put_packet(const Vector<uint8_t> &p_buffer);
50 Vector<uint8_t> _get_packet();
51 Error _get_packet_error() const;
52
53 mutable Error last_get_error = OK;
54
55 int encode_buffer_max_size = 8 * 1024 * 1024;
56 Vector<uint8_t> encode_buffer;
57
58public:
59 virtual int get_available_packet_count() const = 0;
60 virtual Error get_packet(const uint8_t **r_buffer, int &r_buffer_size) = 0; ///< buffer is GONE after next get_packet
61 virtual Error put_packet(const uint8_t *p_buffer, int p_buffer_size) = 0;
62
63 virtual int get_max_packet_size() const = 0;
64
65 /* helpers / binders */
66
67 virtual Error get_packet_buffer(Vector<uint8_t> &r_buffer);
68 virtual Error put_packet_buffer(const Vector<uint8_t> &p_buffer);
69
70 virtual Error get_var(Variant &r_variant, bool p_allow_objects = false);
71 virtual Error put_var(const Variant &p_packet, bool p_full_objects = false);
72
73 void set_encode_buffer_max_size(int p_max_size);
74 int get_encode_buffer_max_size() const;
75
76 PacketPeer() {}
77 ~PacketPeer() {}
78};
79
80class PacketPeerExtension : public PacketPeer {
81 GDCLASS(PacketPeerExtension, PacketPeer);
82
83protected:
84 static void _bind_methods();
85
86public:
87 virtual Error get_packet(const uint8_t **r_buffer, int &r_buffer_size) override; ///< buffer is GONE after next get_packet
88 GDVIRTUAL2R(Error, _get_packet, GDExtensionConstPtr<const uint8_t *>, GDExtensionPtr<int>);
89
90 virtual Error put_packet(const uint8_t *p_buffer, int p_buffer_size) override;
91 GDVIRTUAL2R(Error, _put_packet, GDExtensionConstPtr<const uint8_t>, int);
92
93 EXBIND0RC(int, get_available_packet_count);
94 EXBIND0RC(int, get_max_packet_size);
95};
96
97class PacketPeerStream : public PacketPeer {
98 GDCLASS(PacketPeerStream, PacketPeer);
99
100 //the way the buffers work sucks, will change later
101
102 mutable Ref<StreamPeer> peer;
103 mutable RingBuffer<uint8_t> ring_buffer;
104 mutable Vector<uint8_t> input_buffer;
105 mutable Vector<uint8_t> output_buffer;
106
107 Error _poll_buffer() const;
108
109protected:
110 static void _bind_methods();
111
112public:
113 virtual int get_available_packet_count() const override;
114 virtual Error get_packet(const uint8_t **r_buffer, int &r_buffer_size) override;
115 virtual Error put_packet(const uint8_t *p_buffer, int p_buffer_size) override;
116
117 virtual int get_max_packet_size() const override;
118
119 void set_stream_peer(const Ref<StreamPeer> &p_peer);
120 Ref<StreamPeer> get_stream_peer() const;
121 void set_input_buffer_max_size(int p_max_size);
122 int get_input_buffer_max_size() const;
123 void set_output_buffer_max_size(int p_max_size);
124 int get_output_buffer_max_size() const;
125 PacketPeerStream();
126};
127
128#endif // PACKET_PEER_H
129