network_client.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_CLIENT_H
#define NETWORK_CLIENT_H
 
#include "network_internal.h"

class ClientNetworkGameSocketHandler : public NetworkGameSocketHandler {
private:
  std::unique_ptr<class NetworkAuthenticationClientHandler> authentication_handler = nullptr; 
  std::string connection_string; 
  std::shared_ptr<struct PacketReader> savegame = nullptr; 
  uint8_t token = 0; 

  enum ServerStatus : uint8_t {
    STATUS_INACTIVE,      
    STATUS_JOIN,          
    STATUS_AUTH_GAME,     
    STATUS_ENCRYPTED,     
    STATUS_NEWGRFS_CHECK, 
    STATUS_AUTHORIZED,    
    STATUS_MAP_WAIT,      
    STATUS_MAP,           
    STATUS_ACTIVE,        
    STATUS_END,           
  };
 
  ServerStatus status = STATUS_INACTIVE; 
 
protected:
  friend void NetworkExecuteLocalCommandQueue();
  friend void NetworkClose(bool close_admins);
  static ClientNetworkGameSocketHandler *my_client; 
 
  NetworkRecvStatus ReceiveServerFull(Packet &p) override;
  NetworkRecvStatus ReceiveServerBanned(Packet &p) override;
  NetworkRecvStatus ReceiveServerError(Packet &p) override;
  NetworkRecvStatus ReceiveServerClientInfo(Packet &p) override;
  NetworkRecvStatus ReceiveServerAuthenticationRequest(Packet &p) override;
  NetworkRecvStatus ReceiveServerEnableEncryption(Packet &p) override;
  NetworkRecvStatus ReceiveServerWelcome(Packet &p) override;
  NetworkRecvStatus ReceiveServerWaitForMap(Packet &p) override;
  NetworkRecvStatus ReceiveServerMapBegin(Packet &p) override;
  NetworkRecvStatus ReceiveServerMapSize(Packet &p) override;
  NetworkRecvStatus ReceiveServerMapData(Packet &p) override;
  NetworkRecvStatus ReceiveServerMapDone(Packet &p) override;
  NetworkRecvStatus ReceiveServerClientJoined(Packet &p) override;
  NetworkRecvStatus ReceiveServerFrame(Packet &p) override;
  NetworkRecvStatus ReceiveServerSync(Packet &p) override;
  NetworkRecvStatus ReceiveServerCommand(Packet &p) override;
  NetworkRecvStatus ReceiveServerChat(Packet &p) override;
  NetworkRecvStatus ReceiveServerExternalChat(Packet &p) override;
  NetworkRecvStatus ReceiveServerQuit(Packet &p) override;
  NetworkRecvStatus ReceiveServerErrorQuit(Packet &p) override;
  NetworkRecvStatus ReceiveServerShutdown(Packet &p) override;
  NetworkRecvStatus ReceiveServerNewGame(Packet &p) override;
  NetworkRecvStatus ReceiveServerRemoteConsoleCommand(Packet &p) override;
  NetworkRecvStatus ReceiveServerCheckNewGRFs(Packet &p) override;
  NetworkRecvStatus ReceiveServerMove(Packet &p) override;
  NetworkRecvStatus ReceiveServerConfigurationUpdate(Packet &p) override;
 
  static NetworkRecvStatus SendNewGRFsOk();
  static NetworkRecvStatus SendGetMap();
  static NetworkRecvStatus SendMapOk();
  static NetworkRecvStatus SendIdentify();
  void CheckConnection();
public:
  ClientNetworkGameSocketHandler(SOCKET s, std::string_view connection_string);
  ~ClientNetworkGameSocketHandler() override;
 
  NetworkRecvStatus CloseConnection(NetworkRecvStatus status) override;
  void ClientError(NetworkRecvStatus res);
 
  static NetworkRecvStatus SendJoin();
  static NetworkRecvStatus SendCommand(const CommandPacket &cp);
  static NetworkRecvStatus SendError(NetworkErrorCode errorno);
  static NetworkRecvStatus SendQuit();
  static NetworkRecvStatus SendAck();
 
  static NetworkRecvStatus SendAuthResponse();
 
  static NetworkRecvStatus SendChat(NetworkAction action, NetworkChatDestinationType type, int dest, std::string_view msg, int64_t data);
  static NetworkRecvStatus SendSetName(const std::string &name);
  static NetworkRecvStatus SendRCon(std::string_view password, std::string_view command);
  static NetworkRecvStatus SendMove(CompanyID company);
 
  static bool IsConnected();
 
  static void Send();
  static bool Receive();
  static bool GameLoop();
};

typedef ClientNetworkGameSocketHandler MyClient;
 
void NetworkClient_Connected();

struct NetworkJoinInfo {
  NetworkJoinInfo() : company(COMPANY_SPECTATOR) {}
  std::string connection_string; 
  CompanyID company;             
  std::string server_password;   
};
 
extern NetworkJoinInfo _network_join;
 
#endif /* NETWORK_CLIENT_H */