godot/core/io/packet_peer.h

110 lines
4.3 KiB
C++
Raw Normal View History

2014-02-10 09:10:30 +08:00
/*************************************************************************/
/* packet_peer.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
2014-02-10 09:10:30 +08:00
/*************************************************************************/
/* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md) */
2014-02-10 09:10:30 +08:00
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/*************************************************************************/
2014-02-10 09:10:30 +08:00
#ifndef PACKET_PEER_H
#define PACKET_PEER_H
#include "core/io/stream_peer.h"
#include "core/object.h"
#include "core/ring_buffer.h"
2014-02-10 09:10:30 +08:00
class PacketPeer : public Reference {
GDCLASS(PacketPeer, Reference);
2014-02-10 09:10:30 +08:00
Variant _bnd_get_var(bool p_allow_objects = false);
2014-02-10 09:10:30 +08:00
static void _bind_methods();
Error _put_packet(const PoolVector<uint8_t> &p_buffer);
PoolVector<uint8_t> _get_packet();
Error _get_packet_error() const;
mutable Error last_get_error;
bool allow_object_decoding;
2014-02-10 09:10:30 +08:00
public:
virtual int get_available_packet_count() const = 0;
virtual Error get_packet(const uint8_t **r_buffer, int &r_buffer_size) = 0; ///< buffer is GONE after next get_packet
virtual Error put_packet(const uint8_t *p_buffer, int p_buffer_size) = 0;
2014-02-10 09:10:30 +08:00
virtual int get_max_packet_size() const = 0;
2014-02-10 09:10:30 +08:00
/* helpers / binders */
virtual Error get_packet_buffer(PoolVector<uint8_t> &r_buffer);
virtual Error put_packet_buffer(const PoolVector<uint8_t> &p_buffer);
2014-02-10 09:10:30 +08:00
virtual Error get_var(Variant &r_variant, bool p_allow_objects = false);
virtual Error put_var(const Variant &p_packet, bool p_full_objects = false);
2014-02-10 09:10:30 +08:00
void set_allow_object_decoding(bool p_enable);
bool is_object_decoding_allowed() const;
2014-02-10 09:10:30 +08:00
PacketPeer();
~PacketPeer() {}
2014-02-10 09:10:30 +08:00
};
class PacketPeerStream : public PacketPeer {
GDCLASS(PacketPeerStream, PacketPeer);
2014-02-10 09:10:30 +08:00
//the way the buffers work sucks, will change later
mutable Ref<StreamPeer> peer;
mutable RingBuffer<uint8_t> ring_buffer;
mutable Vector<uint8_t> input_buffer;
mutable Vector<uint8_t> output_buffer;
2014-02-10 09:10:30 +08:00
Error _poll_buffer() const;
protected:
2014-02-10 09:10:30 +08:00
void _set_stream_peer(REF p_peer);
static void _bind_methods();
public:
2014-02-10 09:10:30 +08:00
virtual int get_available_packet_count() const;
virtual Error get_packet(const uint8_t **r_buffer, int &r_buffer_size);
virtual Error put_packet(const uint8_t *p_buffer, int p_buffer_size);
2014-02-10 09:10:30 +08:00
virtual int get_max_packet_size() const;
void set_stream_peer(const Ref<StreamPeer> &p_peer);
Ref<StreamPeer> get_stream_peer() const;
2014-02-10 09:10:30 +08:00
void set_input_buffer_max_size(int p_max_size);
int get_input_buffer_max_size() const;
void set_output_buffer_max_size(int p_max_size);
int get_output_buffer_max_size() const;
2014-02-10 09:10:30 +08:00
PacketPeerStream();
};
#endif // PACKET_STREAM_H