2023-04-10 10:21:07 +02:00
|
|
|
/* Copyright (C) 2023 Wildfire Games.
|
2009-04-18 19:00:33 +02:00
|
|
|
* This file is part of 0 A.D.
|
|
|
|
*
|
|
|
|
* 0 A.D. is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation, either version 2 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* 0 A.D. is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
2009-04-11 19:00:39 +02:00
|
|
|
#include "precompiled.h"
|
2021-01-06 16:26:11 +01:00
|
|
|
|
2009-04-11 19:00:39 +02:00
|
|
|
#include "NetSession.h"
|
2021-01-06 16:26:11 +01:00
|
|
|
|
2010-06-30 23:41:04 +02:00
|
|
|
#include "NetClient.h"
|
2023-04-10 10:21:07 +02:00
|
|
|
#include "NetEnet.h"
|
2010-06-30 23:41:04 +02:00
|
|
|
#include "NetMessage.h"
|
2021-01-06 16:26:11 +01:00
|
|
|
#include "NetServer.h"
|
2010-07-03 15:15:01 +02:00
|
|
|
#include "NetStats.h"
|
2010-06-30 23:41:04 +02:00
|
|
|
#include "ps/CLogger.h"
|
2016-06-21 12:33:11 +02:00
|
|
|
#include "ps/Profile.h"
|
2009-04-11 19:00:39 +02:00
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
constexpr int NETCLIENT_POLL_TIMEOUT = 50;
|
2016-02-18 14:10:59 +01:00
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
constexpr int CHANNEL_COUNT = 1;
|
Prevent players from disconnecting during the loading screen by increasing the timeout tolerance to 60 seconds for that period, fixes #5163.
The NetClient runs in the main thread, so any part of the loading screen
consuming several seconds makes that client timeout.
This is a workaround because threading the NetClient would have prevent
these timeouts, refs #3700.
Coutnerintuitively, since enet timeout tolerance is proportional to the
latency, the better the connection of the player, the more likely it was
to drop on gamestart.
This problem became very frequent in Alpha 23, at least due to the Aura
bugfix 583b6ec625, AIInterface being particularly slow and that not
having been disabled yet in the loading screen resulting in additional
10 second freezes during the loading screen, even on empty maps, refs
#5200, 8e168f85e6.
Differential Revision: https://code.wildfiregames.com/D1513
Based on patch by: causative
This was SVN commit r21842.
2018-06-07 00:09:38 +02:00
|
|
|
|
2010-06-30 23:41:04 +02:00
|
|
|
CNetClientSession::CNetClientSession(CNetClient& client) :
|
2021-01-06 16:26:11 +01:00
|
|
|
m_Client(client), m_FileTransferer(this), m_Host(nullptr), m_Server(nullptr),
|
2021-02-27 18:44:59 +01:00
|
|
|
m_Stats(nullptr), m_IncomingMessages(16), m_OutgoingMessages(16),
|
2021-01-06 16:26:11 +01:00
|
|
|
m_LoopRunning(false), m_ShouldShutdown(false), m_MeanRTT(0), m_LastReceivedTime(0)
|
2010-06-30 23:41:04 +02:00
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
CNetClientSession::~CNetClientSession()
|
|
|
|
{
|
2021-01-06 16:26:11 +01:00
|
|
|
ENSURE(!m_LoopRunning);
|
|
|
|
|
2010-07-03 15:15:01 +02:00
|
|
|
delete m_Stats;
|
|
|
|
|
2010-07-02 23:28:48 +02:00
|
|
|
if (m_Host && m_Server)
|
|
|
|
{
|
2010-07-06 21:54:17 +02:00
|
|
|
// Disconnect immediately (we can't wait for acks)
|
2016-01-25 13:56:30 +01:00
|
|
|
enet_peer_disconnect_now(m_Server, NDR_SERVER_SHUTDOWN);
|
2010-07-02 23:28:48 +02:00
|
|
|
enet_host_destroy(m_Host);
|
2010-06-30 23:41:04 +02:00
|
|
|
|
2010-07-02 23:28:48 +02:00
|
|
|
m_Host = NULL;
|
|
|
|
m_Server = NULL;
|
|
|
|
}
|
2010-06-30 23:41:04 +02:00
|
|
|
}
|
|
|
|
|
2021-02-27 18:44:59 +01:00
|
|
|
bool CNetClientSession::Connect(const CStr& server, const u16 port, ENetHost* enetClient)
|
2010-06-30 23:41:04 +02:00
|
|
|
{
|
2021-01-06 16:26:11 +01:00
|
|
|
ENSURE(!m_LoopRunning);
|
2011-04-30 15:01:45 +02:00
|
|
|
ENSURE(!m_Host);
|
|
|
|
ENSURE(!m_Server);
|
2010-06-30 23:41:04 +02:00
|
|
|
|
2023-04-10 10:21:07 +02:00
|
|
|
// Create ENet host if necessary.
|
|
|
|
ENetHost* host = enetClient != nullptr ? enetClient : PS::Enet::CreateHost(nullptr, 1, CHANNEL_COUNT);
|
STUN + XMPP ICE implementation.
Allows lobby players to host games without having to configure their
router.
Differential Revision: https://code.wildfiregames.com/D364
Fixes #2305
Patch By: fcxSanya.
StunClient based on code by SuperTuxKart, relicensed with approval of
the according authors hilnius, hiker, Auria, deveee, Flakebi, leper,
konstin and KroArtem.
Added rfc5245 (ejabberd) support, a GUI option, refactoring and segfault
fixes by myself.
Tested By: user1, Sandarac, Sestroretsk1714, Vladislav, Grugnas,
javiergodas
Partially Reviewed By: leper, Philip, echotangoecho
This was SVN commit r19703.
2017-06-01 08:33:52 +02:00
|
|
|
|
2010-06-30 23:41:04 +02:00
|
|
|
if (!host)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
// Bind to specified host
|
|
|
|
ENetAddress addr;
|
|
|
|
addr.port = port;
|
|
|
|
if (enet_address_set_host(&addr, server.c_str()) < 0)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
// Initiate connection to server
|
2011-05-29 22:57:28 +02:00
|
|
|
ENetPeer* peer = enet_host_connect(host, &addr, CHANNEL_COUNT, 0);
|
2010-06-30 23:41:04 +02:00
|
|
|
if (!peer)
|
|
|
|
return false;
|
|
|
|
|
|
|
|
m_Host = host;
|
|
|
|
m_Server = peer;
|
|
|
|
|
2010-07-03 15:15:01 +02:00
|
|
|
m_Stats = new CNetStatsTable(m_Server);
|
2010-07-04 21:59:05 +02:00
|
|
|
if (CProfileViewer::IsInitialised())
|
|
|
|
g_ProfileViewer.AddRootTable(m_Stats);
|
2010-07-03 15:15:01 +02:00
|
|
|
|
2010-06-30 23:41:04 +02:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
void CNetClientSession::RunNetLoop(CNetClientSession* session)
|
2010-06-30 23:41:04 +02:00
|
|
|
{
|
2021-01-06 16:26:11 +01:00
|
|
|
ENSURE(!session->m_LoopRunning);
|
|
|
|
session->m_LoopRunning = true;
|
2019-09-26 13:36:03 +02:00
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
debug_SetThreadName("NetClientSession loop");
|
2010-06-30 23:41:04 +02:00
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
while (!session->m_ShouldShutdown)
|
|
|
|
{
|
|
|
|
ENSURE(session->m_Host && session->m_Server);
|
2010-06-30 23:41:04 +02:00
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
session->m_FileTransferer.Poll();
|
|
|
|
session->Poll();
|
|
|
|
session->Flush();
|
|
|
|
|
|
|
|
session->m_LastReceivedTime = enet_time_get() - session->m_Server->lastReceiveTime;
|
|
|
|
session->m_MeanRTT = session->m_Server->roundTripTime;
|
|
|
|
}
|
2010-07-03 15:15:01 +02:00
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
session->m_LoopRunning = false;
|
|
|
|
|
|
|
|
// Deleting the session is handled in this thread as it might outlive the CNetClient.
|
|
|
|
SAFE_DELETE(session);
|
|
|
|
}
|
|
|
|
|
|
|
|
void CNetClientSession::Shutdown()
|
|
|
|
{
|
|
|
|
m_ShouldShutdown = true;
|
2010-06-30 23:41:04 +02:00
|
|
|
}
|
|
|
|
|
2010-07-06 21:54:17 +02:00
|
|
|
void CNetClientSession::Poll()
|
2010-06-30 23:41:04 +02:00
|
|
|
{
|
2021-01-06 16:26:11 +01:00
|
|
|
ENetEvent event;
|
2011-11-04 02:35:50 +01:00
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
// Use the timeout to make the thread wait and save CPU time.
|
|
|
|
if (enet_host_service(m_Host, &event, NETCLIENT_POLL_TIMEOUT) <= 0)
|
|
|
|
return;
|
2010-06-30 23:41:04 +02:00
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
if (event.type == ENET_EVENT_TYPE_CONNECT)
|
|
|
|
{
|
|
|
|
ENSURE(event.peer == m_Server);
|
2011-10-27 18:46:48 +02:00
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
// Report the server address immediately.
|
|
|
|
char hostname[256] = "(error)";
|
|
|
|
enet_address_get_host_ip(&event.peer->address, hostname, ARRAY_SIZE(hostname));
|
|
|
|
LOGMESSAGE("Net client: Connected to %s:%u", hostname, (unsigned int)event.peer->address.port);
|
2021-01-15 08:54:55 +01:00
|
|
|
m_Connected = true;
|
2021-01-06 16:26:11 +01:00
|
|
|
|
|
|
|
m_IncomingMessages.push(event);
|
|
|
|
}
|
|
|
|
else if (event.type == ENET_EVENT_TYPE_DISCONNECT)
|
2010-06-30 23:41:04 +02:00
|
|
|
{
|
2021-01-06 16:26:11 +01:00
|
|
|
ENSURE(event.peer == m_Server);
|
2010-06-30 23:41:04 +02:00
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
// Report immediately.
|
|
|
|
LOGMESSAGE("Net client: Disconnected");
|
2021-01-15 08:54:55 +01:00
|
|
|
m_Connected = false;
|
2010-06-30 23:41:04 +02:00
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
m_IncomingMessages.push(event);
|
|
|
|
}
|
|
|
|
else if (event.type == ENET_EVENT_TYPE_RECEIVE)
|
|
|
|
m_IncomingMessages.push(event);
|
|
|
|
}
|
2010-06-30 23:41:04 +02:00
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
void CNetClientSession::Flush()
|
|
|
|
{
|
|
|
|
ENetPacket* packet;
|
|
|
|
while (m_OutgoingMessages.pop(packet))
|
|
|
|
if (enet_peer_send(m_Server, CNetHost::DEFAULT_CHANNEL, packet) < 0)
|
2021-01-15 08:54:55 +01:00
|
|
|
{
|
|
|
|
// Report the error, but do so silently if we know we are disconnected.
|
|
|
|
if (m_Connected)
|
|
|
|
LOGERROR("NetClient: Failed to send packet to server");
|
|
|
|
else
|
|
|
|
LOGMESSAGE("NetClient: Failed to send packet to server");
|
|
|
|
}
|
2010-06-30 23:41:04 +02:00
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
enet_host_flush(m_Host);
|
|
|
|
}
|
2010-06-30 23:41:04 +02:00
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
void CNetClientSession::ProcessPolledMessages()
|
|
|
|
{
|
|
|
|
ENetEvent event;
|
|
|
|
while(m_IncomingMessages.pop(event))
|
|
|
|
{
|
|
|
|
if (event.type == ENET_EVENT_TYPE_CONNECT)
|
|
|
|
m_Client.HandleConnect();
|
|
|
|
else if (event.type == ENET_EVENT_TYPE_DISCONNECT)
|
|
|
|
{
|
|
|
|
// This deletes the session, so we must break;
|
2010-07-06 21:54:17 +02:00
|
|
|
m_Client.HandleDisconnect(event.data);
|
2021-01-06 16:26:11 +01:00
|
|
|
break;
|
2010-06-30 23:41:04 +02:00
|
|
|
}
|
2021-01-06 16:26:11 +01:00
|
|
|
else if (event.type == ENET_EVENT_TYPE_RECEIVE)
|
2010-06-30 23:41:04 +02:00
|
|
|
{
|
2010-07-06 21:54:17 +02:00
|
|
|
CNetMessage* msg = CNetMessageFactory::CreateMessage(event.packet->data, event.packet->dataLength, m_Client.GetScriptInterface());
|
2010-06-30 23:41:04 +02:00
|
|
|
if (msg)
|
|
|
|
{
|
2015-01-22 21:36:24 +01:00
|
|
|
LOGMESSAGE("Net client: Received message %s of size %lu from server", msg->ToString().c_str(), (unsigned long)msg->GetSerializedLength());
|
2010-06-30 23:41:04 +02:00
|
|
|
|
2010-07-06 21:54:17 +02:00
|
|
|
m_Client.HandleMessage(msg);
|
2010-06-30 23:41:04 +02:00
|
|
|
}
|
2021-01-06 16:26:11 +01:00
|
|
|
// Thread-safe
|
2010-06-30 23:41:04 +02:00
|
|
|
enet_packet_destroy(event.packet);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
bool CNetClientSession::SendMessage(const CNetMessage* message)
|
2009-04-11 19:00:39 +02:00
|
|
|
{
|
2011-04-30 15:01:45 +02:00
|
|
|
ENSURE(m_Host && m_Server);
|
2010-06-30 23:41:04 +02:00
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
// Thread-safe.
|
|
|
|
ENetPacket* packet = CNetHost::CreatePacket(message);
|
|
|
|
if (!packet)
|
|
|
|
return false;
|
2009-04-11 19:00:39 +02:00
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
if (!m_OutgoingMessages.push(packet))
|
|
|
|
{
|
|
|
|
LOGERROR("NetClient: Failed to push message on the outgoing queue.");
|
|
|
|
return false;
|
|
|
|
}
|
2010-06-30 23:41:04 +02:00
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
return true;
|
2010-06-30 23:41:04 +02:00
|
|
|
}
|
|
|
|
|
2016-02-04 18:14:46 +01:00
|
|
|
u32 CNetClientSession::GetLastReceivedTime() const
|
|
|
|
{
|
|
|
|
if (!m_Server)
|
|
|
|
return 0;
|
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
return m_LastReceivedTime;
|
2016-02-04 18:14:46 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
u32 CNetClientSession::GetMeanRTT() const
|
|
|
|
{
|
|
|
|
if (!m_Server)
|
|
|
|
return 0;
|
|
|
|
|
2021-01-06 16:26:11 +01:00
|
|
|
return m_MeanRTT;
|
Prevent players from disconnecting during the loading screen by increasing the timeout tolerance to 60 seconds for that period, fixes #5163.
The NetClient runs in the main thread, so any part of the loading screen
consuming several seconds makes that client timeout.
This is a workaround because threading the NetClient would have prevent
these timeouts, refs #3700.
Coutnerintuitively, since enet timeout tolerance is proportional to the
latency, the better the connection of the player, the more likely it was
to drop on gamestart.
This problem became very frequent in Alpha 23, at least due to the Aura
bugfix 583b6ec625, AIInterface being particularly slow and that not
having been disabled yet in the loading screen resulting in additional
10 second freezes during the loading screen, even on empty maps, refs
#5200, 8e168f85e6.
Differential Revision: https://code.wildfiregames.com/D1513
Based on patch by: causative
This was SVN commit r21842.
2018-06-07 00:09:38 +02:00
|
|
|
}
|
|
|
|
|
2010-10-31 23:00:28 +01:00
|
|
|
CNetServerSession::CNetServerSession(CNetServerWorker& server, ENetPeer* peer) :
|
2021-02-27 18:44:59 +01:00
|
|
|
m_Server(server), m_FileTransferer(this), m_Peer(peer), m_HostID(0), m_GUID(), m_UserName()
|
2010-06-30 23:41:04 +02:00
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2016-05-08 18:25:00 +02:00
|
|
|
u32 CNetServerSession::GetIPAddress() const
|
2015-11-11 03:05:23 +01:00
|
|
|
{
|
2016-05-08 13:46:19 +02:00
|
|
|
return m_Peer->address.host;
|
2015-11-11 03:05:23 +01:00
|
|
|
}
|
|
|
|
|
2016-02-04 18:14:46 +01:00
|
|
|
u32 CNetServerSession::GetLastReceivedTime() const
|
|
|
|
{
|
|
|
|
if (!m_Peer)
|
|
|
|
return 0;
|
|
|
|
|
|
|
|
return enet_time_get() - m_Peer->lastReceiveTime;
|
|
|
|
}
|
|
|
|
|
|
|
|
u32 CNetServerSession::GetMeanRTT() const
|
|
|
|
{
|
|
|
|
if (!m_Peer)
|
|
|
|
return 0;
|
|
|
|
|
|
|
|
return m_Peer->roundTripTime;
|
|
|
|
}
|
|
|
|
|
2019-09-26 13:36:03 +02:00
|
|
|
void CNetServerSession::Disconnect(NetDisconnectReason reason)
|
2010-06-30 23:41:04 +02:00
|
|
|
{
|
2019-09-26 13:36:03 +02:00
|
|
|
if (reason == NDR_UNKNOWN)
|
|
|
|
LOGWARNING("Disconnecting client without communicating the disconnect reason!");
|
|
|
|
|
2010-07-06 21:54:17 +02:00
|
|
|
Update((uint)NMT_CONNECTION_LOST, NULL);
|
2010-06-30 23:41:04 +02:00
|
|
|
|
2019-09-26 13:36:03 +02:00
|
|
|
enet_peer_disconnect(m_Peer, static_cast<enet_uint32>(reason));
|
2010-06-30 23:41:04 +02:00
|
|
|
}
|
|
|
|
|
2019-09-26 13:36:03 +02:00
|
|
|
void CNetServerSession::DisconnectNow(NetDisconnectReason reason)
|
2010-06-30 23:41:04 +02:00
|
|
|
{
|
2019-09-26 13:36:03 +02:00
|
|
|
if (reason == NDR_UNKNOWN)
|
|
|
|
LOGWARNING("Disconnecting client without communicating the disconnect reason!");
|
|
|
|
|
|
|
|
enet_peer_disconnect_now(m_Peer, static_cast<enet_uint32>(reason));
|
2010-06-30 23:41:04 +02:00
|
|
|
}
|
|
|
|
|
2010-07-06 21:54:17 +02:00
|
|
|
bool CNetServerSession::SendMessage(const CNetMessage* message)
|
2010-06-30 23:41:04 +02:00
|
|
|
{
|
2010-07-06 21:54:17 +02:00
|
|
|
return m_Server.SendMessage(m_Peer, message);
|
2009-04-11 19:00:39 +02:00
|
|
|
}
|