Merge pull request #3938 from IvanSavenko/lobby_fixes

[1.5.1] Fixes for issues with lobby server

lib/network/NetworkConnection.cpp

@@ -12,12 +12,12 @@
 
 VCMI_LIB_NAMESPACE_BEGIN
 
-NetworkConnection::NetworkConnection(INetworkConnectionListener & listener, const std::shared_ptr<NetworkSocket> & socket)
+NetworkConnection::NetworkConnection(INetworkConnectionListener & listener, const std::shared_ptr<NetworkSocket> & socket, const std::shared_ptr<NetworkContext> & context)
 	: socket(socket)
+	, timer(std::make_shared<NetworkTimer>(*context))
 	, listener(listener)
 {
 	socket->set_option(boost::asio::ip::tcp::no_delay(true));
-	socket->set_option(boost::asio::socket_base::keep_alive(true));
 
 	// iOS throws exception on attempt to set buffer size
 	constexpr auto bufferSize = 4 * 1024 * 1024;
@@ -42,6 +42,12 @@ NetworkConnection::NetworkConnection(INetworkConnectionListener & listener, cons
 }
 
 void NetworkConnection::start()
+{
+	heartbeat();
+	startReceiving();
+}
+
+void NetworkConnection::startReceiving()
 {
 	boost::asio::async_read(*socket,
 							readBuffer,
@@ -49,6 +55,24 @@ void NetworkConnection::start()
 							[self = shared_from_this()](const auto & ec, const auto & endpoint) { self->onHeaderReceived(ec); });
 }
 
+void NetworkConnection::heartbeat()
+{
+	constexpr auto heartbeatInterval = std::chrono::seconds(10);
+
+	timer->expires_after(heartbeatInterval);
+	timer->async_wait( [self = shared_from_this()](const auto & ec)
+	{
+		if (ec)
+			return;
+
+		if (!self->socket->is_open())
+			return;
+
+		self->sendPacket({});
+		self->heartbeat();
+	});
+}
+
 void NetworkConnection::onHeaderReceived(const boost::system::error_code & ecHeader)
 {
 	if (ecHeader)
@@ -71,8 +95,8 @@ void NetworkConnection::onHeaderReceived(const boost::system::error_code & ecHea
 
 	if (messageSize == 0)
 	{
-		// Zero-sized packet. Strange, but safe to ignore. Start reading next packet
-		start();
+		//heartbeat package with no payload - wait for next packet
+		startReceiving();
 		return;
 	}
 
@@ -99,29 +123,57 @@ void NetworkConnection::onPacketReceived(const boost::system::error_code & ec, u
 	readBuffer.sgetn(reinterpret_cast<char *>(message.data()), expectedPacketSize);
 	listener.onPacketReceived(shared_from_this(), message);
 
-	start();
+	startReceiving();
 }
 
 void NetworkConnection::sendPacket(const std::vector<std::byte> & message)
 {
 	std::lock_guard<std::mutex> lock(writeMutex);
+	std::vector<std::byte> headerVector(sizeof(uint32_t));
+	uint32_t messageSize = message.size();
+	std::memcpy(headerVector.data(), &messageSize, sizeof(uint32_t));
 
-	boost::system::error_code ec;
-
-	// create array with single element - boost::asio::buffer can be constructed from containers, but not from plain integer
-	std::array<uint32_t, 1> messageSize{static_cast<uint32_t>(message.size())};
-
-	boost::asio::write(*socket, boost::asio::buffer(messageSize), ec );
+	bool messageQueueEmpty = dataToSend.empty();
+	dataToSend.push_back(headerVector);
 	if (message.size() > 0)
-		boost::asio::write(*socket, boost::asio::buffer(message), ec );
+		dataToSend.push_back(message);
 
-	//Note: ignoring error code, intended
+	if (messageQueueEmpty)
+		doSendData();
+	//else - data sending loop is still active and still sending previous messages
+}
+
+void NetworkConnection::doSendData()
+{
+	if (dataToSend.empty())
+		throw std::runtime_error("Attempting to sent data but there is no data to send!");
+
+	boost::asio::async_write(*socket, boost::asio::buffer(dataToSend.front()), [self = shared_from_this()](const auto & error, const auto & )
+	{
+		self->onDataSent(error);
+	});
+}
+
+void NetworkConnection::onDataSent(const boost::system::error_code & ec)
+{
+	std::lock_guard<std::mutex> lock(writeMutex);
+	dataToSend.pop_front();
+	if (ec)
+	{
+		logNetwork->error("Failed to send package: %s", ec.message());
+		listener.onDisconnected(shared_from_this(), ec.message());
+		return;
+	}
+
+	if (!dataToSend.empty())
+		doSendData();
 }
 
 void NetworkConnection::close()
 {
 	boost::system::error_code ec;
 	socket->close(ec);
+	timer->cancel(ec);
 
 	//NOTE: ignoring error code, intended
 }

lib/network/NetworkConnection.h

@@ -18,17 +18,25 @@ class NetworkConnection : public INetworkConnection, public std::enable_shared_f
 	static const int messageHeaderSize = sizeof(uint32_t);
 	static const int messageMaxSize = 64 * 1024 * 1024; // arbitrary size to prevent potential massive allocation if we receive garbage input
 
+	std::list<std::vector<std::byte>> dataToSend;
 	std::shared_ptr<NetworkSocket> socket;
+	std::shared_ptr<NetworkTimer> timer;
 	std::mutex writeMutex;
 
 	NetworkBuffer readBuffer;
 	INetworkConnectionListener & listener;
 
+	void heartbeat();
+
+	void startReceiving();
 	void onHeaderReceived(const boost::system::error_code & ec);
 	void onPacketReceived(const boost::system::error_code & ec, uint32_t expectedPacketSize);
 
+	void doSendData();
+	void onDataSent(const boost::system::error_code & ec);
+
 public:
-	NetworkConnection(INetworkConnectionListener & listener, const std::shared_ptr<NetworkSocket> & socket);
+	NetworkConnection(INetworkConnectionListener & listener, const std::shared_ptr<NetworkSocket> & socket, const std::shared_ptr<NetworkContext> & context);
 
 	void start();
 	void close() override;

lib/network/NetworkHandler.cpp

@@ -35,7 +35,7 @@ void NetworkHandler::connectToRemote(INetworkClientListener & listener, const st
 	auto resolver = std::make_shared<boost::asio::ip::tcp::resolver>(*io);
 
 	resolver->async_resolve(host, std::to_string(port),
-	[&listener, resolver, socket](const boost::system::error_code& error, const boost::asio::ip::tcp::resolver::results_type & endpoints)
+	[this, &listener, resolver, socket](const boost::system::error_code& error, const boost::asio::ip::tcp::resolver::results_type & endpoints)
 	{
 		if (error)
 		{
@@ -43,14 +43,14 @@ void NetworkHandler::connectToRemote(INetworkClientListener & listener, const st
 			return;
 		}
 
-		boost::asio::async_connect(*socket, endpoints, [socket, &listener](const boost::system::error_code& error, const boost::asio::ip::tcp::endpoint& endpoint)
+		boost::asio::async_connect(*socket, endpoints, [this, socket, &listener](const boost::system::error_code& error, const boost::asio::ip::tcp::endpoint& endpoint)
 		{
 			if (error)
 			{
 				listener.onConnectionFailed(error.message());
 				return;
 			}
-			auto connection = std::make_shared<NetworkConnection>(listener, socket);
+			auto connection = std::make_shared<NetworkConnection>(listener, socket, io);
 			connection->start();
 
 			listener.onConnectionEstablished(connection);

lib/network/NetworkServer.cpp

@@ -39,7 +39,7 @@ void NetworkServer::connectionAccepted(std::shared_ptr<NetworkSocket> upcomingCo
 	}
 
 	logNetwork->info("We got a new connection! :)");
-	auto connection = std::make_shared<NetworkConnection>(*this, upcomingConnection);
+	auto connection = std::make_shared<NetworkConnection>(*this, upcomingConnection, io);
 	connections.insert(connection);
 	connection->start();
 	listener.onNewConnection(connection);