Files @ r25958:603d75b53498
Branch filter:

Location: cpp/openttd-patchpack/source/src/network/core/tcp_listen.h - annotation

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.
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16344:08e6688931ee
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r25827:5a9ded1a0c1a
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r24441:8ae6bf969767
r24441:8ae6bf969767
r24441:8ae6bf969767
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r25655:1030dcb7eb52
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r25827:5a9ded1a0c1a
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r23964:f1693194d4bf
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r23536:ce42deb0b32d
r23536:ce42deb0b32d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r23607:36c15679007d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r23536:ce42deb0b32d
r23536:ce42deb0b32d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r23964:f1693194d4bf
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16618:d89f0c3f42e7
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r23520:20bbc807b0eb
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r23536:ce42deb0b32d
r23536:ce42deb0b32d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r23520:20bbc807b0eb
r25655:1030dcb7eb52
r25350:f2f32536f95c
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r23536:ce42deb0b32d
r23536:ce42deb0b32d
r16227:792ebc5cdc7d
r23517:1a32c3c14728
r25655:1030dcb7eb52
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
r16227:792ebc5cdc7d
/*
 * 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 tcp_listen.h Basic functions to listen for TCP connections.
 */

#ifndef NETWORK_CORE_TCP_LISTEN_H
#define NETWORK_CORE_TCP_LISTEN_H

#include "tcp.h"
#include "../network.h"
#include "../../core/pool_type.hpp"
#include "../../debug.h"
#include "table/strings.h"

/**
 * Template for TCP listeners.
 * @param Tsocket      The class we create sockets for.
 * @param Tfull_packet The packet type to return when we don't allow more sockets.
 * @param Tban_packet  The packet type to return when the client is banned.
 */
template <class Tsocket, PacketType Tfull_packet, PacketType Tban_packet>
class TCPListenHandler {
	/** List of sockets we listen on. */
	static SocketList sockets;

public:
	static bool ValidateClient(SOCKET s, NetworkAddress &address)
	{
		/* Check if the client is banned. */
		for (const auto &entry : _network_ban_list) {
			if (address.IsInNetmask(entry)) {
				Packet p(Tban_packet);
				p.PrepareToSend();

				Debug(net, 2, "[{}] Banned ip tried to join ({}), refused", Tsocket::GetName(), entry);

				if (p.TransferOut<int>(send, s, 0) < 0) {
					Debug(net, 0, "[{}] send failed: {}", Tsocket::GetName(), NetworkError::GetLast().AsString());
				}
				closesocket(s);
				return false;
			}
		}

		/* Can we handle a new client? */
		if (!Tsocket::AllowConnection()) {
			/* No more clients allowed?
			 * Send to the client that we are full! */
			Packet p(Tfull_packet);
			p.PrepareToSend();

			if (p.TransferOut<int>(send, s, 0) < 0) {
				Debug(net, 0, "[{}] send failed: {}", Tsocket::GetName(), NetworkError::GetLast().AsString());
			}
			closesocket(s);

			return false;
		}

		return true;
	}

	/**
	 * Accepts clients from the sockets.
	 * @param ls Socket to accept clients from.
	 */
	static void AcceptClient(SOCKET ls)
	{
		for (;;) {
			struct sockaddr_storage sin;
			memset(&sin, 0, sizeof(sin));
			socklen_t sin_len = sizeof(sin);
			SOCKET s = accept(ls, (struct sockaddr*)&sin, &sin_len);
			if (s == INVALID_SOCKET) return;
#ifdef __EMSCRIPTEN__
			sin_len = FixAddrLenForEmscripten(sin);
#endif

			SetNonBlocking(s); // XXX error handling?

			NetworkAddress address(sin, sin_len);
			Debug(net, 3, "[{}] Client connected from {} on frame {}", Tsocket::GetName(), address.GetHostname(), _frame_counter);

			SetNoDelay(s); // XXX error handling?

			if (!Tsocket::ValidateClient(s, address)) continue;
			Tsocket::AcceptConnection(s, address);
		}
	}

	/**
	 * Handle the receiving of packets.
	 * @return true if everything went okay.
	 */
	static bool Receive()
	{
		fd_set read_fd, write_fd;
		struct timeval tv;

		FD_ZERO(&read_fd);
		FD_ZERO(&write_fd);


		for (Tsocket *cs : Tsocket::Iterate()) {
			FD_SET(cs->sock, &read_fd);
			FD_SET(cs->sock, &write_fd);
		}

		/* take care of listener port */
		for (auto &s : sockets) {
			FD_SET(s.second, &read_fd);
		}

		tv.tv_sec = tv.tv_usec = 0; // don't block at all.
		if (select(FD_SETSIZE, &read_fd, &write_fd, nullptr, &tv) < 0) return false;

		/* accept clients.. */
		for (auto &s : sockets) {
			if (FD_ISSET(s.second, &read_fd)) AcceptClient(s.second);
		}

		/* read stuff from clients */
		for (Tsocket *cs : Tsocket::Iterate()) {
			cs->writable = !!FD_ISSET(cs->sock, &write_fd);
			if (FD_ISSET(cs->sock, &read_fd)) {
				cs->ReceivePackets();
			}
		}
		return _networking;
	}

	/**
	 * Listen on a particular port.
	 * @param port The port to listen on.
	 * @return true if listening succeeded.
	 */
	static bool Listen(uint16 port)
	{
		assert(sockets.size() == 0);

		NetworkAddressList addresses;
		GetBindAddresses(&addresses, port);

		for (NetworkAddress &address : addresses) {
			address.Listen(SOCK_STREAM, &sockets);
		}

		if (sockets.size() == 0) {
			Debug(net, 0, "Could not start network: could not create listening socket");
			ShowNetworkError(STR_NETWORK_ERROR_SERVER_START);
			return false;
		}

		return true;
	}

	/** Close the sockets we're listening on. */
	static void CloseListeners()
	{
		for (auto &s : sockets) {
			closesocket(s.second);
		}
		sockets.clear();
		Debug(net, 5, "[{}] Closed listeners", Tsocket::GetName());
	}
};

template <class Tsocket, PacketType Tfull_packet, PacketType Tban_packet> SocketList TCPListenHandler<Tsocket, Tfull_packet, Tban_packet>::sockets;

#endif /* NETWORK_CORE_TCP_LISTEN_H */