Browse Source

Merge pull request #59582 from Faless/net/4.x_tcp_explicit_poll

Rémi Verschelde 3 years ago
parent
commit
6e6fe2b025

+ 4 - 2
core/debugger/remote_debugger_peer.cpp

@@ -93,7 +93,7 @@ RemoteDebuggerPeerTCP::~RemoteDebuggerPeerTCP() {
 }
 
 void RemoteDebuggerPeerTCP::_write_out() {
-	while (tcp_client->poll(NetSocket::POLL_TYPE_OUT) == OK) {
+	while (tcp_client->get_status() == StreamPeerTCP::STATUS_CONNECTED && tcp_client->wait(NetSocket::POLL_TYPE_OUT) == OK) {
 		uint8_t *buf = out_buf.ptrw();
 		if (out_left <= 0) {
 			if (out_queue.size() == 0) {
@@ -119,7 +119,7 @@ void RemoteDebuggerPeerTCP::_write_out() {
 }
 
 void RemoteDebuggerPeerTCP::_read_in() {
-	while (tcp_client->poll(NetSocket::POLL_TYPE_IN) == OK) {
+	while (tcp_client->get_status() == StreamPeerTCP::STATUS_CONNECTED && tcp_client->wait(NetSocket::POLL_TYPE_IN) == OK) {
 		uint8_t *buf = in_buf.ptrw();
 		if (in_left <= 0) {
 			if (in_queue.size() > max_queued_messages) {
@@ -167,6 +167,7 @@ Error RemoteDebuggerPeerTCP::connect_to_host(const String &p_host, uint16_t p_po
 	tcp_client->connect_to_host(ip, port);
 
 	for (int i = 0; i < tries; i++) {
+		tcp_client->poll();
 		if (tcp_client->get_status() == StreamPeerTCP::STATUS_CONNECTED) {
 			print_verbose("Remote Debugger: Connected!");
 			break;
@@ -213,6 +214,7 @@ void RemoteDebuggerPeerTCP::poll() {
 }
 
 void RemoteDebuggerPeerTCP::_poll() {
+	tcp_client->poll();
 	if (connected) {
 		_write_out();
 		_read_in();

+ 3 - 0
core/io/http_client_tcp.cpp

@@ -264,6 +264,9 @@ void HTTPClientTCP::close() {
 }
 
 Error HTTPClientTCP::poll() {
+	if (tcp_connection.is_valid()) {
+		tcp_connection->poll();
+	}
 	switch (status) {
 		case STATUS_RESOLVING: {
 			ERR_FAIL_COND_V(resolving == IP::RESOLVER_INVALID_ID, ERR_BUG);

+ 2 - 2
core/io/packet_peer_udp.cpp

@@ -242,7 +242,7 @@ Error PacketPeerUDP::connect_to_host(const IPAddress &p_host, int p_port) {
 	return OK;
 }
 
-bool PacketPeerUDP::is_connected_to_host() const {
+bool PacketPeerUDP::is_socket_connected() const {
 	return connected;
 }
 
@@ -348,7 +348,7 @@ void PacketPeerUDP::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("wait"), &PacketPeerUDP::wait);
 	ClassDB::bind_method(D_METHOD("is_bound"), &PacketPeerUDP::is_bound);
 	ClassDB::bind_method(D_METHOD("connect_to_host", "host", "port"), &PacketPeerUDP::connect_to_host);
-	ClassDB::bind_method(D_METHOD("is_connected_to_host"), &PacketPeerUDP::is_connected_to_host);
+	ClassDB::bind_method(D_METHOD("is_socket_connected"), &PacketPeerUDP::is_socket_connected);
 	ClassDB::bind_method(D_METHOD("get_packet_ip"), &PacketPeerUDP::_get_packet_ip);
 	ClassDB::bind_method(D_METHOD("get_packet_port"), &PacketPeerUDP::get_packet_port);
 	ClassDB::bind_method(D_METHOD("get_local_port"), &PacketPeerUDP::get_local_port);

+ 1 - 1
core/io/packet_peer_udp.h

@@ -79,7 +79,7 @@ public:
 	void disconnect_shared_socket(); // Used by UDPServer
 	Error store_packet(IPAddress p_ip, uint32_t p_port, uint8_t *p_buf, int p_buf_size); // Used internally and by UDPServer
 	Error connect_to_host(const IPAddress &p_host, int p_port);
-	bool is_connected_to_host() const;
+	bool is_socket_connected() const;
 
 	IPAddress get_packet_address() const;
 	int get_packet_port() const;

+ 27 - 58
core/io/stream_peer_tcp.cpp

@@ -32,8 +32,28 @@
 
 #include "core/config/project_settings.h"
 
-Error StreamPeerTCP::_poll_connection() {
-	ERR_FAIL_COND_V(status != STATUS_CONNECTING || !_sock.is_valid() || !_sock->is_open(), FAILED);
+Error StreamPeerTCP::poll() {
+	if (status == STATUS_CONNECTED) {
+		Error err;
+		err = _sock->poll(NetSocket::POLL_TYPE_IN, 0);
+		if (err == OK) {
+			// FIN received
+			if (_sock->get_available_bytes() == 0) {
+				disconnect_from_host();
+				return OK;
+			}
+		}
+		// Also poll write
+		err = _sock->poll(NetSocket::POLL_TYPE_IN_OUT, 0);
+		if (err != OK && err != ERR_BUSY) {
+			// Got an error
+			disconnect_from_host();
+			status = STATUS_ERROR;
+			return err;
+		}
+	} else if (status != STATUS_CONNECTING) {
+		return OK;
+	}
 
 	Error err = _sock->connect_to_host(peer_host, peer_port);
 
@@ -121,22 +141,7 @@ Error StreamPeerTCP::connect_to_host(const IPAddress &p_host, int p_port) {
 Error StreamPeerTCP::write(const uint8_t *p_data, int p_bytes, int &r_sent, bool p_block) {
 	ERR_FAIL_COND_V(!_sock.is_valid(), ERR_UNAVAILABLE);
 
-	if (status == STATUS_NONE || status == STATUS_ERROR) {
-		return FAILED;
-	}
-
 	if (status != STATUS_CONNECTED) {
-		if (_poll_connection() != OK) {
-			return FAILED;
-		}
-
-		if (status != STATUS_CONNECTED) {
-			r_sent = 0;
-			return OK;
-		}
-	}
-
-	if (!_sock->is_open()) {
 		return FAILED;
 	}
 
@@ -179,21 +184,10 @@ Error StreamPeerTCP::write(const uint8_t *p_data, int p_bytes, int &r_sent, bool
 }
 
 Error StreamPeerTCP::read(uint8_t *p_buffer, int p_bytes, int &r_received, bool p_block) {
-	if (!is_connected_to_host()) {
+	if (status != STATUS_CONNECTED) {
 		return FAILED;
 	}
 
-	if (status == STATUS_CONNECTING) {
-		if (_poll_connection() != OK) {
-			return FAILED;
-		}
-
-		if (status != STATUS_CONNECTED) {
-			r_received = 0;
-			return OK;
-		}
-	}
-
 	Error err;
 	int to_read = p_bytes;
 	int total_read = 0;
@@ -243,36 +237,11 @@ Error StreamPeerTCP::read(uint8_t *p_buffer, int p_bytes, int &r_received, bool
 }
 
 void StreamPeerTCP::set_no_delay(bool p_enabled) {
-	ERR_FAIL_COND(!is_connected_to_host());
+	ERR_FAIL_COND(!_sock.is_valid() || !_sock->is_open());
 	_sock->set_tcp_no_delay_enabled(p_enabled);
 }
 
-bool StreamPeerTCP::is_connected_to_host() const {
-	return _sock.is_valid() && _sock->is_open() && (status == STATUS_CONNECTED || status == STATUS_CONNECTING);
-}
-
-StreamPeerTCP::Status StreamPeerTCP::get_status() {
-	if (status == STATUS_CONNECTING) {
-		_poll_connection();
-	} else if (status == STATUS_CONNECTED) {
-		Error err;
-		err = _sock->poll(NetSocket::POLL_TYPE_IN, 0);
-		if (err == OK) {
-			// FIN received
-			if (_sock->get_available_bytes() == 0) {
-				disconnect_from_host();
-				return status;
-			}
-		}
-		// Also poll write
-		err = _sock->poll(NetSocket::POLL_TYPE_IN_OUT, 0);
-		if (err != OK && err != ERR_BUSY) {
-			// Got an error
-			disconnect_from_host();
-			status = STATUS_ERROR;
-		}
-	}
-
+StreamPeerTCP::Status StreamPeerTCP::get_status() const {
 	return status;
 }
 
@@ -287,7 +256,7 @@ void StreamPeerTCP::disconnect_from_host() {
 	peer_port = 0;
 }
 
-Error StreamPeerTCP::poll(NetSocket::PollType p_type, int timeout) {
+Error StreamPeerTCP::wait(NetSocket::PollType p_type, int timeout) {
 	ERR_FAIL_COND_V(_sock.is_null() || !_sock->is_open(), ERR_UNAVAILABLE);
 	return _sock->poll(p_type, timeout);
 }
@@ -346,7 +315,7 @@ Error StreamPeerTCP::_connect(const String &p_address, int p_port) {
 void StreamPeerTCP::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("bind", "port", "host"), &StreamPeerTCP::bind, DEFVAL("*"));
 	ClassDB::bind_method(D_METHOD("connect_to_host", "host", "port"), &StreamPeerTCP::_connect);
-	ClassDB::bind_method(D_METHOD("is_connected_to_host"), &StreamPeerTCP::is_connected_to_host);
+	ClassDB::bind_method(D_METHOD("poll"), &StreamPeerTCP::poll);
 	ClassDB::bind_method(D_METHOD("get_status"), &StreamPeerTCP::get_status);
 	ClassDB::bind_method(D_METHOD("get_connected_host"), &StreamPeerTCP::get_connected_host);
 	ClassDB::bind_method(D_METHOD("get_connected_port"), &StreamPeerTCP::get_connected_port);

+ 6 - 5
core/io/stream_peer_tcp.h

@@ -55,7 +55,6 @@ protected:
 	uint16_t peer_port = 0;
 
 	Error _connect(const String &p_address, int p_port);
-	Error _poll_connection();
 	Error write(const uint8_t *p_data, int p_bytes, int &r_sent, bool p_block);
 	Error read(uint8_t *p_buffer, int p_bytes, int &r_received, bool p_block);
 
@@ -66,19 +65,21 @@ public:
 
 	Error bind(int p_port, const IPAddress &p_host);
 	Error connect_to_host(const IPAddress &p_host, int p_port);
-	bool is_connected_to_host() const;
 	IPAddress get_connected_host() const;
 	int get_connected_port() const;
 	int get_local_port() const;
 	void disconnect_from_host();
 
 	int get_available_bytes() const override;
-	Status get_status();
+	Status get_status() const;
 
 	void set_no_delay(bool p_enabled);
 
-	// Poll functions (wait or check for writable, readable)
-	Error poll(NetSocket::PollType p_type, int timeout = 0);
+	// Poll socket updating its state.
+	Error poll();
+
+	// Wait or check for writable, readable.
+	Error wait(NetSocket::PollType p_type, int timeout = 0);
 
 	// Read/Write from StreamPeer
 	Error put_data(const uint8_t *p_data, int p_bytes) override;

+ 1 - 1
doc/classes/PacketPeerUDP.xml

@@ -61,7 +61,7 @@
 				Returns whether this [PacketPeerUDP] is bound to an address and can receive packets.
 			</description>
 		</method>
-		<method name="is_connected_to_host" qualifiers="const">
+		<method name="is_socket_connected" qualifiers="const">
 			<return type="bool" />
 			<description>
 				Returns [code]true[/code] if the UDP socket is open and has been connected to a remote address. See [method connect_to_host].

+ 4 - 4
doc/classes/StreamPeerTCP.xml

@@ -51,16 +51,16 @@
 				Returns the local port to which this peer is bound.
 			</description>
 		</method>
-		<method name="get_status">
+		<method name="get_status" qualifiers="const">
 			<return type="int" enum="StreamPeerTCP.Status" />
 			<description>
 				Returns the status of the connection, see [enum Status].
 			</description>
 		</method>
-		<method name="is_connected_to_host" qualifiers="const">
-			<return type="bool" />
+		<method name="poll">
+			<return type="int" enum="Error" />
 			<description>
-				Returns [code]true[/code] if this peer is currently connected or is connecting to a host, [code]false[/code] otherwise.
+				Poll the socket, updating its state. See [method get_status].
 			</description>
 		</method>
 		<method name="set_no_delay">

+ 1 - 1
modules/mbedtls/packet_peer_mbed_dtls.cpp

@@ -115,7 +115,7 @@ Error PacketPeerMbedDTLS::_do_handshake() {
 }
 
 Error PacketPeerMbedDTLS::connect_to_peer(Ref<PacketPeerUDP> p_base, bool p_validate_certs, const String &p_for_hostname, Ref<X509Certificate> p_ca_certs) {
-	ERR_FAIL_COND_V(!p_base.is_valid() || !p_base->is_connected_to_host(), ERR_INVALID_PARAMETER);
+	ERR_FAIL_COND_V(!p_base.is_valid() || !p_base->is_socket_connected(), ERR_INVALID_PARAMETER);
 
 	base = p_base;
 	int ret = 0;

+ 2 - 1
modules/websocket/wsl_client.cpp

@@ -273,6 +273,7 @@ void WSLClient::poll() {
 		return; // Not connected.
 	}
 
+	_tcp->poll();
 	switch (_tcp->get_status()) {
 		case StreamPeerTCP::STATUS_NONE:
 			// Clean close
@@ -336,7 +337,7 @@ MultiplayerPeer::ConnectionStatus WSLClient::get_connection_status() const {
 		return CONNECTION_CONNECTED;
 	}
 
-	if (_tcp->is_connected_to_host() || _resolver_id != IP::RESOLVER_INVALID_ID) {
+	if (_tcp->get_status() == StreamPeerTCP::STATUS_CONNECTING || _resolver_id != IP::RESOLVER_INVALID_ID) {
 		return CONNECTION_CONNECTING;
 	}