OpenTTD
Public Member Functions | Protected Member Functions | Protected Attributes
NetworkUDPSocketHandler Class Reference

Base socket handler for all UDP sockets. More...

#include <udp.h>

Inheritance diagram for NetworkUDPSocketHandler:
NetworkSocketHandler ClientNetworkUDPSocketHandler MasterNetworkUDPSocketHandler ServerNetworkUDPSocketHandler

Public Member Functions

 NetworkUDPSocketHandler (NetworkAddressList *bind=NULL)
 Create an UDP socket but don't listen yet.
virtual ~NetworkUDPSocketHandler ()
 On destructing of this class, the socket needs to be closed.
bool Listen ()
 Start listening on the given host and port.
void Close ()
 Close the given UDP socket.
void SendPacket (Packet *p, NetworkAddress *recv, bool all=false, bool broadcast=false)
 Send a packet over UDP.
void ReceivePackets ()
 Receive a packet at UDP level.
void SendNetworkGameInfo (Packet *p, const NetworkGameInfo *info)
 Serializes the NetworkGameInfo struct to the packet.
void ReceiveNetworkGameInfo (Packet *p, NetworkGameInfo *info)
 Deserializes the NetworkGameInfo struct from the packet.
- Public Member Functions inherited from NetworkSocketHandler
 NetworkSocketHandler ()
 Create a new unbound socket.
virtual ~NetworkSocketHandler ()
 Close the socket when destructing the socket handler.
bool HasClientQuit () const
 Whether the current client connected to the socket has quit.
void Reopen ()
 Reopen the socket so we can send/receive stuff again.
void SendGRFIdentifier (Packet *p, const GRFIdentifier *grf)
 Serializes the GRFIdentifier (GRF ID and MD5 checksum) to the packet.
void ReceiveGRFIdentifier (Packet *p, GRFIdentifier *grf)
 Deserializes the GRFIdentifier (GRF ID and MD5 checksum) from the packet.
void SendCompanyInformation (Packet *p, const struct Company *c, const struct NetworkCompanyStats *stats, uint max_len=NETWORK_COMPANY_NAME_LENGTH)
 Package some generic company information into a packet.

Protected Member Functions

NetworkRecvStatus CloseConnection (bool error=true)
 Close the current connection; for TCP this will be mostly equivalent to Close(), but for UDP it just means the packet has to be dropped.
void ReceiveInvalidPacket (PacketUDPType, NetworkAddress *client_addr)
 Helper for logging receiving invalid packets.
virtual void Receive_CLIENT_FIND_SERVER (Packet *p, NetworkAddress *client_addr)
 Queries to the server for information about the game.
virtual void Receive_SERVER_RESPONSE (Packet *p, NetworkAddress *client_addr)
 Return of server information to the client.
virtual void Receive_CLIENT_DETAIL_INFO (Packet *p, NetworkAddress *client_addr)
 Query for detailed information about companies.
virtual void Receive_SERVER_DETAIL_INFO (Packet *p, NetworkAddress *client_addr)
 Reply with detailed company information.
virtual void Receive_SERVER_REGISTER (Packet *p, NetworkAddress *client_addr)
 Registers the server to the master server.
virtual void Receive_MASTER_ACK_REGISTER (Packet *p, NetworkAddress *client_addr)
 The master server acknowledges the registration.
virtual void Receive_CLIENT_GET_LIST (Packet *p, NetworkAddress *client_addr)
 The client requests a list of servers.
virtual void Receive_MASTER_RESPONSE_LIST (Packet *p, NetworkAddress *client_addr)
 The server sends a list of servers.
virtual void Receive_SERVER_UNREGISTER (Packet *p, NetworkAddress *client_addr)
 A server unregisters itself at the master server.
virtual void Receive_CLIENT_GET_NEWGRFS (Packet *p, NetworkAddress *client_addr)
 The client requests information about some NewGRFs.
virtual void Receive_SERVER_NEWGRFS (Packet *p, NetworkAddress *client_addr)
 The server returns information about some NewGRFs.
