7536d15fe3
MultiplayerPeer changes: - Adds is_server_relay_supported virtual method Informs the upper MultiplayerAPI layer if it can signal peers connected to the server to other clients, and perform packet relaying among them. - Adds get_packet_channel and get_packet_mode virtual methods Allows the MultiplayerAPI to retrieve the channel and transfer modes to use when relaying the last received packet. SceneMultiplayerPeer changes: - Implement peer signaling and packet relaying when the MultiplayerPeer advertise they are supported. ENet, WebRTC, WebSocket changes: - Removed custom code for relaying from WebSocket and ENet, and let it be handled by the upper layer. - Update WebRTC to split create_client, create_server, and create_mesh, with the latter behaving like the old initialize with "server_compatibility = false", and the first two supporting the upper layer relaying protocol.
125 lines
4.7 KiB
C++
125 lines
4.7 KiB
C++
/*************************************************************************/
|
|
/* webrtc_multiplayer_peer.h */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* 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 WEBRTC_MULTIPLAYER_PEER_H
|
|
#define WEBRTC_MULTIPLAYER_PEER_H
|
|
|
|
#include "scene/main/multiplayer_peer.h"
|
|
#include "webrtc_peer_connection.h"
|
|
|
|
class WebRTCMultiplayerPeer : public MultiplayerPeer {
|
|
GDCLASS(WebRTCMultiplayerPeer, MultiplayerPeer);
|
|
|
|
protected:
|
|
static void _bind_methods();
|
|
|
|
private:
|
|
enum {
|
|
CH_RELIABLE = 0,
|
|
CH_ORDERED = 1,
|
|
CH_UNRELIABLE = 2,
|
|
CH_RESERVED_MAX = 3
|
|
};
|
|
|
|
enum NetworkMode {
|
|
MODE_NONE,
|
|
MODE_SERVER,
|
|
MODE_CLIENT,
|
|
MODE_MESH,
|
|
};
|
|
|
|
class ConnectedPeer : public RefCounted {
|
|
public:
|
|
Ref<WebRTCPeerConnection> connection;
|
|
List<Ref<WebRTCDataChannel>> channels;
|
|
bool connected;
|
|
|
|
ConnectedPeer() {
|
|
connected = false;
|
|
for (int i = 0; i < CH_RESERVED_MAX; i++) {
|
|
channels.push_front(Ref<WebRTCDataChannel>());
|
|
}
|
|
}
|
|
};
|
|
|
|
uint32_t unique_id = 0;
|
|
int target_peer = 0;
|
|
int client_count = 0;
|
|
ConnectionStatus connection_status = CONNECTION_DISCONNECTED;
|
|
int next_packet_peer = 0;
|
|
int next_packet_channel = 0;
|
|
NetworkMode network_mode = MODE_NONE;
|
|
|
|
HashMap<int, Ref<ConnectedPeer>> peer_map;
|
|
List<TransferMode> channels_modes;
|
|
List<Dictionary> channels_config;
|
|
|
|
void _peer_to_dict(Ref<ConnectedPeer> p_connected_peer, Dictionary &r_dict);
|
|
void _find_next_peer();
|
|
Ref<ConnectedPeer> _get_next_peer();
|
|
Error _initialize(int p_self_id, NetworkMode p_mode, Array p_channels_config = Array());
|
|
|
|
public:
|
|
WebRTCMultiplayerPeer() {}
|
|
~WebRTCMultiplayerPeer();
|
|
|
|
Error create_server(Array p_channels_config = Array());
|
|
Error create_client(int p_self_id, Array p_channels_config = Array());
|
|
Error create_mesh(int p_self_id, Array p_channels_config = Array());
|
|
Error add_peer(Ref<WebRTCPeerConnection> p_peer, int p_peer_id, int p_unreliable_lifetime = 1);
|
|
void remove_peer(int p_peer_id);
|
|
bool has_peer(int p_peer_id);
|
|
Dictionary get_peer(int p_peer_id);
|
|
Dictionary get_peers();
|
|
void close();
|
|
|
|
// PacketPeer
|
|
Error get_packet(const uint8_t **r_buffer, int &r_buffer_size) override; ///< buffer is GONE after next get_packet
|
|
Error put_packet(const uint8_t *p_buffer, int p_buffer_size) override;
|
|
int get_available_packet_count() const override;
|
|
int get_max_packet_size() const override;
|
|
|
|
// MultiplayerPeer
|
|
void set_target_peer(int p_peer_id) override;
|
|
|
|
int get_unique_id() const override;
|
|
int get_packet_peer() const override;
|
|
int get_packet_channel() const override;
|
|
TransferMode get_packet_mode() const override;
|
|
|
|
bool is_server() const override;
|
|
bool is_server_relay_supported() const override;
|
|
|
|
void poll() override;
|
|
|
|
ConnectionStatus get_connection_status() const override;
|
|
};
|
|
|
|
#endif // WEBRTC_MULTIPLAYER_PEER_H
|