OpenTTD
Data Structures | Functions | Variables
network_udp.cpp File Reference

This file handles the UDP related communication. More...

#include "../stdafx.h"
#include "../date_func.h"
#include "../map_func.h"
#include "../debug.h"
#include "network_gamelist.h"
#include "network_internal.h"
#include "network_udp.h"
#include "network.h"
#include "../core/endian_func.hpp"
#include "../company_base.h"
#include "../thread/thread.h"
#include "../rev.h"
#include "../newgrf_text.h"
#include "../strings_func.h"
#include "table/strings.h"
#include "core/udp.h"
#include "../safeguards.h"

Go to the source code of this file.

Data Structures

struct  NetworkUDPQueryServerInfo
 Simpler wrapper struct for NetworkUDPQueryServerThread. More...
class  MasterNetworkUDPSocketHandler
 *** Communication with the masterserver ***/ More...
class  ServerNetworkUDPSocketHandler
 *** Communication with clients (we are server) ***/ More...
class  ClientNetworkUDPSocketHandler
 *** Communication with servers (we are client) ***/ More...

Functions

static void NetworkUDPQueryServer (NetworkAddress *address, bool needs_mutex, bool manually)
 Helper function doing the actual work for querying the server.
static void NetworkUDPQueryServerThread (void *pntr)
 Threaded part for resolving the IP of a server and querying it.
void NetworkUDPQueryServer (NetworkAddress address, bool manually)
 Query a specific server.
static void NetworkUDPBroadCast (NetworkUDPSocketHandler *socket)
 Broadcast to all ips.
void NetworkUDPQueryMasterServer ()
 Request the the server-list from the master server.
void NetworkUDPSearchGame ()
 Find all servers.
static void NetworkUDPRemoveAdvertiseThread (void *pntr)
 Thread entry point for de-advertising.
void NetworkUDPRemoveAdvertise (bool blocking)
 Remove our advertise from the master-server.
static void NetworkUDPAdvertiseThread (void *pntr)
 Thread entry point for advertising.
void NetworkUDPAdvertise ()
 Register us to the master server This function checks if it needs to send an advertise.
void NetworkUDPInitialize ()
 Initialize the whole UDP bit.
void NetworkUDPClose ()
 Close all UDP related stuff.
void NetworkBackgroundUDPLoop ()
 Receive the UDP packets.

Variables

static ThreadMutex_network_udp_mutex = ThreadMutex::New()
 Mutex for all out threaded udp resolution and such.
static uint64 _session_key = 0
 Session key to register ourselves to the master server.
static const uint32 ADVERTISE_NORMAL_INTERVAL = 15 * 60 * 1000
 interval between advertising in ms (15 minutes)
static const uint32 ADVERTISE_RETRY_INTERVAL = 10 * 1000
 re-advertise when no response after this many ms (10 seconds)
static const uint32 ADVERTISE_RETRY_TIMES = 3
 give up re-advertising after this much failed retries
NetworkUDPSocketHandler_udp_client_socket = NULL
 udp client socket
NetworkUDPSocketHandler_udp_server_socket = NULL
 udp server socket
NetworkUDPSocketHandler_udp_master_socket = NULL
 udp master socket

Detailed Description

This file handles the UDP related communication.

This is the GameServer <-> MasterServer and GameServer <-> GameClient communication before the game is being joined.

Definition in file network_udp.cpp.

Function Documentation

void NetworkBackgroundUDPLoop ( )
void NetworkUDPAdvertise ( )

Register us to the master server This function checks if it needs to send an advertise.

< The time of the last advertisement (used to check for wrapping of time)

< The next time we should perform a normal advertisement.

< The next time we should perform a retry of an advertisement.

Definition at line 617 of file network_udp.cpp.

References _network_advertise_retries, _network_need_advertise, _network_server, _network_udp_server, _networking, _realtime_tick, _settings_client, ADVERTISE_NORMAL_INTERVAL, ADVERTISE_RETRY_INTERVAL, ADVERTISE_RETRY_TIMES, ClientSettings::network, NetworkUDPAdvertiseThread(), ThreadObject::New(), and NetworkSettings::server_advertise.

Referenced by NetworkServer_Tick().

static void NetworkUDPAdvertiseThread ( void *  pntr)
static
void NetworkUDPClose ( )
void NetworkUDPInitialize ( )
static void NetworkUDPQueryServer ( NetworkAddress address,
bool  needs_mutex,
bool  manually 
)
static
void NetworkUDPQueryServer ( NetworkAddress  address,
bool  manually 
)

Query a specific server.

Parameters
addressThe address of the server.
manuallyWhether the address was entered manually.

Definition at line 109 of file network_udp.cpp.

References NetworkAddress::IsResolved(), NetworkUDPQueryServerThread(), and ThreadObject::New().

static void NetworkUDPQueryServerThread ( void *  pntr)
static

Threaded part for resolving the IP of a server and querying it.

Parameters
pntrthe NetworkUDPQueryServerInfo.

Definition at line 96 of file network_udp.cpp.

References NetworkUDPQueryServerInfo::manually, and NetworkUDPQueryServer().

Referenced by NetworkUDPQueryServer().

void NetworkUDPRemoveAdvertise ( bool  blocking)

Remove our advertise from the master-server.

Parameters
blockingwhether to wait until the removal has finished.

Definition at line 563 of file network_udp.cpp.

References _network_server, _network_udp_server, _networking, NetworkUDPRemoveAdvertiseThread(), and ThreadObject::New().

Referenced by NetworkDisconnect(), and MasterNetworkUDPSocketHandler::Receive_MASTER_ACK_REGISTER().

static void NetworkUDPRemoveAdvertiseThread ( void *  pntr)
static

Variable Documentation

ThreadMutex* _network_udp_mutex = ThreadMutex::New()
static

Mutex for all out threaded udp resolution and such.

Definition at line 40 of file network_udp.cpp.