virtual void Receive_MASTER_SESSION_KEY (Packet *p, NetworkAddress *client_addr)
 The master server sends us a session key.
void HandleUDPPacket (Packet *p, NetworkAddress *client_addr)
 Handle an incoming packets by sending it to the correct function.
virtual void HandleIncomingNetworkGameInfoGRFConfig (GRFConfig *config)
 Function that is called for every GRFConfig that is read when receiving a NetworkGameInfo.

Protected Attributes

NetworkAddressList bind
 The address to bind to.
SocketList sockets
 The opened sockets.

Detailed Description

Base socket handler for all UDP sockets.

Definition at line 50 of file udp.h.

Constructor & Destructor Documentation

NetworkUDPSocketHandler::NetworkUDPSocketHandler ( NetworkAddressList bind = NULL)

Create an UDP socket but don't listen yet.

Parameters
bindthe addresses to bind to.

Definition at line 27 of file udp.cpp.

References SmallVector< T, S >::Append(), SmallVector< T, S >::Begin(), and SmallVector< T, S >::End().

Member Function Documentation

NetworkRecvStatus NetworkUDPSocketHandler::CloseConnection ( bool  error = true)
protectedvirtual

Close the current connection; for TCP this will be mostly equivalent to Close(), but for UDP it just means the packet has to be dropped.

Parameters
errorWhether we quit under an error condition or not.
Returns
new status of the connection.

Reimplemented from NetworkSocketHandler.

Definition at line 70 of file udp.cpp.

References NETWORK_RECV_STATUS_OKAY.

virtual void NetworkUDPSocketHandler::HandleIncomingNetworkGameInfoGRFConfig ( GRFConfig config)
inlineprotectedvirtual

Function that is called for every GRFConfig that is read when receiving a NetworkGameInfo.

Only grfid and md5sum are set, the rest is zero. This function must set all appropriate fields. This GRF is later appended to the grfconfig list of the NetworkGameInfo.

Parameters
configthe GRF to handle

Reimplemented in ClientNetworkUDPSocketHandler.

Definition at line 232 of file udp.h.

Referenced by ReceiveNetworkGameInfo().

void NetworkUDPSocketHandler::HandleUDPPacket ( Packet p,
NetworkAddress client_addr 
)
protected
bool NetworkUDPSocketHandler::Listen ( )

Start listening on the given host and port.

Returns
true if at least one port is listening

Definition at line 47 of file udp.cpp.

References SmallVector< T, S >::Begin(), bind, Close(), SmallVector< T, S >::End(), SmallVector< T, S >::Length(), and sockets.

Referenced by SendPacket().

void NetworkUDPSocketHandler::Receive_CLIENT_DETAIL_INFO ( Packet p,
NetworkAddress client_addr 
)
protectedvirtual

Query for detailed information about companies.

Parameters
pThe received packet.
client_addrThe origin of the packet.

Reimplemented in ServerNetworkUDPSocketHandler.

Definition at line 339 of file udp.cpp.

References PACKET_UDP_CLIENT_DETAIL_INFO, and ReceiveInvalidPacket().

Referenced by HandleUDPPacket().

void NetworkUDPSocketHandler::Receive_CLIENT_FIND_SERVER ( Packet p,
NetworkAddress client_addr 
)
protectedvirtual

Queries to the server for information about the game.

Parameters
pThe received packet.
client_addrThe origin of the packet.

Reimplemented in ServerNetworkUDPSocketHandler.

Definition at line 337 of file udp.cpp.

References PACKET_UDP_CLIENT_FIND_SERVER, and ReceiveInvalidPacket().

Referenced by HandleUDPPacket().

void NetworkUDPSocketHandler::Receive_CLIENT_GET_LIST ( Packet p,
NetworkAddress client_addr 
)
protectedvirtual

The client requests a list of servers.

uint8 The protocol version. uint8 The type of server to look for: IPv4, IPv6 or based on the received packet.

Parameters
pThe received packet.
client_addrThe origin of the packet.

Definition at line 343 of file udp.cpp.

