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 NetworkVehicleType : uint8_t {
  NETWORK_VEH_TRAIN = 0,
  NETWORK_VEH_LORRY,
  NETWORK_VEH_BUS,
  NETWORK_VEH_PLANE,
  NETWORK_VEH_SHIP,
 
  NETWORK_VEH_END
};

enum ServerGameType : uint8_t {
  SERVER_GAME_TYPE_LOCAL = 0,
  SERVER_GAME_TYPE_PUBLIC,
  SERVER_GAME_TYPE_INVITE_ONLY,
};

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 {
  uint16_t num_vehicle[NETWORK_VEH_END];            
  uint16_t num_station[NETWORK_VEH_END];            
  bool ai;                                        
};
 
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 NetworkErrorCode : uint8_t {
  NETWORK_ERROR_GENERAL, // Try to use this one like never
 
  /* Signals from clients */
  NETWORK_ERROR_DESYNC,
  NETWORK_ERROR_SAVEGAME_FAILED,
  NETWORK_ERROR_CONNECTION_LOST,
  NETWORK_ERROR_ILLEGAL_PACKET,
  NETWORK_ERROR_NEWGRF_MISMATCH,
 
  /* Signals from servers */
  NETWORK_ERROR_NOT_AUTHORIZED,
  NETWORK_ERROR_NOT_EXPECTED,
  NETWORK_ERROR_WRONG_REVISION,
  NETWORK_ERROR_NAME_IN_USE,
  NETWORK_ERROR_WRONG_PASSWORD,
  NETWORK_ERROR_COMPANY_MISMATCH, // Happens in CLIENT_COMMAND
  NETWORK_ERROR_KICKED,
  NETWORK_ERROR_CHEATER,
  NETWORK_ERROR_FULL,
  NETWORK_ERROR_TOO_MANY_COMMANDS,
  NETWORK_ERROR_TIMEOUT_PASSWORD,
  NETWORK_ERROR_TIMEOUT_COMPUTER,
  NETWORK_ERROR_TIMEOUT_MAP,
  NETWORK_ERROR_TIMEOUT_JOIN,
  NETWORK_ERROR_INVALID_CLIENT_NAME,
  NETWORK_ERROR_NOT_ON_ALLOW_LIST,
  NETWORK_ERROR_NO_AUTHENTICATION_METHOD_AVAILABLE,
 
  NETWORK_ERROR_END,
};

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 */