godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-12-02 16:48:55 +00:00
Code Releases Wiki Activity

Implement WebSocket clean close detection.

Browse Source
This commit is contained in:
Fabio Alessandrelli
2018-09-24 00:58:28 +02:00
parent 5d91e87c64
commit 4b92956db7
10 changed files with 20 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
modules/websocket/emws_client.cpp
View File

@@ -57,7 +57,7 @@ EMSCRIPTEN_KEEPALIVE void _esws_on_close(void *obj, int code, char *reason, int
EMWSClient *client = static_cast<EMWSClient *>(obj); EMWSClient *client = static_cast<EMWSClient *>(obj);
client->_on_close_request(code, String(reason)); client->_on_close_request(code, String(reason));
client->_is_connecting = false; client->_is_connecting = false;
client->_on_disconnect(); client->_on_disconnect(was_clean != 0);
} }
} }
@@ -146,7 +146,7 @@ Error EMWSClient::connect_to_host(String p_host, String p_path, uint16_t p_port,
if (!Module.IDHandler.has($0)) if (!Module.IDHandler.has($0))
return; // Godot Object is gone! return; // Godot Object is gone!
var was_clean = 0; var was_clean = 0;
if (event.was_clean) if (event.wasClean)
was_clean = 1; was_clean = 1;
ccall("_esws_on_close", ccall("_esws_on_close",
"void", "void",

2
modules/websocket/emws_peer.cpp
View File

@@ -140,7 +140,7 @@ void EMWSPeer::close(int p_code, String p_reason) {
var reason = UTF8ToString($2); var reason = UTF8ToString($2);
sock.close(code, reason); sock.close(code, reason);
Module.IDHandler.remove($0); Module.IDHandler.remove($0);
}, peer_sock, p_code); }, peer_sock, p_code, p_reason.utf8().get_data());
/* clang-format on */ /* clang-format on */
} }
peer_sock = -1; peer_sock = -1;

4
modules/websocket/lws_client.cpp
View File

@@ -129,6 +129,7 @@ int LWSClient::_handle_cb(struct lws *wsi, enum lws_callback_reasons reason, voi
peer->set_wsi(wsi); peer->set_wsi(wsi);
peer_data->peer_id = 0; peer_data->peer_id = 0;
peer_data->force_close = false; peer_data->force_close = false;
peer_data->clean_close = false;
_on_connect(lws_get_protocol(wsi)->name); _on_connect(lws_get_protocol(wsi)->name);
break; break;
@@ -140,6 +141,7 @@ int LWSClient::_handle_cb(struct lws *wsi, enum lws_callback_reasons reason, voi
case LWS_CALLBACK_WS_PEER_INITIATED_CLOSE: { case LWS_CALLBACK_WS_PEER_INITIATED_CLOSE: {
int code; int code;
String reason = peer->get_close_reason(in, len, code); String reason = peer->get_close_reason(in, len, code);
peer_data->clean_close = true;
_on_close_request(code, reason); _on_close_request(code, reason);
return 0; return 0;
} }
@@ -147,7 +149,7 @@ int LWSClient::_handle_cb(struct lws *wsi, enum lws_callback_reasons reason, voi
case LWS_CALLBACK_CLIENT_CLOSED: case LWS_CALLBACK_CLIENT_CLOSED:
peer->close(); peer->close();
destroy_context(); destroy_context();
_on_disconnect(); _on_disconnect(peer_data->clean_close);
return 0; // We can end here return 0; // We can end here
case LWS_CALLBACK_CLIENT_RECEIVE: case LWS_CALLBACK_CLIENT_RECEIVE:

1
modules/websocket/lws_peer.cpp
View File

@@ -216,6 +216,7 @@ void LWSPeer::close(int p_code, String p_reason) {
close_reason = p_reason; close_reason = p_reason;
PeerData *data = ((PeerData *)lws_wsi_user(wsi)); PeerData *data = ((PeerData *)lws_wsi_user(wsi));
data->force_close = true; data->force_close = true;
data->clean_close = true;
lws_callback_on_writable(wsi); // Notify that we want to disconnect lws_callback_on_writable(wsi); // Notify that we want to disconnect
} else { } else {
close_code = -1; close_code = -1;

1
modules/websocket/lws_peer.h
View File

@@ -60,6 +60,7 @@ public:
struct PeerData { struct PeerData {
uint32_t peer_id; uint32_t peer_id;
bool force_close; bool force_close;
bool clean_close;
}; };
RingBuffer<uint8_t> rbw; RingBuffer<uint8_t> rbw;

5
modules/websocket/lws_server.cpp
View File

@@ -90,6 +90,7 @@ int LWSServer::_handle_cb(struct lws *wsi, enum lws_callback_reasons reason, voi
peer_data->peer_id = id; peer_data->peer_id = id;
peer_data->force_close = false; peer_data->force_close = false;
peer_data->clean_close = false;
_on_connect(id, lws_get_protocol(wsi)->name); _on_connect(id, lws_get_protocol(wsi)->name);
break; break;
} }
@@ -103,6 +104,7 @@ int LWSServer::_handle_cb(struct lws *wsi, enum lws_callback_reasons reason, voi
int code; int code;
Ref<LWSPeer> peer = _peer_map[id]; Ref<LWSPeer> peer = _peer_map[id];
String reason = peer->get_close_reason(in, len, code); String reason = peer->get_close_reason(in, len, code);
peer_data->clean_close = true;
_on_close_request(id, code, reason); _on_close_request(id, code, reason);
} }
return 0; return 0;
@@ -112,11 +114,12 @@ int LWSServer::_handle_cb(struct lws *wsi, enum lws_callback_reasons reason, voi
if (peer_data == NULL) if (peer_data == NULL)
return 0; return 0;
int32_t id = peer_data->peer_id; int32_t id = peer_data->peer_id;
bool clean = peer_data->clean_close;
if (_peer_map.has(id)) { if (_peer_map.has(id)) {
_peer_map[id]->close(); _peer_map[id]->close();
_peer_map.erase(id); _peer_map.erase(id);
} }
_on_disconnect(id); _on_disconnect(id, clean);
return 0; // we can end here return 0; // we can end here
} }

6
modules/websocket/websocket_client.cpp
View File

@@ -112,12 +112,12 @@ void WebSocketClient::_on_close_request(int p_code, String p_reason) {
emit_signal("server_close_request", p_code, p_reason); emit_signal("server_close_request", p_code, p_reason);
} }
void WebSocketClient::_on_disconnect() { void WebSocketClient::_on_disconnect(bool p_was_clean) {
if (_is_multiplayer) { if (_is_multiplayer) {
emit_signal("connection_failed"); emit_signal("connection_failed");
} else { } else {
emit_signal("connection_closed"); emit_signal("connection_closed", p_was_clean);
} }
} }
@@ -141,6 +141,6 @@ void WebSocketClient::_bind_methods() {
ADD_SIGNAL(MethodInfo("data_received")); ADD_SIGNAL(MethodInfo("data_received"));
ADD_SIGNAL(MethodInfo("connection_established", PropertyInfo(Variant::STRING, "protocol"))); ADD_SIGNAL(MethodInfo("connection_established", PropertyInfo(Variant::STRING, "protocol")));
ADD_SIGNAL(MethodInfo("server_close_request", PropertyInfo(Variant::INT, "code"), PropertyInfo(Variant::STRING, "reason"))); ADD_SIGNAL(MethodInfo("server_close_request", PropertyInfo(Variant::INT, "code"), PropertyInfo(Variant::STRING, "reason")));
ADD_SIGNAL(MethodInfo("connection_closed")); ADD_SIGNAL(MethodInfo("connection_closed", PropertyInfo(Variant::BOOL, "was_clean_close")));
ADD_SIGNAL(MethodInfo("connection_error")); ADD_SIGNAL(MethodInfo("connection_error"));
} }

