2017-12-21 02:13:23 +00:00
|
|
|
/*************************************************************************/
|
2019-02-12 21:28:47 +00:00
|
|
|
/* websocket_multiplayer_peer.h */
|
2017-12-21 02:13:23 +00:00
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
2017-12-21 02:47:16 +00:00
|
|
|
/* GODOT ENGINE */
|
|
|
|
/* https://godotengine.org */
|
2017-12-21 02:13:23 +00:00
|
|
|
/*************************************************************************/
|
2022-01-03 20:27:34 +00:00
|
|
|
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
|
2017-12-21 02:13:23 +00: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. */
|
|
|
|
/*************************************************************************/
|
2019-01-01 11:46:36 +00:00
|
|
|
|
2017-12-21 02:13:23 +00:00
|
|
|
#ifndef WEBSOCKET_MULTIPLAYER_PEER_H
|
|
|
|
#define WEBSOCKET_MULTIPLAYER_PEER_H
|
|
|
|
|
2020-11-07 22:33:38 +00:00
|
|
|
#include "core/error/error_list.h"
|
[WebSocket] Refactor websocket module.
This commit is a huge refactor of the websocket module.
The module is really old, and some design choices had to be
re-evaluated.
The WebSocketClient and WebSocketServer classes are now gone, and
WebSocketPeer can act as either client or server.
The WebSocketMultiplayerPeer class is no longer abstract, and implements
the Multiplayer API on top of the lower level WebSocketPeer.
WebSocketPeer is now a "raw" peer, like StreamPeerTCP and StreamPeerTLS,
so it emits no signal, and just needs polling to update its internal
state.
To use it as a client, simply call WebSocketPeer.coonect_to_url, then
frequently poll the peer until STATE_OPEN is reached and then you can
write or read from it, or STATE_CLOSED and then you can check the
disconnect code and reason).
To implement a server instead, a TCPServer must be created, and the
accepted connections needs to be provided to
WebSocketPeer.accept_stream (which will perform the HTTP handshake).
A full example of a WebSocketServer using TLS will be provided in the
demo repository.
2022-09-24 20:44:44 +00:00
|
|
|
#include "core/io/stream_peer_tls.h"
|
|
|
|
#include "core/io/tcp_server.h"
|
2020-11-07 22:33:38 +00:00
|
|
|
#include "core/templates/list.h"
|
2022-07-12 21:12:42 +00:00
|
|
|
#include "scene/main/multiplayer_peer.h"
|
2017-12-21 02:13:23 +00:00
|
|
|
#include "websocket_peer.h"
|
|
|
|
|
2021-07-12 14:11:05 +00:00
|
|
|
class WebSocketMultiplayerPeer : public MultiplayerPeer {
|
|
|
|
GDCLASS(WebSocketMultiplayerPeer, MultiplayerPeer);
|
2017-12-21 02:13:23 +00:00
|
|
|
|
|
|
|
private:
|
[WebSocket] Refactor websocket module.
This commit is a huge refactor of the websocket module.
The module is really old, and some design choices had to be
re-evaluated.
The WebSocketClient and WebSocketServer classes are now gone, and
WebSocketPeer can act as either client or server.
The WebSocketMultiplayerPeer class is no longer abstract, and implements
the Multiplayer API on top of the lower level WebSocketPeer.
WebSocketPeer is now a "raw" peer, like StreamPeerTCP and StreamPeerTLS,
so it emits no signal, and just needs polling to update its internal
state.
To use it as a client, simply call WebSocketPeer.coonect_to_url, then
frequently poll the peer until STATE_OPEN is reached and then you can
write or read from it, or STATE_CLOSED and then you can check the
disconnect code and reason).
To implement a server instead, a TCPServer must be created, and the
accepted connections needs to be provided to
WebSocketPeer.accept_stream (which will perform the HTTP handshake).
A full example of a WebSocketServer using TLS will be provided in the
demo repository.
2022-09-24 20:44:44 +00:00
|
|
|
Ref<WebSocketPeer> _create_peer();
|
2017-12-21 02:13:23 +00:00
|
|
|
|
|
|
|
protected:
|
|
|
|
enum {
|
|
|
|
SYS_NONE = 0,
|
|
|
|
SYS_ADD = 1,
|
|
|
|
SYS_DEL = 2,
|
|
|
|
SYS_ID = 3,
|
|
|
|
|
2018-11-03 04:46:38 +00:00
|
|
|
PROTO_SIZE = 9
|
2017-12-21 02:13:23 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct Packet {
|
2021-02-08 09:57:18 +00:00
|
|
|
int source = 0;
|
|
|
|
uint8_t *data = nullptr;
|
|
|
|
uint32_t size = 0;
|
2017-12-21 02:13:23 +00:00
|
|
|
};
|
|
|
|
|
[WebSocket] Refactor websocket module.
This commit is a huge refactor of the websocket module.
The module is really old, and some design choices had to be
re-evaluated.
The WebSocketClient and WebSocketServer classes are now gone, and
WebSocketPeer can act as either client or server.
The WebSocketMultiplayerPeer class is no longer abstract, and implements
the Multiplayer API on top of the lower level WebSocketPeer.
WebSocketPeer is now a "raw" peer, like StreamPeerTCP and StreamPeerTLS,
so it emits no signal, and just needs polling to update its internal
state.
To use it as a client, simply call WebSocketPeer.coonect_to_url, then
frequently poll the peer until STATE_OPEN is reached and then you can
write or read from it, or STATE_CLOSED and then you can check the
disconnect code and reason).
To implement a server instead, a TCPServer must be created, and the
accepted connections needs to be provided to
WebSocketPeer.accept_stream (which will perform the HTTP handshake).
A full example of a WebSocketServer using TLS will be provided in the
demo repository.
2022-09-24 20:44:44 +00:00
|
|
|
struct PendingPeer {
|
|
|
|
uint64_t time = 0;
|
|
|
|
Ref<StreamPeerTCP> tcp;
|
|
|
|
Ref<StreamPeer> connection;
|
|
|
|
Ref<WebSocketPeer> ws;
|
|
|
|
};
|
|
|
|
|
|
|
|
uint64_t handshake_timeout = 3000;
|
|
|
|
Ref<WebSocketPeer> peer_config;
|
|
|
|
HashMap<int, PendingPeer> pending_peers;
|
|
|
|
Ref<TCPServer> tcp_server;
|
|
|
|
bool use_tls = false;
|
|
|
|
Ref<X509Certificate> tls_certificate;
|
|
|
|
Ref<CryptoKey> tls_key;
|
|
|
|
|
|
|
|
ConnectionStatus connection_status = CONNECTION_DISCONNECTED;
|
2017-12-21 02:13:23 +00:00
|
|
|
|
[WebSocket] Refactor websocket module.
This commit is a huge refactor of the websocket module.
The module is really old, and some design choices had to be
re-evaluated.
The WebSocketClient and WebSocketServer classes are now gone, and
WebSocketPeer can act as either client or server.
The WebSocketMultiplayerPeer class is no longer abstract, and implements
the Multiplayer API on top of the lower level WebSocketPeer.
WebSocketPeer is now a "raw" peer, like StreamPeerTCP and StreamPeerTLS,
so it emits no signal, and just needs polling to update its internal
state.
To use it as a client, simply call WebSocketPeer.coonect_to_url, then
frequently poll the peer until STATE_OPEN is reached and then you can
write or read from it, or STATE_CLOSED and then you can check the
disconnect code and reason).
To implement a server instead, a TCPServer must be created, and the
accepted connections needs to be provided to
WebSocketPeer.accept_stream (which will perform the HTTP handshake).
A full example of a WebSocketServer using TLS will be provided in the
demo repository.
2022-09-24 20:44:44 +00:00
|
|
|
List<Packet> incoming_packets;
|
|
|
|
HashMap<int, Ref<WebSocketPeer>> peers_map;
|
|
|
|
Packet current_packet;
|
|
|
|
|
|
|
|
int target_peer = 0;
|
|
|
|
int unique_id = 0;
|
2017-12-21 02:13:23 +00:00
|
|
|
|
|
|
|
static void _bind_methods();
|
|
|
|
|
[WebSocket] Refactor websocket module.
This commit is a huge refactor of the websocket module.
The module is really old, and some design choices had to be
re-evaluated.
The WebSocketClient and WebSocketServer classes are now gone, and
WebSocketPeer can act as either client or server.
The WebSocketMultiplayerPeer class is no longer abstract, and implements
the Multiplayer API on top of the lower level WebSocketPeer.
WebSocketPeer is now a "raw" peer, like StreamPeerTCP and StreamPeerTLS,
so it emits no signal, and just needs polling to update its internal
state.
To use it as a client, simply call WebSocketPeer.coonect_to_url, then
frequently poll the peer until STATE_OPEN is reached and then you can
write or read from it, or STATE_CLOSED and then you can check the
disconnect code and reason).
To implement a server instead, a TCPServer must be created, and the
accepted connections needs to be provided to
WebSocketPeer.accept_stream (which will perform the HTTP handshake).
A full example of a WebSocketServer using TLS will be provided in the
demo repository.
2022-09-24 20:44:44 +00:00
|
|
|
void _poll_client();
|
|
|
|
void _poll_server();
|
|
|
|
void _clear();
|
2017-12-21 02:13:23 +00:00
|
|
|
|
|
|
|
public:
|
2021-07-12 14:11:05 +00:00
|
|
|
/* MultiplayerPeer */
|
2022-10-08 18:50:19 +00:00
|
|
|
virtual void set_target_peer(int p_target_peer) override;
|
|
|
|
virtual int get_packet_peer() const override;
|
|
|
|
virtual int get_packet_channel() const override { return 0; }
|
|
|
|
virtual TransferMode get_packet_mode() const override { return TRANSFER_MODE_RELIABLE; }
|
|
|
|
virtual int get_unique_id() const override;
|
|
|
|
virtual bool is_server_relay_supported() const override { return true; }
|
2017-12-21 02:13:23 +00:00
|
|
|
|
[WebSocket] Refactor websocket module.
This commit is a huge refactor of the websocket module.
The module is really old, and some design choices had to be
re-evaluated.
The WebSocketClient and WebSocketServer classes are now gone, and
WebSocketPeer can act as either client or server.
The WebSocketMultiplayerPeer class is no longer abstract, and implements
the Multiplayer API on top of the lower level WebSocketPeer.
WebSocketPeer is now a "raw" peer, like StreamPeerTCP and StreamPeerTLS,
so it emits no signal, and just needs polling to update its internal
state.
To use it as a client, simply call WebSocketPeer.coonect_to_url, then
frequently poll the peer until STATE_OPEN is reached and then you can
write or read from it, or STATE_CLOSED and then you can check the
disconnect code and reason).
To implement a server instead, a TCPServer must be created, and the
accepted connections needs to be provided to
WebSocketPeer.accept_stream (which will perform the HTTP handshake).
A full example of a WebSocketServer using TLS will be provided in the
demo repository.
2022-09-24 20:44:44 +00:00
|
|
|
virtual int get_max_packet_size() const override;
|
|
|
|
virtual bool is_server() const override;
|
|
|
|
virtual void poll() override;
|
|
|
|
virtual ConnectionStatus get_connection_status() const override;
|
|
|
|
|
2017-12-21 02:13:23 +00:00
|
|
|
/* PacketPeer */
|
2020-07-10 10:34:39 +00:00
|
|
|
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;
|
2017-12-21 02:13:23 +00:00
|
|
|
|
|
|
|
/* WebSocketPeer */
|
[WebSocket] Refactor websocket module.
This commit is a huge refactor of the websocket module.
The module is really old, and some design choices had to be
re-evaluated.
The WebSocketClient and WebSocketServer classes are now gone, and
WebSocketPeer can act as either client or server.
The WebSocketMultiplayerPeer class is no longer abstract, and implements
the Multiplayer API on top of the lower level WebSocketPeer.
WebSocketPeer is now a "raw" peer, like StreamPeerTCP and StreamPeerTLS,
so it emits no signal, and just needs polling to update its internal
state.
To use it as a client, simply call WebSocketPeer.coonect_to_url, then
frequently poll the peer until STATE_OPEN is reached and then you can
write or read from it, or STATE_CLOSED and then you can check the
disconnect code and reason).
To implement a server instead, a TCPServer must be created, and the
accepted connections needs to be provided to
WebSocketPeer.accept_stream (which will perform the HTTP handshake).
A full example of a WebSocketServer using TLS will be provided in the
demo repository.
2022-09-24 20:44:44 +00:00
|
|
|
virtual Ref<WebSocketPeer> get_peer(int p_peer_id) const;
|
2017-12-21 02:13:23 +00:00
|
|
|
|
[WebSocket] Refactor websocket module.
This commit is a huge refactor of the websocket module.
The module is really old, and some design choices had to be
re-evaluated.
The WebSocketClient and WebSocketServer classes are now gone, and
WebSocketPeer can act as either client or server.
The WebSocketMultiplayerPeer class is no longer abstract, and implements
the Multiplayer API on top of the lower level WebSocketPeer.
WebSocketPeer is now a "raw" peer, like StreamPeerTCP and StreamPeerTLS,
so it emits no signal, and just needs polling to update its internal
state.
To use it as a client, simply call WebSocketPeer.coonect_to_url, then
frequently poll the peer until STATE_OPEN is reached and then you can
write or read from it, or STATE_CLOSED and then you can check the
disconnect code and reason).
To implement a server instead, a TCPServer must be created, and the
accepted connections needs to be provided to
WebSocketPeer.accept_stream (which will perform the HTTP handshake).
A full example of a WebSocketServer using TLS will be provided in the
demo repository.
2022-09-24 20:44:44 +00:00
|
|
|
Error create_client(const String &p_url, bool p_verify_tls, Ref<X509Certificate> p_tls_certificate);
|
|
|
|
Error create_server(int p_port, IPAddress p_bind_ip, Ref<CryptoKey> p_tls_key, Ref<X509Certificate> p_tls_certificate);
|
|
|
|
|
|
|
|
void set_supported_protocols(const Vector<String> &p_protocols);
|
|
|
|
Vector<String> get_supported_protocols() const;
|
|
|
|
|
|
|
|
void set_handshake_headers(const Vector<String> &p_headers);
|
|
|
|
Vector<String> get_handshake_headers() const;
|
|
|
|
|
|
|
|
void set_outbound_buffer_size(int p_buffer_size);
|
|
|
|
int get_outbound_buffer_size() const;
|
|
|
|
|
|
|
|
void set_inbound_buffer_size(int p_buffer_size);
|
|
|
|
int get_inbound_buffer_size() const;
|
|
|
|
|
|
|
|
float get_handshake_timeout() const;
|
|
|
|
void set_handshake_timeout(float p_timeout);
|
|
|
|
|
|
|
|
IPAddress get_peer_address(int p_peer_id) const;
|
|
|
|
int get_peer_port(int p_peer_id) const;
|
|
|
|
void disconnect_peer(int p_peer_id, int p_code = 1000, String p_reason = "");
|
|
|
|
void close();
|
|
|
|
|
|
|
|
void set_max_queued_packets(int p_max_queued_packets);
|
|
|
|
int get_max_queued_packets() const;
|
2017-12-21 02:13:23 +00:00
|
|
|
|
|
|
|
WebSocketMultiplayerPeer();
|
|
|
|
~WebSocketMultiplayerPeer();
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif // WEBSOCKET_MULTIPLAYER_PEER_H
|