network_server.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD 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, version 2.
 * OpenTTD 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 OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef NETWORK_SERVER_H
#define NETWORK_SERVER_H
 
#include "network_internal.h"
#include "core/tcp_listen.h"
 
class ServerNetworkGameSocketHandler;
typedef ServerNetworkGameSocketHandler NetworkClientSocket;
using NetworkClientSocketPool = Pool<NetworkClientSocket, ClientPoolID, 8, PoolType::NetworkClient>;
extern NetworkClientSocketPool _networkclientsocket_pool;

class ServerNetworkGameSocketHandler : public NetworkClientSocketPool::PoolItem<&_networkclientsocket_pool>, public NetworkGameSocketHandler, public TCPListenHandler<ServerNetworkGameSocketHandler, PacketGameType, PacketGameType::ServerFull, PacketGameType::ServerBanned> {
protected:
  std::unique_ptr<class NetworkAuthenticationServerHandler> authentication_handler = nullptr; 
  std::string peer_public_key{}; 
 
  NetworkRecvStatus ReceiveClientJoin(Packet &p) override;
  NetworkRecvStatus ReceiveClientIdentify(Packet &p) override;
  NetworkRecvStatus ReceiveClientGameInfo(Packet &p) override;
  NetworkRecvStatus ReceiveClientAuthenticationResponse(Packet &p) override;
  NetworkRecvStatus ReceiveClientGetMap(Packet &p) override;
  NetworkRecvStatus ReceiveClientMapOk(Packet &p) override;
  NetworkRecvStatus ReceiveClientAck(Packet &p) override;
  NetworkRecvStatus ReceiveClientCommand(Packet &p) override;
  NetworkRecvStatus ReceiveClientChat(Packet &p) override;
  NetworkRecvStatus ReceiveClientSetName(Packet &p) override;
  NetworkRecvStatus ReceiveClientQuit(Packet &p) override;
  NetworkRecvStatus ReceiveClientError(Packet &p) override;
  NetworkRecvStatus ReceiveClientRemoteConsoleCommand(Packet &p) override;
  NetworkRecvStatus ReceiveClientNewGRFsChecked(Packet &p) override;
  NetworkRecvStatus ReceiveClientMove(Packet &p) override;
 
  NetworkRecvStatus SendGameInfo();
  NetworkRecvStatus SendNewGRFCheck();
  NetworkRecvStatus SendWelcome();
  NetworkRecvStatus SendAuthRequest();
  NetworkRecvStatus SendEnableEncryption();
 
public:
  enum ClientStatus : uint8_t {
    STATUS_INACTIVE,      
    STATUS_AUTH_GAME,     
    STATUS_IDENTIFY,      
    STATUS_NEWGRFS_CHECK, 
    STATUS_AUTHORIZED,    
    STATUS_MAP_WAIT,      
    STATUS_MAP,           
    STATUS_DONE_MAP,      
    STATUS_PRE_ACTIVE,    
    STATUS_ACTIVE,        
    STATUS_END,           
  };
 
  uint8_t lag_test = 0; 
  uint8_t last_token = 0; 
  uint32_t last_token_frame = 0; 
  ClientStatus status = STATUS_INACTIVE; 
  CommandQueue outgoing_queue{}; 
  size_t receive_limit = 0; 
 
  std::shared_ptr<struct PacketWriter> savegame = nullptr; 
  NetworkAddress client_address{}; 
 
  ServerNetworkGameSocketHandler(ClientPoolID index, SOCKET s);
  ~ServerNetworkGameSocketHandler() override;
 
  std::unique_ptr<Packet> ReceivePacket() override;
  NetworkRecvStatus CloseConnection(NetworkRecvStatus status) override;
  std::string GetClientName() const;
 
  void CheckNextClientToSendMap(NetworkClientSocket *ignore_cs = nullptr);
 
  NetworkRecvStatus SendWait();
  NetworkRecvStatus SendMap();
  NetworkRecvStatus SendErrorQuit(ClientID client_id, NetworkErrorCode errorno);
  NetworkRecvStatus SendQuit(ClientID client_id);
  NetworkRecvStatus SendShutdown();
  NetworkRecvStatus SendNewGame();
  NetworkRecvStatus SendRConResult(uint16_t colour, std::string_view command);
  NetworkRecvStatus SendMove(ClientID client_id, CompanyID company_id);
 
  NetworkRecvStatus SendClientInfo(NetworkClientInfo *ci);
  NetworkRecvStatus SendError(NetworkErrorCode error, std::string_view reason = {});
  NetworkRecvStatus SendChat(NetworkAction action, ClientID client_id, bool self_send, std::string_view msg, int64_t data);
  NetworkRecvStatus SendExternalChat(std::string_view source, TextColour colour, std::string_view user, std::string_view msg);
  NetworkRecvStatus SendJoin(ClientID client_id);
  NetworkRecvStatus SendFrame();
  NetworkRecvStatus SendSync();
  NetworkRecvStatus SendCommand(const CommandPacket &cp);
  NetworkRecvStatus SendConfigUpdate();
 
  static void Send();
  static void AcceptConnection(SOCKET s, const NetworkAddress &address);
  static bool AllowConnection();

  static std::string_view GetName()
  {
    return "server";
  }
 
  std::string_view GetClientIP();

  std::string_view GetPeerPublicKey() const { return this->peer_public_key; }
 
  static ServerNetworkGameSocketHandler *GetByClientID(ClientID client_id);
};
 
void NetworkServer_Tick(bool send_frame);
void ChangeNetworkRestartTime(bool reset);
 
#endif /* NETWORK_SERVER_H */