References PACKET_UDP_CLIENT_GET_LIST, and ReceiveInvalidPacket().

Referenced by HandleUDPPacket().

void NetworkUDPSocketHandler::Receive_CLIENT_GET_NEWGRFS ( Packet p,
NetworkAddress client_addr 
)
protectedvirtual

The client requests information about some NewGRFs.

uint8 The number of NewGRFs information is requested about. For each NewGRF: uint32 The GRFID. 16 * uint8 MD5 checksum of the GRF.

Parameters
pThe received packet.
client_addrThe origin of the packet.

Reimplemented in ServerNetworkUDPSocketHandler.

Definition at line 346 of file udp.cpp.

References PACKET_UDP_CLIENT_GET_NEWGRFS, and ReceiveInvalidPacket().

Referenced by HandleUDPPacket().

void NetworkUDPSocketHandler::Receive_MASTER_ACK_REGISTER ( Packet p,
NetworkAddress client_addr 
)
protectedvirtual

The master server acknowledges the registration.

Parameters
pThe received packet.
client_addrThe origin of the packet.

Reimplemented in MasterNetworkUDPSocketHandler.

Definition at line 342 of file udp.cpp.

References PACKET_UDP_MASTER_ACK_REGISTER, and ReceiveInvalidPacket().

Referenced by HandleUDPPacket().

void NetworkUDPSocketHandler::Receive_MASTER_RESPONSE_LIST ( Packet p,
NetworkAddress client_addr 
)
protectedvirtual

The server sends a list of servers.

uint8 The protocol version. For each server: 4 or 16 bytes of IPv4 or IPv6 address. uint8 The port.

Parameters
pThe received packet.
client_addrThe origin of the packet.

Reimplemented in ClientNetworkUDPSocketHandler.

Definition at line 344 of file udp.cpp.

References PACKET_UDP_MASTER_RESPONSE_LIST, and ReceiveInvalidPacket().

Referenced by HandleUDPPacket().

void NetworkUDPSocketHandler::Receive_MASTER_SESSION_KEY ( Packet p,
NetworkAddress client_addr 
)
protectedvirtual

The master server sends us a session key.

uint64 The session key.

Parameters
pThe received packet.
client_addrThe origin of the packet.

Reimplemented in MasterNetworkUDPSocketHandler.

Definition at line 348 of file udp.cpp.

References PACKET_UDP_MASTER_SESSION_KEY, and ReceiveInvalidPacket().

Referenced by HandleUDPPacket().

void NetworkUDPSocketHandler::Receive_SERVER_DETAIL_INFO ( Packet p,
NetworkAddress client_addr 
)
protectedvirtual

Reply with detailed company information.

uint8 Version of the packet. uint8 Number of companies. For each company: uint8 ID of the company. string Name of the company. uint32 Year the company was inaugurated. uint64 Value. uint64 Money. uint64 Income. uint16 Performance (last quarter). bool Company is password protected. uint16 Number of trains. uint16 Number of lorries. uint16 Number of busses. uint16 Number of planes. uint16 Number of ships. uint16 Number of train stations. uint16 Number of lorry stations. uint16 Number of bus stops. uint16 Number of airports and heliports. uint16 Number of harbours. bool Company is an AI.

Parameters
pThe received packet.
client_addrThe origin of the packet.

Definition at line 340 of file udp.cpp.

References PACKET_UDP_SERVER_DETAIL_INFO, and ReceiveInvalidPacket().

Referenced by HandleUDPPacket().

void NetworkUDPSocketHandler::Receive_SERVER_NEWGRFS ( Packet p,
NetworkAddress client_addr 
)
protectedvirtual

The server returns information about some NewGRFs.

uint8 The number of NewGRFs information is requested about. For each NewGRF: uint32 The GRFID. 16 * uint8 MD5 checksum of the GRF. string The name of the NewGRF.

Parameters
pThe received packet.
client_addrThe origin of the packet.

Reimplemented in ClientNetworkUDPSocketHandler.

Definition at line 347 of file udp.cpp.

