Files @ r25958:603d75b53498
Branch filter:

Location: cpp/openttd-patchpack/source/src/network/network_turn.h

Patric Stout
Doc: update multiplayer documentation with latest changes (#9552)

Although several places were fixed during the PR making the change,
not all made it in this document.

While at it, removed all kinds of Markdown warnings by an excessive
usage of spacebar in this document.
/*
 * 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/>.
 */

/** @file network_turn.h Part of the network protocol handling TURN requests. */

#ifndef NETWORK_TURN_H
#define NETWORK_TURN_H

#include "core/tcp_turn.h"

/** Class for handling the client side of the TURN connection. */
class ClientNetworkTurnSocketHandler : public NetworkTurnSocketHandler {
private:
	std::string token;             ///< Token of this connection.
	uint8 tracking_number;         ///< Tracking number of this connection.
	std::string connection_string; ///< The connection string of the TURN server we are connecting to.

protected:
	bool Receive_TURN_ERROR(Packet *p) override;
	bool Receive_TURN_CONNECTED(Packet *p) override;

public:
	TCPConnecter *connecter = nullptr; ///< Connecter instance.
	bool connect_started = false;      ///< Whether we started the connection.

	ClientNetworkTurnSocketHandler(const std::string &token, uint8 tracking_number, const std::string &connection_string) : token(token), tracking_number(tracking_number), connection_string(connection_string) {}

	NetworkRecvStatus CloseConnection(bool error = true) override;
	~ClientNetworkTurnSocketHandler() override;
	void SendReceive();

	void Connect();
	void ConnectFailure();

	static std::unique_ptr<ClientNetworkTurnSocketHandler> Turn(const std::string &token, uint8 tracking_number, const std::string &ticket, const std::string &connection_string);
};

#endif /* NETWORK_TURN_H */