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 PacketCoordinatorType : uint8_t {
  PACKET_COORDINATOR_GC_ERROR,              
  PACKET_COORDINATOR_SERVER_REGISTER,       
  PACKET_COORDINATOR_GC_REGISTER_ACK,       
  PACKET_COORDINATOR_SERVER_UPDATE,         
  PACKET_COORDINATOR_CLIENT_LISTING,        
  PACKET_COORDINATOR_GC_LISTING,            
  PACKET_COORDINATOR_CLIENT_CONNECT,        
  PACKET_COORDINATOR_GC_CONNECTING,         
  PACKET_COORDINATOR_SERCLI_CONNECT_FAILED, 
  PACKET_COORDINATOR_GC_CONNECT_FAILED,     
  PACKET_COORDINATOR_CLIENT_CONNECTED,      
  PACKET_COORDINATOR_GC_DIRECT_CONNECT,     
  PACKET_COORDINATOR_GC_STUN_REQUEST,       
  PACKET_COORDINATOR_SERCLI_STUN_RESULT,    
  PACKET_COORDINATOR_GC_STUN_CONNECT,       
  PACKET_COORDINATOR_GC_NEWGRF_LOOKUP,      
  PACKET_COORDINATOR_GC_TURN_CONNECT,       
  PACKET_COORDINATOR_END,                   
};

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 Receive_GC_ERROR(Packet &p);

  virtual bool Receive_SERVER_REGISTER(Packet &p);

  virtual bool Receive_GC_REGISTER_ACK(Packet &p);

  virtual bool Receive_SERVER_UPDATE(Packet &p);

  virtual bool Receive_CLIENT_LISTING(Packet &p);

  virtual bool Receive_GC_LISTING(Packet &p);

  virtual bool Receive_CLIENT_CONNECT(Packet &p);

  virtual bool Receive_GC_CONNECTING(Packet &p);

  virtual bool Receive_SERCLI_CONNECT_FAILED(Packet &p);

  virtual bool Receive_GC_CONNECT_FAILED(Packet &p);

  virtual bool Receive_CLIENT_CONNECTED(Packet &p);

  virtual bool Receive_GC_DIRECT_CONNECT(Packet &p);

  virtual bool Receive_GC_STUN_REQUEST(Packet &p);

  virtual bool Receive_SERCLI_STUN_RESULT(Packet &p);

  virtual bool Receive_GC_STUN_CONNECT(Packet &p);

  virtual bool Receive_GC_NEWGRF_LOOKUP(Packet &p);

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