1 /*************************************************************************/ 2 /* stream_peer.h */ 3 /*************************************************************************/ 4 /* This file is part of: */ 5 /* GODOT ENGINE */ 6 /* https://godotengine.org */ 7 /*************************************************************************/ 8 /* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur. */ 9 /* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md) */ 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 #ifndef STREAM_PEER_H 31 #define STREAM_PEER_H 32 33 #include "reference.h" 34 35 class StreamPeer : public Reference { 36 OBJ_TYPE(StreamPeer, Reference); 37 OBJ_CATEGORY("Networking"); 38 39 protected: 40 static void _bind_methods(); 41 42 //bind helpers 43 Error _put_data(const DVector<uint8_t> &p_data); 44 Array _put_partial_data(const DVector<uint8_t> &p_data); 45 46 Array _get_data(int p_bytes); 47 Array _get_partial_data(int p_bytes); 48 49 bool big_endian; 50 51 public: 52 virtual Error put_data(const uint8_t *p_data, int p_bytes) = 0; ///< put a whole chunk of data, blocking until it sent 53 virtual Error put_partial_data(const uint8_t *p_data, int p_bytes, int &r_sent) = 0; ///< put as much data as possible, without blocking. 54 55 virtual Error get_data(uint8_t *p_buffer, int p_bytes) = 0; ///< read p_bytes of data, if p_bytes > available, it will block 56 virtual Error get_partial_data(uint8_t *p_buffer, int p_bytes, int &r_received) = 0; ///< read as much data as p_bytes into buffer, if less was read, return in r_received 57 58 virtual int get_available_bytes() const = 0; 59 60 void set_big_endian(bool p_enable); 61 bool is_big_endian_enabled() const; 62 63 void put_8(int8_t p_val); 64 void put_u8(uint8_t p_val); 65 void put_16(int16_t p_val); 66 void put_u16(uint16_t p_val); 67 void put_32(int32_t p_val); 68 void put_u32(uint32_t p_val); 69 void put_64(int64_t p_val); 70 void put_u64(uint64_t p_val); 71 void put_float(float p_val); 72 void put_double(double p_val); 73 void put_utf8_string(const String &p_string); 74 void put_var(const Variant &p_variant); 75 76 uint8_t get_u8(); 77 int8_t get_8(); 78 uint16_t get_u16(); 79 int16_t get_16(); 80 uint32_t get_u32(); 81 int32_t get_32(); 82 uint64_t get_u64(); 83 int64_t get_64(); 84 float get_float(); 85 float get_double(); 86 String get_string(int p_bytes); 87 String get_utf8_string(int p_bytes); 88 Variant get_var(); 89 StreamPeer()90 StreamPeer() { big_endian = false; } 91 }; 92 93 class StreamPeerBuffer : public StreamPeer { 94 OBJ_TYPE(StreamPeerBuffer, StreamPeer); 95 OBJ_CATEGORY("Networking"); 96 97 DVector<uint8_t> data; 98 int pointer; 99 100 protected: 101 static void _bind_methods(); 102 103 public: 104 Error put_data(const uint8_t *p_data, int p_bytes); 105 Error put_partial_data(const uint8_t *p_data, int p_bytes, int &r_sent); 106 107 Error get_data(uint8_t *p_buffer, int p_bytes); 108 Error get_partial_data(uint8_t *p_buffer, int p_bytes, int &r_received); 109 110 int get_available_bytes() const; 111 112 void seek(int p_pos); 113 int get_size() const; 114 int get_pos() const; 115 void resize(int p_size); 116 117 void set_data_array(const DVector<uint8_t> &p_data); 118 DVector<uint8_t> get_data_array() const; 119 120 void clear(); 121 122 Ref<StreamPeerBuffer> duplicate() const; 123 124 StreamPeerBuffer(); 125 }; 126 127 #endif // STREAM_PEER_H 128