2
modules/websocket/websocket_client.h
View File

@@ -63,7 +63,7 @@ public:
void _on_peer_packet(); void _on_peer_packet();
void _on_connect(String p_protocol); void _on_connect(String p_protocol);
void _on_close_request(int p_code, String p_reason); void _on_close_request(int p_code, String p_reason);
void _on_disconnect(); void _on_disconnect(bool p_was_clean);
void _on_error(); void _on_error();
WebSocketClient(); WebSocketClient();

6
modules/websocket/websocket_server.cpp
View File

@@ -49,7 +49,7 @@ void WebSocketServer::_bind_methods() {
ClassDB::bind_method(D_METHOD("disconnect_peer", "id", "code", "reason"), &WebSocketServer::disconnect_peer, DEFVAL(1000), DEFVAL("")); ClassDB::bind_method(D_METHOD("disconnect_peer", "id", "code", "reason"), &WebSocketServer::disconnect_peer, DEFVAL(1000), DEFVAL(""));
ADD_SIGNAL(MethodInfo("client_close_request", PropertyInfo(Variant::INT, "id"), PropertyInfo(Variant::INT, "code"), PropertyInfo(Variant::STRING, "reason"))); ADD_SIGNAL(MethodInfo("client_close_request", PropertyInfo(Variant::INT, "id"), PropertyInfo(Variant::INT, "code"), PropertyInfo(Variant::STRING, "reason")));
ADD_SIGNAL(MethodInfo("client_disconnected", PropertyInfo(Variant::INT, "id"))); ADD_SIGNAL(MethodInfo("client_disconnected", PropertyInfo(Variant::INT, "id"), PropertyInfo(Variant::BOOL, "was_clean_close")));
ADD_SIGNAL(MethodInfo("client_connected", PropertyInfo(Variant::INT, "id"), PropertyInfo(Variant::STRING, "protocol"))); ADD_SIGNAL(MethodInfo("client_connected", PropertyInfo(Variant::INT, "id"), PropertyInfo(Variant::STRING, "protocol")));
ADD_SIGNAL(MethodInfo("data_received", PropertyInfo(Variant::INT, "id"))); ADD_SIGNAL(MethodInfo("data_received", PropertyInfo(Variant::INT, "id")));
} }
@@ -86,14 +86,14 @@ void WebSocketServer::_on_connect(int32_t p_peer_id, String p_protocol) {
} }
} }
void WebSocketServer::_on_disconnect(int32_t p_peer_id) { void WebSocketServer::_on_disconnect(int32_t p_peer_id, bool p_was_clean) {
if (_is_multiplayer) { if (_is_multiplayer) {
// Send delete to clients // Send delete to clients
_send_del(p_peer_id); _send_del(p_peer_id);
emit_signal("peer_disconnected", p_peer_id); emit_signal("peer_disconnected", p_peer_id);
} else { } else {
emit_signal("client_disconnected", p_peer_id); emit_signal("client_disconnected", p_peer_id, p_was_clean);
} }
} }

2
modules/websocket/websocket_server.h
View File

@@ -58,7 +58,7 @@ public:
void _on_peer_packet(int32_t p_peer_id); void _on_peer_packet(int32_t p_peer_id);
void _on_connect(int32_t p_peer_id, String p_protocol); void _on_connect(int32_t p_peer_id, String p_protocol);
void _on_disconnect(int32_t p_peer_id); void _on_disconnect(int32_t p_peer_id, bool p_was_clean);
void _on_close_request(int32_t p_peer_id, int p_code, String p_reason); void _on_close_request(int32_t p_peer_id, int p_code, String p_reason);
WebSocketServer(); WebSocketServer();