OpenTTD Source 20260206-master-g4d4e37dbf1
network_coordinator.cpp
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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>.
6 */
7
9
10#include "../stdafx.h"
11#include "../debug.h"
12#include "../error.h"
13#include "../rev.h"
14#include "../settings_type.h"
15#include "../strings_func.h"
16#include "../window_func.h"
17#include "../window_type.h"
18#include "network.h"
19#include "network_coordinator.h"
20#include "network_gamelist.h"
21#include "network_gui.h"
22#include "network_internal.h"
23#include "network_server.h"
24#include "network_stun.h"
25#include "table/strings.h"
26
27#include "../safeguards.h"
28
29static const auto NETWORK_COORDINATOR_DELAY_BETWEEN_UPDATES = std::chrono::seconds(30);
33
35class NetworkDirectConnecter : public TCPConnecter {
36private:
37 std::string token;
39
40public:
48 NetworkDirectConnecter(std::string_view hostname, uint16_t port, std::string &&token, uint8_t tracking_number) : TCPConnecter(hostname, port), token(std::move(token)), tracking_number(tracking_number) {}
49
50 void OnFailure() override
51 {
52 _network_coordinator_client.ConnectFailure(this->token, this->tracking_number);
53 }
54
55 void OnConnect(SOCKET s) override
56 {
58 _network_coordinator_client.ConnectSuccess(this->token, s, address);
59 }
60};
61
63class NetworkReuseStunConnecter : public TCPConnecter {
64private:
65 std::string token;
67 uint8_t family;
68
69public:
79 NetworkReuseStunConnecter(std::string_view hostname, uint16_t port, const NetworkAddress &bind_address, std::string &&token, uint8_t tracking_number, uint8_t family) :
80 TCPConnecter(hostname, port, bind_address),
81 token(std::move(token)),
84 {
85 }
86
87 void OnFailure() override
88 {
89 /* Close the STUN connection too, as it is no longer of use. */
90 _network_coordinator_client.CloseStunHandler(this->token, this->family);
91
92 _network_coordinator_client.ConnectFailure(this->token, this->tracking_number);
93 }
94
95 void OnConnect(SOCKET s) override
96 {
98 _network_coordinator_client.ConnectSuccess(this->token, s, address);
99 }
100};
101
103class NetworkCoordinatorConnecter : public TCPConnecter {
104public:
110
111 void OnFailure() override
112 {
113 _network_coordinator_client.connecting = false;
114 _network_coordinator_client.CloseConnection(true);
115 }
116
117 void OnConnect(SOCKET s) override
118 {
119 assert(_network_coordinator_client.sock == INVALID_SOCKET);
120
122 _network_coordinator_client.last_activity = std::chrono::steady_clock::now();
123 _network_coordinator_client.connecting = false;
124 }
125};
126
128{
130 std::string detail = p.Recv_string(NETWORK_ERROR_DETAIL_LENGTH);
131 Debug(net, 9, "Coordinator::Receive_GC_ERROR({}, {})", error, detail);
132
133 switch (error) {
135 this->CloseConnection();
136 return false;
137
139 ShowErrorMessage(GetEncodedString(STR_NETWORK_ERROR_COORDINATOR_REGISTRATION_FAILED), {}, WL_ERROR);
140
141 /* To prevent that we constantly try to reconnect, switch to local game. */
142 _settings_client.network.server_game_type = SERVER_GAME_TYPE_LOCAL;
143
144 this->CloseConnection();
145 return false;
146
148 auto connecter_pre_it = this->connecter_pre.find(detail);
149 if (connecter_pre_it != this->connecter_pre.end()) {
150 connecter_pre_it->second->SetFailure();
151 this->connecter_pre.erase(connecter_pre_it);
152 }
153
154 /* Mark the server as offline. */
155 NetworkGame *item = NetworkGameListAddItem(detail);
156 item->status = NGLS_OFFLINE;
157
159 return true;
160 }
161
163 ShowErrorMessage(GetEncodedString(STR_NETWORK_ERROR_COORDINATOR_REUSE_OF_INVITE_CODE), {}, WL_ERROR);
164
165 /* To prevent that we constantly battle for the same invite-code, switch to local game. */
166 _settings_client.network.server_game_type = SERVER_GAME_TYPE_LOCAL;
167
168 this->CloseConnection();
169 return false;
170
171 default:
172 Debug(net, 0, "Invalid error type {} received from Game Coordinator", error);
173 this->CloseConnection();
174 return false;
175 }
176}
177
179{
180 /* Schedule sending an update. */
181 this->next_update = std::chrono::steady_clock::now();
182
183 _settings_client.network.server_invite_code = p.Recv_string(NETWORK_INVITE_CODE_LENGTH);
184 _settings_client.network.server_invite_code_secret = p.Recv_string(NETWORK_INVITE_CODE_SECRET_LENGTH);
186 Debug(net, 9, "Coordinator::Receive_GC_REGISTER_ACK({}, {})", _settings_client.network.server_invite_code, _network_server_connection_type);
187
190 GetEncodedString(STR_NETWORK_ERROR_COORDINATOR_ISOLATED),
191 GetEncodedString(STR_NETWORK_ERROR_COORDINATOR_ISOLATED_DETAIL),
192 WL_ERROR);
193 }
194
195 /* Users can change the invite code in the settings, but this has no effect
196 * on the invite code as assigned by the server. So
197 * _network_server_invite_code contains the current invite code,
198 * and _settings_client.network.server_invite_code contains the one we will
199 * attempt to re-use when registering again. */
200 _network_server_invite_code = _settings_client.network.server_invite_code;
201
203
204 if (_network_dedicated) {
205 std::string connection_type;
207 case CONNECTION_TYPE_ISOLATED: connection_type = "Remote players can't connect"; break;
208 case CONNECTION_TYPE_DIRECT: connection_type = "Public"; break;
209 case CONNECTION_TYPE_STUN: connection_type = "Behind NAT"; break;
210 case CONNECTION_TYPE_TURN: connection_type = "Via relay"; break;
211
212 case CONNECTION_TYPE_UNKNOWN: // Never returned from Game Coordinator.
213 default: connection_type = "Unknown"; break; // Should never happen, but don't fail if it does.
214 }
215
216 std::string game_type;
217 switch (_settings_client.network.server_game_type) {
218 case SERVER_GAME_TYPE_INVITE_ONLY: game_type = "Invite only"; break;
219 case SERVER_GAME_TYPE_PUBLIC: game_type = "Public"; break;
220
221 case SERVER_GAME_TYPE_LOCAL: // Impossible to register local servers.
222 default: game_type = "Unknown"; break; // Should never happen, but don't fail if it does.
223 }
224
225 Debug(net, 3, "----------------------------------------");
226 Debug(net, 3, "Your server is now registered with the Game Coordinator:");
227 Debug(net, 3, " Game type: {}", game_type);
228 Debug(net, 3, " Connection type: {}", connection_type);
229 Debug(net, 3, " Invite code: {}", _network_server_invite_code);
230 Debug(net, 3, "----------------------------------------");
231 } else {
232 Debug(net, 3, "Game Coordinator registered our server with invite code '{}'", _network_server_invite_code);
233 }
234
235 return true;
236}
237
239{
240 uint8_t servers = p.Recv_uint16();
241 Debug(net, 9, "Coordinator::Receive_GC_LISTING({})", servers);
242
243 /* End of list; we can now remove all expired items from the list. */
244 if (servers == 0) {
246 return true;
247 }
248
249 for (; servers > 0; servers--) {
250 std::string connection_string = p.Recv_string(NETWORK_HOSTNAME_PORT_LENGTH);
251
252 /* Now we know the connection string, we can add it to our list. */
253 NetworkGame *item = NetworkGameListAddItem(connection_string);
254
255 /* Clear any existing GRFConfig chain. */
257 /* Read the NetworkGameInfo from the packet. */
258 DeserializeNetworkGameInfo(p, item->info, &this->newgrf_lookup_table);
259 /* Check for compatibility with the client. */
261 /* Mark server as online. */
262 item->status = NGLS_ONLINE;
263 /* Mark the item as up-to-date. */
265 }
266
268 return true;
269}
270
272{
273 std::string token = p.Recv_string(NETWORK_TOKEN_LENGTH);
274 std::string invite_code = p.Recv_string(NETWORK_INVITE_CODE_LENGTH);
275 Debug(net, 9, "Coordinator::Receive_GC_CONNECTING({}, {})", token, invite_code);
276
277 /* Find the connecter based on the invite code. */
278 auto connecter_pre_it = this->connecter_pre.find(invite_code);
279 if (connecter_pre_it == this->connecter_pre.end()) {
280 this->CloseConnection();
281 return false;
282 }
283
284 /* Now store it based on the token. */
285 this->connecter[token] = {invite_code, connecter_pre_it->second};
286 this->connecter_pre.erase(connecter_pre_it);
287
288 return true;
289}
290
292{
293 std::string token = p.Recv_string(NETWORK_TOKEN_LENGTH);
294 Debug(net, 9, "Coordinator::Receive_GC_CONNECT_FAILED({})", token);
295 this->CloseToken(token);
296
297 return true;
298}
299
301{
302 std::string token = p.Recv_string(NETWORK_TOKEN_LENGTH);
303 uint8_t tracking_number = p.Recv_uint8();
304 std::string hostname = p.Recv_string(NETWORK_HOSTNAME_LENGTH);
305 uint16_t port = p.Recv_uint16();
306 Debug(net, 9, "Coordinator::Receive_GC_DIRECT_CONNECT({}, {}, {}, {})", token, tracking_number, hostname, port);
307
308 /* Ensure all other pending connection attempts are killed. */
309 if (this->game_connecter != nullptr) {
310 this->game_connecter->Kill();
311 this->game_connecter = nullptr;
312 }
313
314 this->game_connecter = TCPConnecter::Create<NetworkDirectConnecter>(hostname, port, std::move(token), tracking_number);
315 return true;
316}
317
319{
320 std::string token = p.Recv_string(NETWORK_TOKEN_LENGTH);
321 Debug(net, 9, "Coordinator::Receive_GC_STUN_REQUEST({})", token);
322
323 this->stun_handlers[token][AF_INET6] = ClientNetworkStunSocketHandler::Stun(token, AF_INET6);
324 this->stun_handlers[token][AF_INET] = ClientNetworkStunSocketHandler::Stun(token, AF_INET);
325 return true;
326}
327
329{
330 std::string token = p.Recv_string(NETWORK_TOKEN_LENGTH);
331 uint8_t tracking_number = p.Recv_uint8();
332 uint8_t family = p.Recv_uint8();
333 std::string host = p.Recv_string(NETWORK_HOSTNAME_PORT_LENGTH);
334 uint16_t port = p.Recv_uint16();
335
336 /* Check if we know this token. */
337 auto stun_it = this->stun_handlers.find(token);
338 if (stun_it == this->stun_handlers.end()) return true;
339 auto family_it = stun_it->second.find(family);
340 if (family_it == stun_it->second.end()) return true;
341
342 /* Ensure all other pending connection attempts are killed. */
343 if (this->game_connecter != nullptr) {
344 this->game_connecter->Kill();
345 this->game_connecter = nullptr;
346 }
347
348 /* We now mark the connection as closed, but we do not really close the
349 * socket yet. We do this when the NetworkReuseStunConnecter is connected.
350 * This prevents any NAT to already remove the route while we create the
351 * second connection on top of the first. */
352 family_it->second->CloseConnection(false);
353
354 /* Connect to our peer from the same local address as we use for the
355 * STUN server. This means that if there is any NAT in the local network,
356 * the public ip:port is still pointing to the local address, and as such
357 * a connection can be established. */
358 this->game_connecter = TCPConnecter::Create<NetworkReuseStunConnecter>(host, port, family_it->second->local_addr, std::move(token), tracking_number, family);
359 return true;
360}
361
363{
365
366 uint16_t newgrfs = p.Recv_uint16();
367 Debug(net, 9, "Coordinator::Receive_GC_NEWGRF_LOOKUP({}, {})", this->newgrf_lookup_table_cursor, newgrfs);
368 for (; newgrfs> 0; newgrfs--) {
369 uint32_t index = p.Recv_uint32();
371 }
372 return true;
373}
374
376{
377 std::string token = p.Recv_string(NETWORK_TOKEN_LENGTH);
378 uint8_t tracking_number = p.Recv_uint8();
379 std::string ticket = p.Recv_string(NETWORK_TOKEN_LENGTH);
380 std::string connection_string = p.Recv_string(NETWORK_HOSTNAME_PORT_LENGTH);
381 Debug(net, 9, "Coordinator::Receive_GC_TURN_CONNECT({}, {}, {}, {})", token, tracking_number, ticket, connection_string);
382
383 /* Ensure all other pending connection attempts are killed. */
384 if (this->game_connecter != nullptr) {
385 this->game_connecter->Kill();
386 this->game_connecter = nullptr;
387 }
388
389 this->turn_handlers[token] = ClientNetworkTurnSocketHandler::Turn(token, tracking_number, ticket, connection_string);
390
391 if (!_network_server) {
392 auto connecter_it = this->connecter.find(token);
393 if (connecter_it == this->connecter.end()) {
394 /* Make sure we are still interested in connecting to this server. */
395 this->ConnectFailure(token, 0);
396 return true;
397 }
398
399 switch (_settings_client.network.use_relay_service) {
400 case UseRelayService::Never:
401 this->ConnectFailure(token, 0);
402 break;
403
404 case UseRelayService::Ask:
405 ShowNetworkAskRelay(connecter_it->second.first, std::move(connection_string), std::move(token));
406 break;
407
408 case UseRelayService::Allow:
409 this->StartTurnConnection(token);
410 break;
411 }
412 } else {
413 this->StartTurnConnection(token);
414 }
415
416 return true;
417}
418
419void ClientNetworkCoordinatorSocketHandler::StartTurnConnection(std::string_view token)
420{
421 auto turn_it = this->turn_handlers.find(token);
422 if (turn_it == this->turn_handlers.end()) return;
423
424 turn_it->second->Connect();
425}
426
427void ClientNetworkCoordinatorSocketHandler::Connect()
428{
429 /* We are either already connected or are trying to connect. */
430 if (this->sock != INVALID_SOCKET || this->connecting) return;
431
432 this->Reopen();
433
434 this->connecting = true;
435 this->last_activity = std::chrono::steady_clock::now();
436
438}
439
456
461{
463 this->next_update = {};
464
466
467 this->Connect();
468
469 auto p = std::make_unique<Packet>(this, PACKET_COORDINATOR_SERVER_REGISTER);
470 p->Send_uint8(NETWORK_COORDINATOR_VERSION);
471 p->Send_uint8(_settings_client.network.server_game_type);
472 p->Send_uint16(_settings_client.network.server_port);
473 if (_settings_client.network.server_invite_code.empty() || _settings_client.network.server_invite_code_secret.empty()) {
474 p->Send_string("");
475 p->Send_string("");
476 } else {
477 p->Send_string(_settings_client.network.server_invite_code);
478 p->Send_string(_settings_client.network.server_invite_code_secret);
479 }
480
481 Debug(net, 9, "Coordinator::SendRegister({}, {}, {})", _settings_client.network.server_game_type, _settings_client.network.server_port, _settings_client.network.server_invite_code);
482 this->SendPacket(std::move(p));
483}
484
489{
490 Debug(net, 6, "Sending server update to Game Coordinator");
491
492 auto p = std::make_unique<Packet>(this, PACKET_COORDINATOR_SERVER_UPDATE, TCP_MTU);
493 p->Send_uint8(NETWORK_COORDINATOR_VERSION);
494 SerializeNetworkGameInfo(*p, GetCurrentNetworkServerGameInfo(), this->next_update.time_since_epoch() != std::chrono::nanoseconds::zero());
495
496 Debug(net, 9, "Coordinator::SendServerUpdate()");
497 this->SendPacket(std::move(p));
498
499 this->next_update = std::chrono::steady_clock::now() + NETWORK_COORDINATOR_DELAY_BETWEEN_UPDATES;
500}
501
506{
507 this->Connect();
508
510
511 auto p = std::make_unique<Packet>(this, PACKET_COORDINATOR_CLIENT_LISTING);
512 p->Send_uint8(NETWORK_COORDINATOR_VERSION);
513 p->Send_uint8(NETWORK_GAME_INFO_VERSION);
514 p->Send_string(_openttd_revision);
515 p->Send_uint32(this->newgrf_lookup_table_cursor);
516
517 Debug(net, 9, "Coordinator::SendGetListing({}, {})", _openttd_revision, this->newgrf_lookup_table_cursor);
518 this->SendPacket(std::move(p));
519}
520
527{
528 assert(invite_code.starts_with("+"));
529
530 if (this->connecter_pre.find(invite_code) != this->connecter_pre.end()) {
531 /* If someone is hammering the refresh key, one can sent out two
532 * requests for the same invite code. There isn't really a great way
533 * of handling this, so just ignore this request. */
534 connecter->SetFailure();
535 return;
536 }
537
538 /* Initially we store based on invite code; on first reply we know the
539 * token, and will start using that key instead. */
540 this->connecter_pre[std::string(invite_code)] = connecter;
541
542 this->Connect();
543
544 auto p = std::make_unique<Packet>(this, PACKET_COORDINATOR_CLIENT_CONNECT);
545 p->Send_uint8(NETWORK_COORDINATOR_VERSION);
546 p->Send_string(invite_code);
547
548 Debug(net, 9, "Coordinator::SendConnectToClient({})", invite_code);
549 this->SendPacket(std::move(p));
550}
551
557void ClientNetworkCoordinatorSocketHandler::ConnectFailure(std::string_view token, uint8_t tracking_number)
558{
559 /* Connecter will destroy itself. */
560 this->game_connecter = nullptr;
561
562 auto p = std::make_unique<Packet>(this, PACKET_COORDINATOR_SERCLI_CONNECT_FAILED);
563 p->Send_uint8(NETWORK_COORDINATOR_VERSION);
564 p->Send_string(token);
565 p->Send_uint8(tracking_number);
566
567 Debug(net, 9, "Coordinator::SendConnectFailure({}, {})", token, tracking_number);
568 this->SendPacket(std::move(p));
569
570 /* We do not close the associated connecter here yet, as the
571 * Game Coordinator might have other methods of connecting available. */
572}
573
582{
583 assert(sock != INVALID_SOCKET);
584
585 /* Connecter will destroy itself. */
586 this->game_connecter = nullptr;
587
588 if (_network_server) {
589 if (!ServerNetworkGameSocketHandler::ValidateClient(sock, address)) return;
590 Debug(net, 3, "[{}] Client connected from {} on frame {}", ServerNetworkGameSocketHandler::GetName(), address.GetHostname(), _frame_counter);
592 } else {
593 /* The client informs the Game Coordinator about the success. The server
594 * doesn't have to, as it is implied by the client telling. */
595 auto p = std::make_unique<Packet>(this, PACKET_COORDINATOR_CLIENT_CONNECTED);
596 p->Send_uint8(NETWORK_COORDINATOR_VERSION);
597 p->Send_string(token);
598 Debug(net, 9, "Coordinator::SendConnectSuccess({})", token);
599 this->SendPacket(std::move(p));
600
601 /* Find the connecter; it can happen it no longer exist, in cases where
602 * we aborted the connect but the Game Coordinator was already in the
603 * processes of connecting us. */
604 auto connecter_it = this->connecter.find(token);
605 if (connecter_it != this->connecter.end()) {
606 connecter_it->second.second->SetConnected(sock);
607 this->connecter.erase(connecter_it);
608 }
609 }
610
611 /* Close all remaining connections. */
612 this->CloseToken(token);
613}
614
622void ClientNetworkCoordinatorSocketHandler::StunResult(std::string_view token, uint8_t family, bool result)
623{
624 auto p = std::make_unique<Packet>(this, PACKET_COORDINATOR_SERCLI_STUN_RESULT);
625 p->Send_uint8(NETWORK_COORDINATOR_VERSION);
626 p->Send_string(token);
627 p->Send_uint8(family);
628 p->Send_bool(result);
629 Debug(net, 9, "Coordinator::SendStunResult({}, {}, {})", token, family, result);
630 this->SendPacket(std::move(p));
631}
632
638void ClientNetworkCoordinatorSocketHandler::CloseStunHandler(std::string_view token, uint8_t family)
639{
640 auto stun_it = this->stun_handlers.find(token);
641 if (stun_it == this->stun_handlers.end()) return;
642
643 if (family == AF_UNSPEC) {
644 for (auto &[family, stun_handler] : stun_it->second) {
645 stun_handler->CloseConnection();
646 stun_handler->CloseSocket();
647 }
648
649 this->stun_handlers.erase(stun_it);
650 } else {
651 auto family_it = stun_it->second.find(family);
652 if (family_it == stun_it->second.end()) return;
653
654 family_it->second->CloseConnection();
655 family_it->second->CloseSocket();
656
657 stun_it->second.erase(family_it);
658 }
659}
660
666{
668
669 auto turn_it = this->turn_handlers.find(token);
670 if (turn_it == this->turn_handlers.end()) return;
671
672 turn_it->second->CloseConnection();
673 turn_it->second->CloseSocket();
674
675 /* We don't remove turn_handler here, as we can be called from within that
676 * turn_handler instance, so our object cannot be freed yet. Instead, we
677 * check later if the connection is closed, and free the object then. */
678}
679
685{
686 /* Close all remaining STUN / TURN connections. */
687 this->CloseStunHandler(token);
688 this->CloseTurnHandler(token);
689
690 /* Close the caller of the connection attempt. */
691 auto connecter_it = this->connecter.find(token);
692 if (connecter_it != this->connecter.end()) {
693 connecter_it->second.second->SetFailure();
694 this->connecter.erase(connecter_it);
695 }
696}
697
702{
703 /* Ensure all other pending connection attempts are also killed. */
704 if (this->game_connecter != nullptr) {
705 this->game_connecter->Kill();
706 this->game_connecter = nullptr;
707 }
708
709 /* Mark any pending connecters as failed. */
710 for (auto &[token, it] : this->connecter) {
711 this->CloseStunHandler(token);
712 this->CloseTurnHandler(token);
713 it.second->SetFailure();
714
715 /* Inform the Game Coordinator he can stop trying to connect us to the server. */
716 this->ConnectFailure(token, 0);
717 }
718 this->stun_handlers.clear();
719 this->turn_handlers.clear();
720 this->connecter.clear();
721
722 /* Also close any pending invite-code requests. */
723 for (auto &[invite_code, it] : this->connecter_pre) {
724 it->SetFailure();
725 }
726 this->connecter_pre.clear();
727}
728
734{
735 /* Private games are not listed via the Game Coordinator. */
736 if (_network_server && _settings_client.network.server_game_type == SERVER_GAME_TYPE_LOCAL) {
737 if (this->sock != INVALID_SOCKET) {
738 this->CloseConnection();
739 }
740 return;
741 }
742
743 static int last_attempt_backoff = 1;
744 static bool first_reconnect = true;
745
746 if (this->sock == INVALID_SOCKET) {
747 static std::chrono::steady_clock::time_point last_attempt = {};
748
749 /* Don't auto-reconnect when we are not a server. */
750 if (!_network_server) return;
751 /* Don't reconnect if we are connecting. */
752 if (this->connecting) return;
753 /* Throttle how often we try to reconnect. */
754 if (std::chrono::steady_clock::now() < last_attempt + std::chrono::seconds(1) * last_attempt_backoff) return;
755
756 last_attempt = std::chrono::steady_clock::now();
757 /* Delay reconnecting with up to 32 seconds. */
758 if (last_attempt_backoff < 32) {
759 last_attempt_backoff *= 2;
760 }
761
762 /* Do not reconnect on the first attempt, but only initialize the
763 * last_attempt variables. Otherwise after an outage all servers
764 * reconnect at the same time, potentially overwhelming the
765 * Game Coordinator. */
766 if (first_reconnect) {
767 first_reconnect = false;
768 return;
769 }
770
771 Debug(net, 1, "Connection with Game Coordinator lost; reconnecting...");
772 this->Register();
773 return;
774 }
775
776 last_attempt_backoff = 1;
777 first_reconnect = true;
778
779 if (_network_server && _network_server_connection_type != CONNECTION_TYPE_UNKNOWN && std::chrono::steady_clock::now() > this->next_update) {
780 this->SendServerUpdate();
781 }
782
783 if (!_network_server && std::chrono::steady_clock::now() > this->last_activity + IDLE_TIMEOUT) {
784 this->CloseConnection();
785 return;
786 }
787
788 if (this->CanSendReceive()) {
789 if (this->ReceivePackets()) {
790 this->last_activity = std::chrono::steady_clock::now();
791 }
792 }
793
794 this->SendPackets();
795
796 for (const auto &[token, families] : this->stun_handlers) {
797 for (const auto &[family, stun_handler] : families) {
798 stun_handler->SendReceive();
799 }
800 }
801
802 /* Check for handlers that are not connecting nor connected. Destroy those objects. */
803 for (auto turn_it = this->turn_handlers.begin(); turn_it != this->turn_handlers.end(); /* nothing */) {
804 if (turn_it->second->connect_started && turn_it->second->connecter == nullptr && !turn_it->second->IsConnected()) {
805 turn_it = this->turn_handlers.erase(turn_it);
806 } else {
807 turn_it++;
808 }
809 }
810
811 for (const auto &[token, turn_handler] : this->turn_handlers) {
812 turn_handler->SendReceive();
813 }
814}
Game Coordinator communication.
bool Receive_GC_NEWGRF_LOOKUP(Packet &p) override
Game Coordinator informs the client of updates for the NewGRFs lookup table as used by the NewGRF des...
GameInfoNewGRFLookupTable newgrf_lookup_table
Table to look up NewGRFs in the GC_LISTING packets.
bool Receive_GC_STUN_CONNECT(Packet &p) override
Game Coordinator informs the client/server of its STUN peer (the host:ip of the other side).
bool Receive_GC_STUN_REQUEST(Packet &p) override
Game Coordinator requests the client/server to do a STUN request to the STUN server.
void CloseTurnHandler(std::string_view token)
Close the TURN handler.
std::map< std::string, std::unique_ptr< ClientNetworkTurnSocketHandler >, std::less<> > turn_handlers
Pending TURN handler (if any), stored by token.
bool Receive_GC_REGISTER_ACK(Packet &p) override
Game Coordinator acknowledges the registration.
void Register()
Register our server to receive our invite code.
void ConnectToServer(std::string_view invite_code, TCPServerConnecter *connecter)
Join a server based on an invite code.
void CloseStunHandler(std::string_view token, uint8_t family=AF_UNSPEC)
Close the STUN handler.
std::map< std::string, std::pair< std::string, TCPServerConnecter * >, std::less<> > connecter
Based on tokens, the current (invite-code, connecter) that are pending.
uint32_t newgrf_lookup_table_cursor
Last received cursor for the GameInfoNewGRFLookupTable updates.
void SendReceive()
Check whether we received/can send some data from/to the Game Coordinator server and when that's the ...
static constexpr std::chrono::seconds IDLE_TIMEOUT
The idle timeout; when to close the connection because it's idle.
std::chrono::steady_clock::time_point next_update
When to send the next update (if server and public).
bool connecting
Are we connecting to the Game Coordinator?
void CloseAllConnections()
Close all pending connection tokens.
void SendServerUpdate()
Send an update of our server status to the Game Coordinator.
std::map< std::string, TCPServerConnecter *, std::less<> > connecter_pre
Based on invite codes, the current connecters that are pending.
bool Receive_GC_LISTING(Packet &p) override
Game Coordinator replies with a list of all public servers.
void ConnectFailure(std::string_view token, uint8_t tracking_number)
Callback from a Connecter to let the Game Coordinator know the connection failed.
void CloseToken(std::string_view token)
Close everything related to this connection token.
std::chrono::steady_clock::time_point last_activity
The last time there was network activity.
void StunResult(std::string_view token, uint8_t family, bool result)
Callback from the STUN connecter to inform the Game Coordinator about the result of the STUN.
bool Receive_GC_DIRECT_CONNECT(Packet &p) override
Game Coordinator requests that the Client makes a direct connection to the indicated peer,...
bool Receive_GC_CONNECTING(Packet &p) override
Game Coordinator informs the Client under what token it will start the attempt to connect the Server ...
bool Receive_GC_TURN_CONNECT(Packet &p) override
Game Coordinator requests that we make a connection to the indicated peer, which is a TURN server.
NetworkRecvStatus CloseConnection(bool error=true) override
This will put this socket handler in a close state.
void ConnectSuccess(std::string_view token, SOCKET sock, NetworkAddress &address)
Callback from a Connecter to let the Game Coordinator know the connection to the game server is estab...
bool Receive_GC_CONNECT_FAILED(Packet &p) override
Game Coordinator informs the Client that it failed to find a way to connect the Client to the Server.
bool Receive_GC_ERROR(Packet &p) override
Game Coordinator indicates there was an error.
std::map< std::string, std::map< int, std::unique_ptr< ClientNetworkStunSocketHandler > >, std::less<> > stun_handlers
All pending STUN handlers, stored by token:family.
std::shared_ptr< TCPConnecter > game_connecter
Pending connecter to the game server.
void GetListing()
Request a listing of all public servers.
static std::unique_ptr< ClientNetworkStunSocketHandler > Stun(std::string_view token, uint8_t family)
Send a STUN packet to the STUN server.
static std::unique_ptr< ClientNetworkTurnSocketHandler > Turn(std::string_view token, uint8_t tracking_number, std::string_view ticket, std::string_view connection_string)
Prepare a TURN connection.
Wrapper for (un)resolved network addresses; there's no reason to transform a numeric IP to a string a...
Definition address.h:28
static NetworkAddress GetPeerAddress(SOCKET sock)
Get the peer address of a socket as NetworkAddress.
Definition address.cpp:397
const std::string & GetHostname()
Get the hostname; in case it wasn't given the IPv4 dotted representation is given.
Definition address.cpp:24
void OnConnect(SOCKET s) override
Callback when the connection succeeded.
void OnFailure() override
Callback for when the connection attempt failed.
NetworkCoordinatorConnecter(std::string_view connection_string)
Initiate the connecting.
bool ReceivePackets()
Receive a packet at TCP level.
uint8_t tracking_number
Tracking number of this connection.
void OnFailure() override
Callback for when the connection attempt failed.
NetworkDirectConnecter(std::string_view hostname, uint16_t port, std::string &&token, uint8_t tracking_number)
Try to establish a direct (hostname:port based) connection.
void OnConnect(SOCKET s) override
Callback when the connection succeeded.
std::string token
Token of this connection.
void OnConnect(SOCKET s) override
Callback when the connection succeeded.
uint8_t tracking_number
Tracking number of this connection.
NetworkReuseStunConnecter(std::string_view hostname, uint16_t port, const NetworkAddress &bind_address, std::string &&token, uint8_t tracking_number, uint8_t family)
Try to establish a STUN-based connection.
void OnFailure() override
Callback for when the connection attempt failed.
uint8_t family
Family of this connection.
std::string token
Token of this connection.
void Reopen()
Reopen the socket so we can send/receive stuff again.
Definition core.h:77
virtual NetworkRecvStatus CloseConnection(bool error=true)
This will put this socket handler in a close state.
Definition tcp.cpp:39
SOCKET sock
The socket currently connected to.
Definition tcp.h:36
virtual void SendPacket(std::unique_ptr< Packet > &&packet)
This function puts the packet in the send-queue and it is send as soon as possible.
Definition tcp.cpp:56
SendPacketsState SendPackets(bool closing_down=false)
Sends all the buffered packets out for this client.
Definition tcp.cpp:74
void CloseSocket()
Close the actual socket of the connection.
Definition tcp.cpp:27
bool CanSendReceive()
Check whether this socket can send or receive something.
Definition tcp.cpp:192
static std::string_view GetName()
Get the name used by the listener.
static void AcceptConnection(SOCKET s, const NetworkAddress &address)
Handle the accepting of a connection to the server.
Definition network.cpp:566
NetworkAddress bind_address
Address we're binding to, if any.
Definition tcp.h:102
std::string connection_string
Current address we are connecting to (before resolving).
Definition tcp.h:101
static std::shared_ptr< TCPConnecter > Create(Args &&... args)
Create the connecter, and initiate connecting by putting it in the collection of TCP connections to m...
Definition tcp.h:147
std::string_view NetworkCoordinatorConnectionString()
Get the connection string for the game coordinator from the environment variable OTTD_COORDINATOR_CS,...
Definition config.cpp:21
static const uint NETWORK_INVITE_CODE_SECRET_LENGTH
The maximum length of the invite code secret, in bytes including '\0'.
Definition config.h:68
static const size_t TCP_MTU
Number of bytes we can pack in a single TCP packet.
Definition config.h:43
static const uint16_t NETWORK_COORDINATOR_SERVER_PORT
The default port of the Game Coordinator server (TCP).
Definition config.h:19
static const uint8_t NETWORK_COORDINATOR_VERSION
What version of game-coordinator-protocol do we use?
Definition config.h:48
static const uint NETWORK_INVITE_CODE_LENGTH
The maximum length of the invite code, in bytes including '\0'.
Definition config.h:67
static const uint NETWORK_HOSTNAME_PORT_LENGTH
The maximum length of the host name + port, in bytes including '\0'. The extra six is ":" + port numb...
Definition config.h:53
static const uint NETWORK_HOSTNAME_LENGTH
The maximum length of the host name, in bytes including '\0'.
Definition config.h:52
static const uint NETWORK_TOKEN_LENGTH
The maximum length of a token, in bytes including '\0'.
Definition config.h:69
static const uint NETWORK_ERROR_DETAIL_LENGTH
The maximum length of the error detail, in bytes including '\0'.
Definition config.h:66
static const uint8_t NETWORK_GAME_INFO_VERSION
What version of game-info do we use?
Definition config.h:47
NetworkRecvStatus
Status of a network client; reasons why a client has quit.
Definition core.h:21
@ NETWORK_RECV_STATUS_OKAY
Everything is okay.
Definition core.h:22
Functions related to debugging.
#define Debug(category, level, format_string,...)
Output a line of debugging information.
Definition debug.h:37
Functions related to errors.
@ WL_ERROR
Errors (eg. saving/loading failed).
Definition error.h:26
void ShowErrorMessage(EncodedString &&summary_msg, int x, int y, CommandCost &cc)
Display an error message in a window.
uint32_t _frame_counter
The current frame.
Definition network.cpp:79
bool _network_dedicated
are we a dedicated server?
Definition network.cpp:69
bool _network_server
network-server is active
Definition network.cpp:67
Basic functions/variables used all over the place.
ConnectionType _network_server_connection_type
What type of connection the Game Coordinator detected we are on.
ClientNetworkCoordinatorSocketHandler _network_coordinator_client
The connection to the Game Coordinator.
static const auto NETWORK_COORDINATOR_DELAY_BETWEEN_UPDATES
How many time between updates the server sends to the Game Coordinator.
std::string _network_server_invite_code
Our invite code as indicated by the Game Coordinator.
Part of the network protocol handling Game Coordinator requests.
void SerializeNetworkGameInfo(Packet &p, const NetworkServerGameInfo &info, bool send_newgrf_names)
Serializes the NetworkGameInfo struct to the packet.
void CheckGameCompatibility(NetworkGameInfo &ngi)
Check if an game entry is compatible with our client.
const NetworkServerGameInfo & GetCurrentNetworkServerGameInfo()
Get the NetworkServerGameInfo structure with the latest information of the server.
void DeserializeGRFIdentifierWithName(Packet &p, NamedGRFIdentifier &grf)
Deserializes the NamedGRFIdentifier (GRF ID, MD5 checksum and name) from the packet.
void DeserializeNetworkGameInfo(Packet &p, NetworkGameInfo &info, const GameInfoNewGRFLookupTable *newgrf_lookup_table)
Deserializes the NetworkGameInfo struct from the packet.
NetworkGame * NetworkGameListAddItem(std::string_view connection_string)
Add a new item to the linked gamelist.
void NetworkGameListRemoveExpired()
Remove all servers that have not recently been updated.
int _network_game_list_version
Current version of all items in the list.
Handling of the list of games.
@ NGLS_ONLINE
Server is online.
@ NGLS_OFFLINE
Server is offline (or cannot be queried).
void UpdateNetworkGameWindow()
Update the network new window because a new server is found on the network.
void ShowNetworkAskRelay(std::string_view server_connection_string, std::string &&relay_connection_string, std::string &&token)
Show a modal confirmation window with "no" / "yes, once" / "yes, always" buttons.
GUIs related to networking.
@ NRWCD_HANDLED
Relay request is handled, either by user or by timeout.
Definition network_gui.h:43
Variables and function used internally.
Server part of the network protocol.
Part of the network protocol handling STUN requests.
void ClearGRFConfigList(GRFConfigList &config)
Clear a GRF Config list, freeing all nodes.
Declaration of OTTD revision dependent variables.
A number of safeguards to prevent using unsafe methods.
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:60
Types related to global configuration settings.
Definition of base types and functions in a cross-platform compatible way.
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
Definition strings.cpp:90
Functions related to OTTD's strings.
Structure with information shown in the game list (GUI).
int version
Used to see which servers are no longer available on the Game Coordinator and can be removed.
NetworkGameInfo info
The game information of this server.
NetworkGameStatus status
Stats of the server.
GRFConfigList grfconfig
List of NewGRF files used.
uint16_t Recv_uint16()
Read a 16 bits integer from the packet.
Definition packet.cpp:330
uint32_t Recv_uint32()
Read a 32 bits integer from the packet.
Definition packet.cpp:345
std::string Recv_string(size_t length, StringValidationSettings settings=StringValidationSetting::ReplaceWithQuestionMark)
Reads characters (bytes) from the packet until it finds a '\0', or reaches a maximum of length charac...
Definition packet.cpp:423
uint8_t Recv_uint8()
Read a 8 bits integer from the packet.
Definition packet.cpp:316
@ PACKET_COORDINATOR_SERCLI_CONNECT_FAILED
Client/server tells the Game Coordinator the current connection attempt failed.
@ PACKET_COORDINATOR_SERCLI_STUN_RESULT
Client/server informs the Game Coordinator of the result of the STUN request.
@ PACKET_COORDINATOR_CLIENT_LISTING
Client is requesting a listing of all public servers.
@ PACKET_COORDINATOR_SERVER_REGISTER
Server registration.
@ PACKET_COORDINATOR_CLIENT_CONNECT
Client wants to connect to a server based on an invite code.
@ PACKET_COORDINATOR_CLIENT_CONNECTED
Client informs the Game Coordinator the connection with the server is established.
@ PACKET_COORDINATOR_SERVER_UPDATE
Server sends an set intervals an update of the server.
NetworkCoordinatorErrorType
The type of error from the Game Coordinator.
@ NETWORK_COORDINATOR_ERROR_UNKNOWN
There was an unknown error.
@ NETWORK_COORDINATOR_ERROR_REGISTRATION_FAILED
Your request for registration failed.
@ NETWORK_COORDINATOR_ERROR_INVALID_INVITE_CODE
The invite code given is invalid.
@ NETWORK_COORDINATOR_ERROR_REUSE_OF_INVITE_CODE
The invite code is used by another (newer) server.
ConnectionType
The type of connection the Game Coordinator can detect we have.
@ CONNECTION_TYPE_ISOLATED
The Game Coordinator failed to find a way to connect to your server. Nobody will be able to join.
@ CONNECTION_TYPE_DIRECT
The Game Coordinator can directly connect to your server.
@ CONNECTION_TYPE_STUN
The Game Coordinator can connect to your server via a STUN request.
@ CONNECTION_TYPE_UNKNOWN
The Game Coordinator hasn't informed us yet what type of connection we have.
@ CONNECTION_TYPE_TURN
The Game Coordinator needs you to connect to a relay.
void CloseWindowByClass(WindowClass cls, int data)
Close all windows of a given class.
Definition window.cpp:1211
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting).
Definition window.cpp:3188
Window functions not directly related to making/drawing windows.
Types related to windows.
@ WC_NETWORK_ASK_RELAY
Network ask relay window; Window numbers:
@ WC_CLIENT_LIST
Client list; Window numbers: