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 <http://www.gnu.org/licenses/>.
 */
 
#ifndef NETWORK_CLIENT_H
#define NETWORK_CLIENT_H
 
#include "network_internal.h"
 
class ClientNetworkGameSocketHandler : public ZeroedMemoryAllocator, public NetworkGameSocketHandler {
private:
  std::unique_ptr<class NetworkAuthenticationClientHandler> authentication_handler; 
  std::string connection_string; 
  std::shared_ptr<struct PacketReader> savegame; 
  uint8_t token;                    
 
  enum ServerStatus {
    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; 
 
protected:
  friend void NetworkExecuteLocalCommandQueue();
  friend void NetworkClose(bool close_admins);
  static ClientNetworkGameSocketHandler *my_client; 
 
  NetworkRecvStatus Receive_SERVER_FULL(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_BANNED(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_ERROR(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_CLIENT_INFO(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_AUTH_REQUEST(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_ENABLE_ENCRYPTION(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_WELCOME(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_WAIT(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_MAP_BEGIN(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_MAP_SIZE(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_MAP_DATA(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_MAP_DONE(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_JOIN(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_FRAME(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_SYNC(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_COMMAND(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_CHAT(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_EXTERNAL_CHAT(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_QUIT(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_ERROR_QUIT(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_SHUTDOWN(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_NEWGAME(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_RCON(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_CHECK_NEWGRFS(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_MOVE(Packet &p) override;
  NetworkRecvStatus Receive_SERVER_CONFIG_UPDATE(Packet &p) override;
 
  static NetworkRecvStatus SendNewGRFsOk();
  static NetworkRecvStatus SendGetMap();
  static NetworkRecvStatus SendMapOk();
  static NetworkRecvStatus SendIdentify();
  void CheckConnection();
public:
  ClientNetworkGameSocketHandler(SOCKET s, const std::string &connection_string);
  ~ClientNetworkGameSocketHandler();
 
  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, DestType type, int dest, const std::string &msg, int64_t data);
  static NetworkRecvStatus SendSetName(const std::string &name);
  static NetworkRecvStatus SendRCon(const std::string &password, const std::string &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 */