network_type.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_TYPE_H
#define NETWORK_TYPE_H
 
#include "../core/enum_type.hpp"
#include "../core/pool_type.hpp"

static const uint MAX_CLIENTS = 255;

enum class NetworkVehicleType : uint8_t {
  Train = 0, 
  Truck, 
  Bus, 
  Aircraft, 
  Ship, 
 
  End 
};

enum class ServerGameType : uint8_t {
  Local = 0, 
  Public, 
  InviteOnly, 
};

enum ClientID : uint32_t {
  INVALID_CLIENT_ID = 0, 
  CLIENT_ID_SERVER  = 1, 
  CLIENT_ID_FIRST   = 2, 
};

using ClientPoolID = PoolID<uint16_t, struct ClientPoolIDTag, MAX_CLIENTS + 1 /* dedicated server. */, 0xFFFF>;

using AdminID = PoolID<uint8_t, struct AdminIDTag, 16, 0xFF>;

struct NetworkCompanyStats {
  using NetworkVehicleTypeArray = EnumClassIndexContainer<std::array<uint16_t, to_underlying(NetworkVehicleType::End)>, NetworkVehicleType>;
  NetworkVehicleTypeArray num_vehicle; 
  NetworkVehicleTypeArray num_station; 
};
 
struct NetworkClientInfo;

enum DestType : uint8_t {
  DESTTYPE_BROADCAST, 
  DESTTYPE_TEAM,      
  DESTTYPE_CLIENT,    
};
DECLARE_ENUM_AS_ADDABLE(DestType)
 

enum NetworkAction : uint8_t {
  NETWORK_ACTION_JOIN,
  NETWORK_ACTION_LEAVE,
  NETWORK_ACTION_SERVER_MESSAGE,
  NETWORK_ACTION_CHAT,
  NETWORK_ACTION_CHAT_COMPANY,
  NETWORK_ACTION_CHAT_CLIENT,
  NETWORK_ACTION_GIVE_MONEY,
  NETWORK_ACTION_NAME_CHANGE,
  NETWORK_ACTION_COMPANY_SPECTATOR,
  NETWORK_ACTION_COMPANY_JOIN,
  NETWORK_ACTION_COMPANY_NEW,
  NETWORK_ACTION_KICKED,
  NETWORK_ACTION_EXTERNAL_CHAT,
};

enum class NetworkErrorCode : uint8_t {
  General, 
 
  Desync, 
  SavegameFailed, 
  ConnectionLost, 
  IllegalPacket, 
  NewGRFMismatch, 
 
  NotAuthorized, 
  NotExpected, 
  WrongRevision, 
  NameInUse, 
  WrongPassword, 
  CompanyMismatch, 
  Kicked, 
  Cheater, 
  ServerFull, 
  TooManyCommands, 
  TimeoutPassword, 
  TimeoutComputer, 
  TimeoutMap, 
  TimeoutJoin, 
  InvalidClientName, 
  NotOnAllowList, 
  NoAuthenticationMethodAvailable, 
 
  /* When adding elements to this enumeration, update the mapping in GetLongNetworkErrorString and GetNetworkErrorMsg. */
};

class NetworkAuthorizedKeys : public std::vector<std::string> {
public:
  bool Contains(std::string_view key) const;
  bool Add(std::string_view key);
  bool Remove(std::string_view key);
};
 
#endif /* NETWORK_TYPE_H */