OpenTTD Source  20241121-master-g67a0fccfad
tcp_content.h
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 <http://www.gnu.org/licenses/>.
6  */
7 
12 #ifndef NETWORK_CORE_TCP_CONTENT_H
13 #define NETWORK_CORE_TCP_CONTENT_H
14 
15 #include "os_abstraction.h"
16 #include "tcp.h"
17 #include "packet.h"
18 #include "../../debug.h"
19 #include "tcp_content_type.h"
20 
23 protected:
25 
37  virtual bool Receive_CLIENT_INFO_LIST(Packet &p);
38 
46  virtual bool Receive_CLIENT_INFO_ID(Packet &p);
47 
60  virtual bool Receive_CLIENT_INFO_EXTID(Packet &p);
61 
75  virtual bool Receive_CLIENT_INFO_EXTID_MD5(Packet &p);
76 
93  virtual bool Receive_SERVER_INFO(Packet &p);
94 
102  virtual bool Receive_CLIENT_CONTENT(Packet &p);
103 
114  virtual bool Receive_SERVER_CONTENT(Packet &p);
115 
116  bool HandlePacket(Packet &p);
117 public:
123  NetworkContentSocketHandler(SOCKET s = INVALID_SOCKET) :
125  {
126  }
127 
130  {
131  /* Virtual functions get called statically in destructors, so make it explicit to remove any confusion. */
132  this->CloseSocket();
133  }
134 
135  bool ReceivePackets();
136 };
137 
139 
140 #endif /* NETWORK_CORE_TCP_CONTENT_H */
Base socket handler for all Content TCP sockets.
Definition: tcp_content.h:22
virtual bool Receive_CLIENT_CONTENT(Packet &p)
Client requesting the actual content: uint16_t count of unique ids uint32_t unique id (count times)
virtual bool Receive_CLIENT_INFO_EXTID(Packet &p)
Client requesting a list of content info based on an external 'unique' id; GRF ID for NewGRFS,...
virtual bool Receive_CLIENT_INFO_EXTID_MD5(Packet &p)
Client requesting a list of content info based on an external 'unique' id; GRF ID + MD5 checksum for ...
virtual bool Receive_SERVER_INFO(Packet &p)
Server sending list of content info: uint8_t type (invalid ID == does not exist) uint32_t id uint32_t...
virtual bool Receive_CLIENT_INFO_ID(Packet &p)
Client requesting a list of content info: uint16_t count of ids uint32_t id (count times)
virtual bool Receive_SERVER_CONTENT(Packet &p)
Server sending list of content info: uint32_t unique id uint32_t file size (0 == does not exist) stri...
NetworkContentSocketHandler(SOCKET s=INVALID_SOCKET)
Create a new cs socket handler for a given cs.
Definition: tcp_content.h:123
bool ReceivePackets()
Receive a packet at TCP level.
virtual bool Receive_CLIENT_INFO_LIST(Packet &p)
Client requesting a list of content info: uint8_t type uint32_t openttd version (or 0xFFFFFFFF if usi...
virtual ~NetworkContentSocketHandler()
On destructing of this class, the socket needs to be closed.
Definition: tcp_content.h:129
bool ReceiveInvalidPacket(PacketContentType type)
Helper for logging receiving invalid packets.
bool HandlePacket(Packet &p)
Handle the given packet, i.e.
Base socket handler for all TCP sockets.
Definition: tcp.h:31
void CloseSocket()
Close the actual socket of the connection.
Definition: tcp.cpp:39
Subdirectory
The different kinds of subdirectories OpenTTD uses.
Definition: fileio_type.h:115
Network stuff has many things that needs to be included and/or implemented by default.
Basic functions to create, fill and read packets.
Internal entity of a packet.
Definition: packet.h:42
Basic functions to receive and send TCP packets.
Subdirectory GetContentInfoSubDir(ContentType type)
Helper to get the subdirectory a ContentInfo is located in.
Basic types related to the content on the content server.
ContentType
The values in the enum are important; they are used as database 'keys'.
PacketContentType
Enum with all types of TCP content packets.