Stowage/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-10-31 05:31:01 +00:00
Code Issues Projects Releases Packages Wiki Activity

[WebSocket] Refactor websocket module.

Browse source 
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.
This commit is contained in:
Fabio Alessandrelli 2022-09-24 22:44:44 +02:00
parent 5aadc618b6
commit a8950f98dd
29 changed files with 1827 additions and 2395 deletions
Download patch file Download diff file Expand all files Collapse all files

54
modules/websocket/editor/editor_debugger_server_websocket.cpp
View file

@ -38,18 +38,25 @@
#include "editor/editor_node.h"
#include "editor/editor_settings.h"
void EditorDebuggerServerWebSocket::_peer_connected(int p_id, String _protocol) {
pending_peers.push_back(p_id);
}
void EditorDebuggerServerWebSocket::_peer_disconnected(int p_id, bool p_was_clean) {
if (pending_peers.find(p_id)) {
pending_peers.erase(p_id);
}
}
void EditorDebuggerServerWebSocket::poll() {
server->poll();
if (pending_peer.is_null() && tcp_server->is_connection_available()) {
Ref<WebSocketPeer> peer;
Error err = peer->accept_stream(tcp_server->take_connection());
if (err == OK) {
pending_timer = OS::get_singleton()->get_ticks_msec();
pending_peer = peer;
}
}
if (pending_peer.is_valid() && pending_peer->get_ready_state() != WebSocketPeer::STATE_OPEN) {
pending_peer->poll();
WebSocketPeer::State ready_state = pending_peer->get_ready_state();
if (ready_state != WebSocketPeer::STATE_CONNECTING && ready_state != WebSocketPeer::STATE_OPEN) {
pending_peer.unref(); // Failed.
}
if (ready_state == WebSocketPeer::STATE_CONNECTING && OS::get_singleton()->get_ticks_msec() - pending_timer > 3000) {
pending_peer.unref(); // Timeout.
}
}
}
String EditorDebuggerServerWebSocket::get_uri() const {
@ -69,15 +76,10 @@ Error EditorDebuggerServerWebSocket::start(const String &p_uri) {
ERR_FAIL_COND_V(!bind_host.is_valid_ip_address() && bind_host != "*", ERR_INVALID_PARAMETER);
}
// Set up the server
server->set_bind_ip(bind_host);
Vector<String> compatible_protocols;
compatible_protocols.push_back("binary"); // compatibility with EMSCRIPTEN TCP-to-WebSocket layer.
// Try listening on ports
const int max_attempts = 5;
for (int attempt = 1;; ++attempt) {
const Error err = server->listen(bind_port, compatible_protocols);
const Error err = tcp_server->listen(bind_port, bind_host);
if (err == OK) {
break;
}
@ -96,31 +98,27 @@ Error EditorDebuggerServerWebSocket::start(const String &p_uri) {
}
void EditorDebuggerServerWebSocket::stop() {
server->stop();
pending_peers.clear();
pending_peer.unref();
tcp_server->stop();
}
bool EditorDebuggerServerWebSocket::is_active() const {
return server->is_listening();
return tcp_server->is_listening();
}
bool EditorDebuggerServerWebSocket::is_connection_available() const {
return pending_peers.size() > 0;
return pending_peer.is_valid() && pending_peer->get_ready_state() == WebSocketPeer::STATE_OPEN;
}
Ref<RemoteDebuggerPeer> EditorDebuggerServerWebSocket::take_connection() {
ERR_FAIL_COND_V(!is_connection_available(), Ref<RemoteDebuggerPeer>());
RemoteDebuggerPeer *peer = memnew(RemoteDebuggerPeerWebSocket(server->get_peer(pending_peers[0])));
pending_peers.pop_front();
RemoteDebuggerPeer *peer = memnew(RemoteDebuggerPeerWebSocket(pending_peer));
pending_peer.unref();
return peer;
}
EditorDebuggerServerWebSocket::EditorDebuggerServerWebSocket() {
server = Ref<WebSocketServer>(WebSocketServer::create());
int max_pkts = (int)GLOBAL_GET("network/limits/debugger/max_queued_messages");
server->set_buffers(8192, max_pkts, 8192, max_pkts);
server->connect("client_connected", callable_mp(this, &EditorDebuggerServerWebSocket::_peer_connected));
server->connect("client_disconnected", callable_mp(this, &EditorDebuggerServerWebSocket::_peer_disconnected));
tcp_server.instantiate();
}
EditorDebuggerServerWebSocket::~EditorDebuggerServerWebSocket() {