source/network/NetSession.cpp

   1 /* Copyright (C) 2017 Wildfire Games.
   2  * This file is part of 0 A.D.
   3  *
   4  * 0 A.D. is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * 0 A.D. is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #include "precompiled.h"
  19 #include "NetSession.h"
  20 #include "NetClient.h"
  21 #include "NetServer.h"
  22 #include "NetMessage.h"
  23 #include "NetStats.h"
  24 #include "lib/external_libraries/enet.h"
  25 #include "ps/CLogger.h"
  26 #include "ps/Profile.h"
  27 #include "scriptinterface/ScriptInterface.h"
  28
  29 const u32 NETWORK_WARNING_TIMEOUT = 2000;
  30
  31 const u32 MAXIMUM_HOST_TIMEOUT = std::numeric_limits<u32>::max();
  32
  33 static const int CHANNEL_COUNT = 1;
  34
  35 CNetClientSession::CNetClientSession(CNetClient& client) :
  36         m_Client(client), m_FileTransferer(this), m_Host(NULL), m_Server(NULL), m_Stats(NULL)
  37 {
  38 }
  39
  40 CNetClientSession::~CNetClientSession()
  41 {
  42         delete m_Stats;
  43
  44         if (m_Host && m_Server)
  45         {
  46                 // Disconnect immediately (we can't wait for acks)
  47                 enet_peer_disconnect_now(m_Server, NDR_SERVER_SHUTDOWN);
  48                 enet_host_destroy(m_Host);
  49
  50                 m_Host = NULL;
  51                 m_Server = NULL;
  52         }
  53 }
  54
  55 bool CNetClientSession::Connect(const CStr& server, const u16 port, const bool isLocalClient, ENetHost* enetClient)
  56 {
  57         ENSURE(!m_Host);
  58         ENSURE(!m_Server);
  59
  60         // Create ENet host
  61         ENetHost* host;
  62         if (enetClient != nullptr)
  63                 host = enetClient;
  64         else
  65                 host = enet_host_create(NULL, 1, CHANNEL_COUNT, 0, 0);
  66
  67         if (!host)
  68                 return false;
  69
  70         // Bind to specified host
  71         ENetAddress addr;
  72         addr.port = port;
  73         if (enet_address_set_host(&addr, server.c_str()) < 0)
  74                 return false;
  75
  76         // Initiate connection to server
  77         ENetPeer* peer = enet_host_connect(host, &addr, CHANNEL_COUNT, 0);
  78         if (!peer)
  79                 return false;
  80
  81         m_Host = host;
  82         m_Server = peer;
  83
  84         // Prevent the local client of the host from timing out too quickly.
  85 #if (ENET_VERSION >= ENET_VERSION_CREATE(1, 3, 4))
  86         if (isLocalClient)
  87                 enet_peer_timeout(peer, 1, MAXIMUM_HOST_TIMEOUT, MAXIMUM_HOST_TIMEOUT);
  88 #endif
  89
  90         m_Stats = new CNetStatsTable(m_Server);
  91         if (CProfileViewer::IsInitialised())
  92                 g_ProfileViewer.AddRootTable(m_Stats);
  93
  94         return true;
  95 }
  96
  97 void CNetClientSession::Disconnect(u32 reason)
  98 {
  99         ENSURE(m_Host && m_Server);
 100
 101         // TODO: ought to do reliable async disconnects, probably
 102         enet_peer_disconnect_now(m_Server, reason);
 103         enet_host_destroy(m_Host);
 104
 105         m_Host = NULL;
 106         m_Server = NULL;
 107
 108         SAFE_DELETE(m_Stats);
 109 }
 110
 111 void CNetClientSession::Poll()
 112 {
 113         PROFILE3("net client poll");
 114
 115         ENSURE(m_Host && m_Server);
 116
 117         m_FileTransferer.Poll();
 118
 119         ENetEvent event;
 120         while (enet_host_service(m_Host, &event, 0) > 0)
 121         {
 122                 switch (event.type)
 123                 {
 124                 case ENET_EVENT_TYPE_CONNECT:
 125                 {
 126                         ENSURE(event.peer == m_Server);
 127
 128                         // Report the server address
 129                         char hostname[256] = "(error)";
 130                         enet_address_get_host_ip(&event.peer->address, hostname, ARRAY_SIZE(hostname));
 131                         LOGMESSAGE("Net client: Connected to %s:%u", hostname, (unsigned int)event.peer->address.port);
 132
 133                         m_Client.HandleConnect();
 134
 135                         break;
 136                 }
 137
 138                 case ENET_EVENT_TYPE_DISCONNECT:
 139                 {
 140                         ENSURE(event.peer == m_Server);
 141
 142                         LOGMESSAGE("Net client: Disconnected");
 143                         m_Client.HandleDisconnect(event.data);
 144                         return;
 145                 }
 146
 147                 case ENET_EVENT_TYPE_RECEIVE:
 148                 {
 149                         CNetMessage* msg = CNetMessageFactory::CreateMessage(event.packet->data, event.packet->dataLength, m_Client.GetScriptInterface());
 150                         if (msg)
 151                         {
 152                                 LOGMESSAGE("Net client: Received message %s of size %lu from server", msg->ToString().c_str(), (unsigned long)msg->GetSerializedLength());
 153
 154                                 m_Client.HandleMessage(msg);
 155
 156                                 delete msg;
 157                         }
 158
 159                         enet_packet_destroy(event.packet);
 160
 161                         break;
 162                 }
 163
 164                 case ENET_EVENT_TYPE_NONE:
 165                         break;
 166                 }
 167         }
 168
 169 }
 170
 171 void CNetClientSession::Flush()
 172 {
 173         PROFILE3("net client flush");
 174
 175         ENSURE(m_Host && m_Server);
 176
 177         enet_host_flush(m_Host);
 178 }
 179
 180 bool CNetClientSession::SendMessage(const CNetMessage* message)
 181 {
 182         ENSURE(m_Host && m_Server);
 183
 184         return CNetHost::SendMessage(message, m_Server, "server");
 185 }
 186
 187 u32 CNetClientSession::GetLastReceivedTime() const
 188 {
 189         if (!m_Server)
 190                 return 0;
 191
 192         return enet_time_get() - m_Server->lastReceiveTime;
 193 }
 194
 195 u32 CNetClientSession::GetMeanRTT() const
 196 {
 197         if (!m_Server)
 198                 return 0;
 199
 200         return m_Server->roundTripTime;
 201 }
 202
 203
 204
 205 CNetServerSession::CNetServerSession(CNetServerWorker& server, ENetPeer* peer) :
 206         m_Server(server), m_FileTransferer(this), m_Peer(peer)
 207 {
 208 }
 209
 210 u32 CNetServerSession::GetIPAddress() const
 211 {
 212         return m_Peer->address.host;
 213 }
 214
 215 u32 CNetServerSession::GetLastReceivedTime() const
 216 {
 217         if (!m_Peer)
 218                 return 0;
 219
 220         return enet_time_get() - m_Peer->lastReceiveTime;
 221 }
 222
 223 u32 CNetServerSession::GetMeanRTT() const
 224 {
 225         if (!m_Peer)
 226                 return 0;
 227
 228         return m_Peer->roundTripTime;
 229 }
 230
 231 void CNetServerSession::Disconnect(u32 reason)
 232 {
 233         Update((uint)NMT_CONNECTION_LOST, NULL);
 234
 235         enet_peer_disconnect(m_Peer, reason);
 236 }
 237
 238 void CNetServerSession::DisconnectNow(u32 reason)
 239 {
 240         enet_peer_disconnect_now(m_Peer, reason);
 241 }
 242
 243 bool CNetServerSession::SendMessage(const CNetMessage* message)
 244 {
 245         return m_Server.SendMessage(m_Peer, message);
 246 }
 247
 248 bool CNetServerSession::IsLocalClient() const
 249 {
 250         return m_IsLocalClient;
 251 }
 252
 253 void CNetServerSession::SetLocalClient(bool isLocalClient)
 254 {
 255         m_IsLocalClient = isLocalClient;
 256
 257         if (!isLocalClient)
 258                 return;
 259
 260         // Prevent the local client of the host from timing out too quickly
 261 #if (ENET_VERSION >= ENET_VERSION_CREATE(1, 3, 4))
 262         enet_peer_timeout(m_Peer, 0, MAXIMUM_HOST_TIMEOUT, MAXIMUM_HOST_TIMEOUT);
 263 #endif
 264 }