References PACKET_UDP_SERVER_NEWGRFS, and ReceiveInvalidPacket().

Referenced by HandleUDPPacket().

void NetworkUDPSocketHandler::Receive_SERVER_REGISTER ( Packet p,
NetworkAddress client_addr 
)
protectedvirtual

Registers the server to the master server.

string The "welcome" message to root out other binary packets. uint8 Version of the protocol. uint16 The port to unregister. uint64 The session key.

Parameters
pThe received packet.
client_addrThe origin of the packet.

Definition at line 341 of file udp.cpp.

References PACKET_UDP_SERVER_REGISTER, and ReceiveInvalidPacket().

Referenced by HandleUDPPacket().

void NetworkUDPSocketHandler::Receive_SERVER_RESPONSE ( Packet p,
NetworkAddress client_addr 
)
protectedvirtual

Return of server information to the client.

This packet has several legacy versions, so we list the version and size of each "field":

Version: Bytes: Description: all 1 the version of this packet's structure

4+ 1 number of GRFs attached (n) 4+ n * 20 unique identifier for GRF files. Consists of:

  • one 4 byte variable with the GRF ID
  • 16 bytes (sent sequentially) for the MD5 checksum of the GRF

3+ 4 current game date in days since 1-1-0 (DMY) 3+ 4 game introduction date in days since 1-1-0 (DMY)

2+ 1 maximum number of companies allowed on the server 2+ 1 number of companies on the server 2+ 1 maximum number of spectators allowed on the server

1+ var string with the name of the server 1+ var string with the revision of the server 1+ 1 the language run on the server (0 = any, 1 = English, 2 = German, 3 = French) 1+ 1 whether the server uses a password (0 = no, 1 = yes) 1+ 1 maximum number of clients allowed on the server 1+ 1 number of clients on the server 1+ 1 number of spectators on the server 1 & 2 2 current game date in days since 1-1-1920 (DMY) 1 & 2 2 game introduction date in days since 1-1-1920 (DMY) 1+ var string with the name of the map 1+ 2 width of the map in tiles 1+ 2 height of the map in tiles 1+ 1 type of map: (0 = temperate, 1 = arctic, 2 = desert, 3 = toyland) 1+ 1 whether the server is dedicated (0 = no, 1 = yes)

Parameters
pThe received packet.
client_addrThe origin of the packet.

Reimplemented in ClientNetworkUDPSocketHandler.

Definition at line 338 of file udp.cpp.

References PACKET_UDP_SERVER_RESPONSE, and ReceiveInvalidPacket().

Referenced by HandleUDPPacket().

void NetworkUDPSocketHandler::Receive_SERVER_UNREGISTER ( Packet p,
NetworkAddress client_addr 
)
protectedvirtual

A server unregisters itself at the master server.

uint8 Version of the protocol. uint16 The port to unregister.

Parameters
pThe received packet.
client_addrThe origin of the packet.

Definition at line 345 of file udp.cpp.

References PACKET_UDP_SERVER_UNREGISTER, and ReceiveInvalidPacket().

Referenced by HandleUDPPacket().

void NetworkUDPSocketHandler::ReceiveInvalidPacket ( PacketUDPType  type,
NetworkAddress client_addr 
)
protected
void NetworkUDPSocketHandler::ReceiveNetworkGameInfo ( Packet p,
NetworkGameInfo info 
)
void NetworkUDPSocketHandler::SendNetworkGameInfo ( Packet p,
const NetworkGameInfo info 
)
void NetworkUDPSocketHandler::SendPacket ( Packet p,
NetworkAddress recv,
bool  all = false,
bool  broadcast = false 
)

Field Documentation

NetworkAddressList NetworkUDPSocketHandler::bind
protected

The address to bind to.

Definition at line 53 of file udp.h.

Referenced by Listen().

SocketList NetworkUDPSocketHandler::sockets
protected

The opened sockets.

Definition at line 55 of file udp.h.

Referenced by Close(), Listen(), ReceivePackets(), and SendPacket().


The documentation for this class was generated from the following files: