tcp_coordinator.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_CORE_TCP_COORDINATOR_H
#define NETWORK_CORE_TCP_COORDINATOR_H
 
#include "os_abstraction.h"
#include "tcp.h"
#include "packet.h"
#include "network_game_info.h"

enum class PacketCoordinatorType : uint8_t {
  GameCoordinatorError, 
  ServerRegister, 
  GameCoordinatorRegisterAck, 
  ServerUpdate, 
  ClientListing, 
  GameCoordinatorListing, 
  ClientConnect, 
  GameCoordinatorConnecting, 
  ServerOrClientConnectFailed, 
  GameCoordinatorConnectFailed, 
  ClientConnected, 
  GameCoordinatorDirectConnect, 
  GameCoordinatorStunRequest, 
  ServerOrClientStunResult, 
  GameCoordinatorStunConnect, 
  GameCoordinatorNewGRFLookup, 
  GameCoordinatorTurnConnect, 
};

template <> struct IsEnumPacketType<PacketCoordinatorType> {
  static constexpr bool value = true; 
};

enum ConnectionType : uint8_t {
  CONNECTION_TYPE_UNKNOWN,  
  CONNECTION_TYPE_ISOLATED, 
  CONNECTION_TYPE_DIRECT,   
  CONNECTION_TYPE_STUN,     
  CONNECTION_TYPE_TURN,     
};

enum NetworkCoordinatorErrorType : uint8_t {
  NETWORK_COORDINATOR_ERROR_UNKNOWN,              
  NETWORK_COORDINATOR_ERROR_REGISTRATION_FAILED,  
  NETWORK_COORDINATOR_ERROR_INVALID_INVITE_CODE,  
  NETWORK_COORDINATOR_ERROR_REUSE_OF_INVITE_CODE, 
};

class NetworkCoordinatorSocketHandler : public NetworkTCPSocketHandler {
protected:
  bool ReceiveInvalidPacket(PacketCoordinatorType type);

  virtual bool ReceiveGameCoordinatorError(Packet &p);

  virtual bool ReceiveServerRegister(Packet &p);

  virtual bool ReceiveGameCoordinatorRegisterAck(Packet &p);

  virtual bool ReceiveServerUpdate(Packet &p);

  virtual bool ReceiveClientListing(Packet &p);

  virtual bool ReceiveGameCoordinatorListing(Packet &p);

  virtual bool ReceiveClientConnect(Packet &p);

  virtual bool ReceiveGameCoordinatorConnecting(Packet &p);

  virtual bool ReceiveServerOrClientConnectFailed(Packet &p);

  virtual bool ReceiveGameCoordinatorConnectFailed(Packet &p);

  virtual bool ReceiveClientConnected(Packet &p);

  virtual bool ReceiveGameCoordinatorDirectConnect(Packet &p);

  virtual bool ReceiveGameCoordinatorStunRequest(Packet &p);

  virtual bool ReceiveServerOrClientStunResult(Packet &p);

  virtual bool ReceiveGameCoordinatorStunConnect(Packet &p);

  virtual bool ReceiveGameCoordinatorNewGRFLookup(Packet &p);

  virtual bool ReceiveGameCoordinatorTurnConnect(Packet &p);
 
  bool HandlePacket(Packet &p);
public:
  NetworkCoordinatorSocketHandler(SOCKET s = INVALID_SOCKET) : NetworkTCPSocketHandler(s) {}
 
  bool ReceivePackets();
};
 
#endif /* NETWORK_CORE_TCP_COORDINATOR_H */