d95794ec8a
As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
136 lines
4.9 KiB
C++
136 lines
4.9 KiB
C++
/**************************************************************************/
|
|
/* enet_multiplayer_peer.h */
|
|
/**************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/**************************************************************************/
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* 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. */
|
|
/**************************************************************************/
|
|
|
|
#ifndef ENET_MULTIPLAYER_PEER_H
|
|
#define ENET_MULTIPLAYER_PEER_H
|
|
|
|
#include "core/crypto/crypto.h"
|
|
#include "scene/main/multiplayer_peer.h"
|
|
|
|
#include "enet_connection.h"
|
|
#include <enet/enet.h>
|
|
|
|
class ENetMultiplayerPeer : public MultiplayerPeer {
|
|
GDCLASS(ENetMultiplayerPeer, MultiplayerPeer);
|
|
|
|
private:
|
|
enum {
|
|
SYSMSG_ADD_PEER,
|
|
SYSMSG_REMOVE_PEER
|
|
};
|
|
|
|
enum {
|
|
SYSCH_RELIABLE = 0,
|
|
SYSCH_UNRELIABLE = 1,
|
|
SYSCH_MAX = 2
|
|
};
|
|
|
|
enum Mode {
|
|
MODE_NONE,
|
|
MODE_SERVER,
|
|
MODE_CLIENT,
|
|
MODE_MESH,
|
|
};
|
|
|
|
Mode active_mode = MODE_NONE;
|
|
|
|
uint32_t unique_id = 0;
|
|
|
|
int target_peer = 0;
|
|
|
|
ConnectionStatus connection_status = CONNECTION_DISCONNECTED;
|
|
|
|
HashMap<int, Ref<ENetConnection>> hosts;
|
|
HashMap<int, Ref<ENetPacketPeer>> peers;
|
|
|
|
struct Packet {
|
|
ENetPacket *packet = nullptr;
|
|
int from = 0;
|
|
int channel = 0;
|
|
TransferMode transfer_mode = TRANSFER_MODE_RELIABLE;
|
|
};
|
|
|
|
List<Packet> incoming_packets;
|
|
|
|
Packet current_packet;
|
|
|
|
void _store_packet(int32_t p_source, ENetConnection::Event &p_event);
|
|
void _pop_current_packet();
|
|
void _disconnect_inactive_peers();
|
|
void _destroy_unused(ENetPacket *p_packet);
|
|
_FORCE_INLINE_ bool _is_active() const { return active_mode != MODE_NONE; }
|
|
|
|
IPAddress bind_ip;
|
|
|
|
protected:
|
|
static void _bind_methods();
|
|
|
|
public:
|
|
virtual void set_target_peer(int p_peer) override;
|
|
|
|
virtual int get_packet_peer() const override;
|
|
virtual TransferMode get_packet_mode() const override;
|
|
virtual int get_packet_channel() const override;
|
|
|
|
virtual void poll() override;
|
|
virtual void close() override;
|
|
virtual void disconnect_peer(int p_peer, bool p_force = false) override;
|
|
|
|
virtual bool is_server() const override;
|
|
virtual bool is_server_relay_supported() const override;
|
|
|
|
// Overridden so we can instrument the DTLSServer when needed.
|
|
virtual void set_refuse_new_connections(bool p_enabled) override;
|
|
|
|
virtual ConnectionStatus get_connection_status() const override;
|
|
|
|
virtual int get_unique_id() const override;
|
|
|
|
virtual int get_max_packet_size() const override;
|
|
virtual int get_available_packet_count() const override;
|
|
virtual Error get_packet(const uint8_t **r_buffer, int &r_buffer_size) override;
|
|
virtual Error put_packet(const uint8_t *p_buffer, int p_buffer_size) override;
|
|
|
|
Error create_server(int p_port, int p_max_clients = 32, int p_max_channels = 0, int p_in_bandwidth = 0, int p_out_bandwidth = 0);
|
|
Error create_client(const String &p_address, int p_port, int p_channel_count = 0, int p_in_bandwidth = 0, int p_out_bandwidth = 0, int p_local_port = 0);
|
|
Error create_mesh(int p_id);
|
|
Error add_mesh_peer(int p_id, Ref<ENetConnection> p_host);
|
|
|
|
void set_bind_ip(const IPAddress &p_ip);
|
|
|
|
Ref<ENetConnection> get_host() const;
|
|
Ref<ENetPacketPeer> get_peer(int p_id) const;
|
|
|
|
ENetMultiplayerPeer();
|
|
~ENetMultiplayerPeer();
|
|
};
|
|
|
|
#endif // ENET_MULTIPLAYER_PEER_H
|