Socket handler for the content server connection. More...

#include <network_content.h>

Inheritance diagram for ClientNetworkContentSocketHandler:

Public Member Functions
	ClientNetworkContentSocketHandler ()
	Create a socket handler to handle the connection.

	~ClientNetworkContentSocketHandler ()
	Clear up the mess ;)

void	Connect ()
	Connect with the content server.

void	SendReceive ()
	Check whether we received/can send some data from/to the content server and when that's the case handle it appropriately.

NetworkRecvStatus	CloseConnection (bool error=true) override
	Disconnect from the content server.

void	Cancel ()
	Cancel the current download.

void	RequestContentList (ContentType type)
	Request the content list for the given type.

void	RequestContentList (uint count, const ContentID *content_ids)
	Request the content list for a given number of content IDs.

void	RequestContentList (ContentVector *cv, bool send_md5sum=true)
	Request the content list for a list of content.

void	DownloadSelectedContent (uint &files, uint &bytes, bool fallback=false)
	Actually begin downloading the content we selected.

void	Select (ContentID cid)
	Select a specific content id.

void	Unselect (ContentID cid)
	Unselect a specific content id.

void	SelectAll ()
	Select everything we can select.

void	SelectUpgrade ()
	Select everything that's an update for something we've got.

void	UnselectAll ()
	Unselect everything that we've not downloaded so far.

void	ToggleSelectedState (const ContentInfo *ci)
	Toggle the state of a content info and check its dependencies.

void	ReverseLookupDependency (ConstContentVector &parents, const ContentInfo *child) const
	Reverse lookup the dependencies of (direct) parents over a given child.

void	ReverseLookupTreeDependency (ConstContentVector &tree, const ContentInfo *child) const
	Reverse lookup the dependencies of all parents over a given child.

void	CheckDependencyState (ContentInfo *ci)
	Check the dependencies (recursively) of this content info.

uint	Length () const
	Get the number of content items we know locally.

ConstContentIterator	Begin () const
	Get the begin of the content inf iterator.

ConstContentIterator	Get (uint32_t index) const
	Get the nth position of the content inf iterator.

ConstContentIterator	End () const
	Get the end of the content inf iterator.

void	Clear ()
	Clear all downloaded content information.

void	AddCallback (ContentCallback *cb)
	Add a callback to this class.

void	RemoveCallback (ContentCallback *cb)
	Remove a callback.

Public Member Functions inherited from NetworkContentSocketHandler
	NetworkContentSocketHandler (SOCKET s=INVALID_SOCKET)
	Create a new cs socket handler for a given cs.

virtual	~NetworkContentSocketHandler ()
	On destructing of this class, the socket needs to be closed.

bool	ReceivePackets ()
	Receive a packet at TCP level.

Public Member Functions inherited from NetworkTCPSocketHandler
bool	IsConnected () const
	Whether this socket is currently bound to a socket.

void	CloseSocket ()
	Close the actual socket of the connection.

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.

SendPacketsState	SendPackets (bool closing_down=false)
	Sends all the buffered packets out for this client.

virtual std::unique_ptr< Packet >	ReceivePacket ()
	Receives a packet for the given client.

bool	CanSendReceive ()
	Check whether this socket can send or receive something.

bool	HasSendQueue ()
	Whether there is something pending in the send queue.

	NetworkTCPSocketHandler (SOCKET s=INVALID_SOCKET)
	Construct a socket handler for a TCP connection.

Public Member Functions inherited from NetworkSocketHandler
	NetworkSocketHandler ()
	Create a new unbound socket.

virtual	~NetworkSocketHandler ()=default
	Close the socket when destructing the socket handler.

void	MarkClosed ()
	Mark the connection as closed.

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.

Static Public Attributes
static constexpr std::chrono::seconds	IDLE_TIMEOUT = std::chrono::seconds(60)
	The idle timeout; when to close the connection because it's idle.

Protected Types
typedef std::vector< ContentID >	ContentIDList
	List of content IDs to (possibly) select.

Protected Member Functions
bool	Receive_SERVER_INFO (Packet &p) override
	Server sending list of content info: uint8_t type (invalid ID == does not exist) uint32_t id uint32_t file_size string name (max 32 characters) string version (max 16 characters) uint32_t unique id uint8_t md5sum (16 bytes) uint8_t dependency count uint32_t unique id of dependency (dependency count times) uint8_t tag count string tag (max 32 characters for tag count times)

bool	Receive_SERVER_CONTENT (Packet &p) override
	Server sending list of content info: uint32_t unique id uint32_t file size (0 == does not exist) string file name (max 48 characters) After this initial packet, packets with the actual data are send using the same packet type.

ContentInfo *	GetContent (ContentID cid) const
	Get the content info based on a ContentID.

void	DownloadContentInfo (ContentID cid)
	Download information of a given Content ID if not already tried.

void	OnConnect (bool success) override
	Callback for when the connection has finished.

void	OnDisconnect () override
	Callback for when the connection got disconnected.

void	OnReceiveContentInfo (const ContentInfo *ci) override
	We received a content info.

void	OnDownloadProgress (const ContentInfo *ci, int bytes) override
	We have progress in the download of a file.

void	OnDownloadComplete (ContentID cid) override
	We have finished downloading a file.

void	OnFailure () override
	An error has occurred and the connection has been closed.

void	OnReceiveData (std::unique_ptr< char[]> data, size_t length) override
	We're receiving data.

bool	IsCancelled () const override
	Check if there is a request to cancel the transfer.

bool	BeforeDownload ()
	Handle the opening of the file before downloading.

void	AfterDownload ()
	Handle the closing and extracting of a file after downloading it has been done.

void	DownloadSelectedContentHTTP (const ContentIDList &content)
	Initiate downloading the content over HTTP.

void	DownloadSelectedContentFallback (const ContentIDList &content)
	Initiate downloading the content over the fallback protocol.

Protected Member Functions inherited from NetworkContentSocketHandler
bool	ReceiveInvalidPacket (PacketContentType type)
	Helper for logging receiving invalid packets.

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 using a list) Only if the above value is 0xFFFFFFFF: uint8_t count string branch-name ("vanilla" for upstream OpenTTD) string release version (like "12.0")

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_CLIENT_INFO_EXTID (Packet &p)
	Client requesting a list of content info based on an external 'unique' id; GRF ID for NewGRFS, shortname and for base graphics and AIs.

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 NewGRFS, shortname and xor-ed MD5 checksums for base graphics and AIs.

virtual bool	Receive_CLIENT_CONTENT (Packet &p)
	Client requesting the actual content: uint16_t count of unique ids uint32_t unique id (count times)

bool	HandlePacket (Packet &p)
	Handle the given packet, i.e.

Protected Attributes
std::vector< ContentCallback * >	callbacks
	Callbacks to notify "the world".

ContentIDList	requested
	ContentIDs we already requested (so we don't do it again)

ContentVector	infos
	All content info we received.

std::unordered_multimap< ContentID, ContentID >	reverse_dependency_map
	Content reverse dependency map.

std::vector< char >	http_response
	The HTTP response to the requests we've been doing.

int	http_response_index
	Where we are, in the response, with handling it.

std::optional< FileHandle >	curFile
	Currently downloaded file.

ContentInfo *	curInfo
	Information about the currently downloaded file.

bool	isConnecting
	Whether we're connecting.

bool	isCancelled
	Whether the download has been cancelled.

std::chrono::steady_clock::time_point	lastActivity
	The last time there was network activity.

Protected Attributes inherited from NetworkSocketHandler
std::unique_ptr< class NetworkEncryptionHandler >	receive_encryption_handler
	The handler for decrypting received packets.

std::unique_ptr< class NetworkEncryptionHandler >	send_encryption_handler
	The handler for encrypting sent packets.

Friends
class	NetworkContentConnecter

Additional Inherited Members
Data Fields inherited from NetworkTCPSocketHandler
SOCKET	sock
	The socket currently connected to.

bool	writable
	Can we write to this socket?

Private Member Functions inherited from ContentCallback
virtual	~ContentCallback ()=default
	Silentium.

Private Member Functions inherited from HTTPCallback
virtual	~HTTPCallback ()=default
	Silentium.

Detailed Description

Socket handler for the content server connection.

Definition at line 67 of file network_content.h.

Member Typedef Documentation

◆ ContentIDList

typedef std::vector<ContentID> ClientNetworkContentSocketHandler::ContentIDList

protected

List of content IDs to (possibly) select.

Definition at line 69 of file network_content.h.

Constructor & Destructor Documentation

◆ ClientNetworkContentSocketHandler()

ClientNetworkContentSocketHandler::ClientNetworkContentSocketHandler ( )

Create a socket handler to handle the connection.

Definition at line 728 of file network_content.cpp.

References lastActivity.

◆ ~ClientNetworkContentSocketHandler()

ClientNetworkContentSocketHandler::~ClientNetworkContentSocketHandler ( )

Clear up the mess ;)

Definition at line 740 of file network_content.cpp.

References curInfo, and infos.

Member Function Documentation

◆ AddCallback()

void ClientNetworkContentSocketHandler::AddCallback ( ContentCallback * cb )

inline

Add a callback to this class.

Definition at line 147 of file network_content.h.

References include().

Referenced by BaseNetworkContentDownloadStatusWindow::BaseNetworkContentDownloadStatusWindow(), BootstrapAskForDownloadWindow::BootstrapAskForDownloadWindow(), and NetworkContentListWindow::NetworkContentListWindow().

◆ AfterDownload()

void ClientNetworkContentSocketHandler::AfterDownload ( )

protected

Handle the closing and extracting of a file after downloading it has been done.

Definition at line 539 of file network_content.cpp.

References TarScanner::AddFile(), BASESET_DIR, CONTENT_TYPE_BASE_MUSIC, curFile, curInfo, ExtractTar(), FioRemove(), GetContentInfoSubDir(), GetFullFilename(), GunzipFile(), ContentInfo::id, INVALID_STRING_ID, NO_DIRECTORY, OnDownloadComplete(), ShowErrorMessage(), ContentInfo::type, and WL_ERROR.

Referenced by OnReceiveData(), and Receive_SERVER_CONTENT().

◆ BeforeDownload()

bool ClientNetworkContentSocketHandler::BeforeDownload ( )

protected

Handle the opening of the file before downloading.

Returns: false on any error.

Definition at line 514 of file network_content.cpp.

References CloseWindowById(), curInfo, ContentInfo::filesize, GetFullFilename(), ContentInfo::IsValid(), FileHandle::Open(), ShowErrorMessage(), WC_NETWORK_STATUS_WINDOW, WL_ERROR, and WN_NETWORK_STATUS_WINDOW_CONTENT_DOWNLOAD.

Referenced by OnReceiveData(), and Receive_SERVER_CONTENT().

◆ Begin()

ConstContentIterator ClientNetworkContentSocketHandler::Begin ( ) const

inline

Get the begin of the content inf iterator.

Definition at line 138 of file network_content.h.

Referenced by NetworkContentListWindow::BuildContentList(), NetworkContentListWindow::DrawDetails(), and End().

◆ Cancel()

void ClientNetworkContentSocketHandler::Cancel ( void )

Cancel the current download.

Definition at line 804 of file network_content.cpp.

References CloseConnection(), and isCancelled.

Referenced by NetworkContentDownloadStatusWindow::OnClick().

◆ CheckDependencyState()

void ClientNetworkContentSocketHandler::CheckDependencyState ( ContentInfo * ci )

Check the dependencies (recursively) of this content info.

Parameters

ci	the content info to check the dependencies of

Definition at line 976 of file network_content.cpp.

References ContentInfo::ALREADY_HERE, ContentInfo::AUTOSELECTED, CheckDependencyState(), ContentInfo::dependencies, DownloadContentInfo(), GetContent(), ContentInfo::id, ContentInfo::IsSelected(), ReverseLookupDependency(), ReverseLookupTreeDependency(), ContentInfo::SELECTED, ContentInfo::state, Unselect(), and ContentInfo::UNSELECTED.

Referenced by CheckDependencyState(), Receive_SERVER_INFO(), Select(), SelectAll(), SelectUpgrade(), and Unselect().

◆ Clear()

void ClientNetworkContentSocketHandler::Clear ( )

Clear all downloaded content information.

Definition at line 1064 of file network_content.cpp.

References infos, requested, and reverse_dependency_map.

Referenced by ShowNetworkContentListWindow().

◆ CloseConnection()

NetworkRecvStatus ClientNetworkContentSocketHandler::CloseConnection ( bool error = true )

overridevirtual

Disconnect from the content server.

Reimplemented from NetworkTCPSocketHandler.

Definition at line 789 of file network_content.cpp.

References NetworkTCPSocketHandler::CloseConnection(), NetworkTCPSocketHandler::CloseSocket(), NETWORK_RECV_STATUS_OKAY, OnDisconnect(), and NetworkTCPSocketHandler::sock.

Referenced by Cancel(), Receive_SERVER_CONTENT(), Receive_SERVER_INFO(), and SendReceive().

◆ Connect()

void ClientNetworkContentSocketHandler::Connect ( )

Connect with the content server.

Definition at line 776 of file network_content.cpp.

References isCancelled, isConnecting, NetworkContentServerConnectionString(), and NetworkTCPSocketHandler::sock.

Referenced by DownloadSelectedContentFallback(), BootstrapAskForDownloadWindow::OnClick(), RequestContentList(), RequestContentList(), and RequestContentList().

◆ DownloadContentInfo()

void ClientNetworkContentSocketHandler::DownloadContentInfo ( ContentID cid )

protected

Download information of a given Content ID if not already tried.

Parameters

cid	the ID to try

Definition at line 838 of file network_content.cpp.

References RequestContentList(), and requested.

Referenced by CheckDependencyState().

◆ DownloadSelectedContent()

void ClientNetworkContentSocketHandler::DownloadSelectedContent	(	uint &	files,
		uint &	bytes,
		bool	fallback = `false`
	)

Actually begin downloading the content we selected.

Parameters

[out]	files	The number of files we are going to download.
[out]	bytes	The number of bytes we are going to download.
	fallback	Whether to use the fallback or not.

Definition at line 305 of file network_content.cpp.

References ContentInfo::ALREADY_HERE, DownloadSelectedContentFallback(), DownloadSelectedContentHTTP(), infos, and isCancelled.

Referenced by BaseNetworkContentDownloadStatusWindow::BaseNetworkContentDownloadStatusWindow(), and OnFailure().

◆ DownloadSelectedContentFallback()

void ClientNetworkContentSocketHandler::DownloadSelectedContentFallback ( const ContentIDList & content )

protected

Initiate downloading the content over the fallback protocol.

Parameters

content The content to download.

Definition at line 351 of file network_content.cpp.

References Connect(), PACKET_CONTENT_CLIENT_CONTENT, NetworkTCPSocketHandler::SendPacket(), and TCP_MTU.

Referenced by DownloadSelectedContent().

◆ DownloadSelectedContentHTTP()

void ClientNetworkContentSocketHandler::DownloadSelectedContentHTTP ( const ContentIDList & content )

protected

Initiate downloading the content over HTTP.

Parameters

content The content to download.

Definition at line 335 of file network_content.cpp.

References NetworkHTTPSocketHandler::Connect(), http_response_index, and NetworkContentMirrorUriString().

Referenced by DownloadSelectedContent().

◆ End()

ConstContentIterator ClientNetworkContentSocketHandler::End ( ) const

inline

Get the end of the content inf iterator.

Definition at line 142 of file network_content.h.

References Begin(), and Length().

Referenced by NetworkContentListWindow::BuildContentList(), and NetworkContentListWindow::DrawDetails().

◆ Get()

ConstContentIterator ClientNetworkContentSocketHandler::Get ( uint32_t index ) const

inline

Get the nth position of the content inf iterator.

Definition at line 140 of file network_content.h.

◆ GetContent()

ContentInfo * ClientNetworkContentSocketHandler::GetContent ( ContentID cid ) const

protected

Get the content info based on a ContentID.

Parameters

cid	the ContentID to search for

Returns: the ContentInfo or nullptr if not found

Definition at line 852 of file network_content.cpp.

References infos.

Referenced by CheckDependencyState(), OnDownloadComplete(), ReverseLookupDependency(), Select(), and Unselect().

◆ IsCancelled()

bool ClientNetworkContentSocketHandler::IsCancelled ( ) const

overrideprotectedvirtual

Check if there is a request to cancel the transfer.

Returns: true iff the connection is cancelled.

Note: Cancellations are never instant, and can take a bit of time to be processed. The object needs to remain valid until the OnFailure() callback is called.

Implements HTTPCallback.

Definition at line 571 of file network_content.cpp.

References isCancelled.

◆ Length()

uint ClientNetworkContentSocketHandler::Length ( ) const

inline

Get the number of content items we know locally.

Definition at line 136 of file network_content.h.

Referenced by End().

◆ OnConnect()

void ClientNetworkContentSocketHandler::OnConnect ( bool success )

overrideprotectedvirtual

Callback for when the connection has finished.

Parameters

success whether the connection was made or that we failed to make it

Reimplemented from ContentCallback.

Definition at line 1075 of file network_content.cpp.

References callbacks, and ContentCallback::OnConnect().

Referenced by NetworkContentConnecter::OnConnect(), and NetworkContentConnecter::OnFailure().

◆ OnDisconnect()

void ClientNetworkContentSocketHandler::OnDisconnect ( )

overrideprotectedvirtual

Callback for when the connection got disconnected.

Reimplemented from ContentCallback.

Definition at line 1085 of file network_content.cpp.

References callbacks, and ContentCallback::OnDisconnect().

Referenced by CloseConnection().

◆ OnDownloadComplete()

void ClientNetworkContentSocketHandler::OnDownloadComplete ( ContentID cid )

overrideprotectedvirtual

We have finished downloading a file.

Parameters

cid	the ContentID of the downloaded file

Reimplemented from ContentCallback.

Definition at line 1113 of file network_content.cpp.

References ContentInfo::ALREADY_HERE, callbacks, GetContent(), ContentCallback::OnDownloadComplete(), and ContentInfo::state.

Referenced by AfterDownload().

◆ OnDownloadProgress()

void ClientNetworkContentSocketHandler::OnDownloadProgress	(	const ContentInfo *	ci,
		int	bytes
	)

overrideprotectedvirtual

We have progress in the download of a file.

Parameters

ci	the content info of the file
bytes	the number of bytes downloaded since the previous call

Reimplemented from ContentCallback.

Definition at line 1104 of file network_content.cpp.

References callbacks, and ContentCallback::OnDownloadProgress().

Referenced by OnFailure(), OnReceiveData(), and Receive_SERVER_CONTENT().

◆ OnFailure()

void ClientNetworkContentSocketHandler::OnFailure ( )

overrideprotectedvirtual

An error has occurred and the connection has been closed.

Note: HTTP socket handler is closed/freed.

Implements HTTPCallback.

Definition at line 577 of file network_content.cpp.

References curFile, curInfo, DownloadSelectedContent(), http_response, http_response_index, isCancelled, and OnDownloadProgress().

Referenced by OnReceiveData().

◆ OnReceiveContentInfo()

void ClientNetworkContentSocketHandler::OnReceiveContentInfo ( const ContentInfo * ci )

overrideprotectedvirtual

We received a content info.

Parameters

ci	the content info

Reimplemented from ContentCallback.

Definition at line 1094 of file network_content.cpp.

References callbacks, and ContentCallback::OnReceiveContentInfo().

Referenced by Receive_SERVER_INFO().

◆ OnReceiveData()

void ClientNetworkContentSocketHandler::OnReceiveData	(	std::unique_ptr< char[]>	data,
		size_t	length
	)

overrideprotectedvirtual

We're receiving data.

Parameters

data	the received data, nullptr when all data has been received.
length	the amount of received data, 0 when all data has been received.

Note: When nullptr is sent the HTTP socket handler is closed/freed.

Check p for not being null and return calling OnFailure if that's not the case.

Check p for not being null and then terminate, or return calling OnFailure.

Implements HTTPCallback.

Definition at line 597 of file network_content.cpp.

References AfterDownload(), BeforeDownload(), NetworkHTTPSocketHandler::Connect(), curFile, curInfo, ContentInfo::filename, ContentInfo::filesize, http_response, http_response_index, ContentInfo::id, OnDownloadProgress(), OnFailure(), and ContentInfo::type.

◆ Receive_SERVER_CONTENT()

bool ClientNetworkContentSocketHandler::Receive_SERVER_CONTENT ( Packet & p )

overrideprotectedvirtual

Server sending list of content info: uint32_t unique id uint32_t file size (0 == does not exist) string file name (max 48 characters) After this initial packet, packets with the actual data are send using the same packet type.

Parameters

p	The packet that was just received.

Returns: True upon success, otherwise false.

Reimplemented from NetworkContentSocketHandler.

Definition at line 475 of file network_content.cpp.

References AfterDownload(), BeforeDownload(), CloseConnection(), CloseWindowById(), curFile, curInfo, ContentInfo::filename, ContentInfo::filesize, ContentInfo::id, NETWORK_CONTENT_FILENAME_LENGTH, OnDownloadProgress(), Packet::Recv_string(), Packet::Recv_uint32(), Packet::Recv_uint8(), Packet::RemainingBytesToTransfer(), ShowErrorMessage(), Packet::TransferOut(), TransferOutFWrite(), ContentInfo::type, WC_NETWORK_STATUS_WINDOW, WL_ERROR, and WN_NETWORK_STATUS_WINDOW_CONTENT_DOWNLOAD.

◆ Receive_SERVER_INFO()

bool ClientNetworkContentSocketHandler::Receive_SERVER_INFO ( Packet & p )

overrideprotectedvirtual

Server sending list of content info: uint8_t type (invalid ID == does not exist) uint32_t id uint32_t file_size string name (max 32 characters) string version (max 16 characters) uint32_t unique id uint8_t md5sum (16 bytes) uint8_t dependency count uint32_t unique id of dependency (dependency count times) uint8_t tag count string tag (max 32 characters for tag count times)

Parameters

p	The packet that was just received.

Returns: True upon success, otherwise false.

Reimplemented from NetworkContentSocketHandler.

Definition at line 53 of file network_content.cpp.

References ContentInfo::ALREADY_HERE, CheckDependencyState(), CloseConnection(), CONTENT_TYPE_AI, CONTENT_TYPE_AI_LIBRARY, CONTENT_TYPE_BASE_GRAPHICS, CONTENT_TYPE_BASE_MUSIC, CONTENT_TYPE_BASE_SOUNDS, CONTENT_TYPE_GAME, CONTENT_TYPE_GAME_LIBRARY, CONTENT_TYPE_HEIGHTMAP, CONTENT_TYPE_NEWGRF, CONTENT_TYPE_SCENARIO, ContentInfo::dependencies, ContentInfo::description, ContentInfo::DOES_NOT_EXIST, ContentInfo::filesize, AI::HasAI(), Game::HasGame(), HasGRFConfig(), HasScenario(), BaseMedia< GraphicsSet >::HasSet(), BaseMedia< MusicSet >::HasSet(), BaseMedia< SoundsSet >::HasSet(), ContentInfo::id, infos, ContentInfo::IsValid(), ContentInfo::md5sum, ContentInfo::name, NETWORK_CONTENT_DESC_LENGTH, NETWORK_CONTENT_NAME_LENGTH, NETWORK_CONTENT_TAG_LENGTH, NETWORK_CONTENT_URL_LENGTH, NETWORK_CONTENT_VERSION_LENGTH, OnReceiveContentInfo(), Packet::Recv_bytes(), Packet::Recv_string(), Packet::Recv_uint32(), Packet::Recv_uint8(), reverse_dependency_map, ReverseLookupTreeDependency(), ContentInfo::state, SVS_ALLOW_NEWLINE, SVS_REPLACE_WITH_QUESTION_MARK, ContentInfo::tags, ContentInfo::type, ContentInfo::unique_id, ContentInfo::UNSELECTED, ContentInfo::upgrade, ContentInfo::url, and ContentInfo::version.

◆ RemoveCallback()

void ClientNetworkContentSocketHandler::RemoveCallback ( ContentCallback * cb )

inline

Remove a callback.

Definition at line 149 of file network_content.h.

Referenced by BootstrapAskForDownloadWindow::Close(), NetworkContentListWindow::Close(), and BaseNetworkContentDownloadStatusWindow::Close().

◆ RequestContentList() [1/3]

void ClientNetworkContentSocketHandler::RequestContentList ( ContentType type )

Request the content list for the given type.

Parameters

type	The content type to request the list for.

Definition at line 188 of file network_content.cpp.

References Connect(), CONTENT_TYPE_AI, CONTENT_TYPE_AI_LIBRARY, CONTENT_TYPE_BASE_GRAPHICS, CONTENT_TYPE_BASE_MUSIC, CONTENT_TYPE_BASE_SOUNDS, CONTENT_TYPE_END, CONTENT_TYPE_GAME, CONTENT_TYPE_GAME_LIBRARY, CONTENT_TYPE_HEIGHTMAP, CONTENT_TYPE_NEWGRF, CONTENT_TYPE_SCENARIO, PACKET_CONTENT_CLIENT_INFO_LIST, RequestContentList(), and NetworkTCPSocketHandler::SendPacket().

Referenced by DownloadContentInfo(), BootstrapAskForDownloadWindow::OnConnect(), RequestContentList(), and ShowNetworkContentListWindow().

◆ RequestContentList() [2/3]

void ClientNetworkContentSocketHandler::RequestContentList	(	ContentVector *	cv,
		bool	send_md5sum = `true`
	)

Request the content list for a list of content.

Parameters

cv	List with unique IDs and MD5 checksums.
send_md5sum	Whether we want a MD5 checksum matched set of files or not.

Definition at line 260 of file network_content.cpp.

References Connect(), infos, PACKET_CONTENT_CLIENT_INFO_EXTID, PACKET_CONTENT_CLIENT_INFO_EXTID_MD5, NetworkTCPSocketHandler::SendPacket(), and TCP_MTU.

◆ RequestContentList() [3/3]

void ClientNetworkContentSocketHandler::RequestContentList	(	uint	count,
		const ContentID *	content_ids
	)

Request the content list for a given number of content IDs.

Parameters

count	The number of IDs to request.
content_ids	The unique identifiers of the content to request information about.

Definition at line 231 of file network_content.cpp.

References Connect(), PACKET_CONTENT_CLIENT_INFO_ID, NetworkTCPSocketHandler::SendPacket(), and TCP_MTU.

◆ ReverseLookupDependency()

void ClientNetworkContentSocketHandler::ReverseLookupDependency	(	ConstContentVector &	parents,
		const ContentInfo *	child
	)		const

Reverse lookup the dependencies of (direct) parents over a given child.

Parameters

parents	list to store all parents in (is not cleared)
child	the child to search the parents' dependencies for

Definition at line 940 of file network_content.cpp.

References GetContent(), ContentInfo::id, and reverse_dependency_map.

Referenced by CheckDependencyState(), and ReverseLookupTreeDependency().

◆ ReverseLookupTreeDependency()

void ClientNetworkContentSocketHandler::ReverseLookupTreeDependency	(	ConstContentVector &	tree,
		const ContentInfo *	child
	)		const

Reverse lookup the dependencies of all parents over a given child.

Parameters

tree	list to store all parents in (is not cleared)
child	the child to search the parents' dependencies for

Definition at line 954 of file network_content.cpp.

References include(), and ReverseLookupDependency().

Referenced by CheckDependencyState(), NetworkContentListWindow::DrawDetails(), and Receive_SERVER_INFO().

◆ Select()

void ClientNetworkContentSocketHandler::Select ( ContentID cid )

Select a specific content id.

Parameters

cid	the content ID to select

Definition at line 865 of file network_content.cpp.

References CheckDependencyState(), GetContent(), ContentInfo::SELECTED, ContentInfo::state, and ContentInfo::UNSELECTED.

Referenced by BootstrapAskForDownloadWindow::OnReceiveContentInfo(), and ToggleSelectedState().

◆ SelectAll()

void ClientNetworkContentSocketHandler::SelectAll ( )

Select everything we can select.

Definition at line 888 of file network_content.cpp.

References CheckDependencyState(), infos, ContentInfo::SELECTED, and ContentInfo::UNSELECTED.

Referenced by NetworkContentListWindow::OnClick().

◆ SelectUpgrade()

void ClientNetworkContentSocketHandler::SelectUpgrade ( )

Select everything that's an update for something we've got.

Definition at line 899 of file network_content.cpp.

References CheckDependencyState(), infos, ContentInfo::SELECTED, and ContentInfo::UNSELECTED.

Referenced by NetworkContentListWindow::OnClick().

◆ SendReceive()

void ClientNetworkContentSocketHandler::SendReceive ( )

Check whether we received/can send some data from/to the content server and when that's the case handle it appropriately.

Definition at line 814 of file network_content.cpp.

References NetworkTCPSocketHandler::CanSendReceive(), CloseConnection(), IDLE_TIMEOUT, isConnecting, lastActivity, NetworkContentSocketHandler::ReceivePackets(), NetworkTCPSocketHandler::SendPackets(), and NetworkTCPSocketHandler::sock.

Referenced by NetworkBackgroundLoop().

◆ ToggleSelectedState()

void ClientNetworkContentSocketHandler::ToggleSelectedState ( const ContentInfo * ci )

Toggle the state of a content info and check its dependencies.

Definition at line 918 of file network_content.cpp.

References ContentInfo::AUTOSELECTED, ContentInfo::id, Select(), ContentInfo::SELECTED, ContentInfo::state, Unselect(), and ContentInfo::UNSELECTED.

Referenced by NetworkContentListWindow::OnClick(), NetworkContentListWindow::OnKeyPress(), and NetworkContentListWindow::OnReceiveContentInfo().

◆ Unselect()

void ClientNetworkContentSocketHandler::Unselect ( ContentID cid )

Unselect a specific content id.

Parameters

cid	the content ID to deselect

Definition at line 878 of file network_content.cpp.

References CheckDependencyState(), GetContent(), ContentInfo::IsSelected(), ContentInfo::state, and ContentInfo::UNSELECTED.

Referenced by CheckDependencyState(), and ToggleSelectedState().

◆ UnselectAll()

void ClientNetworkContentSocketHandler::UnselectAll ( )

Unselect everything that we've not downloaded so far.

Definition at line 910 of file network_content.cpp.

References ContentInfo::ALREADY_HERE, infos, and ContentInfo::UNSELECTED.

Referenced by NetworkContentListWindow::OnClick().

Friends And Related Symbol Documentation

◆ NetworkContentConnecter

friend class NetworkContentConnecter

friend

Definition at line 83 of file network_content.h.

Field Documentation

◆ callbacks

std::vector<ContentCallback *> ClientNetworkContentSocketHandler::callbacks

protected

Callbacks to notify "the world".

Definition at line 70 of file network_content.h.

Referenced by OnConnect(), OnDisconnect(), OnDownloadComplete(), OnDownloadProgress(), and OnReceiveContentInfo().

◆ curFile

std::optional<FileHandle> ClientNetworkContentSocketHandler::curFile

protected

Currently downloaded file.

Definition at line 77 of file network_content.h.

Referenced by AfterDownload(), OnFailure(), OnReceiveData(), and Receive_SERVER_CONTENT().

◆ curInfo

ContentInfo* ClientNetworkContentSocketHandler::curInfo

protected

Information about the currently downloaded file.

Definition at line 78 of file network_content.h.

Referenced by AfterDownload(), BeforeDownload(), OnFailure(), OnReceiveData(), Receive_SERVER_CONTENT(), and ~ClientNetworkContentSocketHandler().

◆ http_response

std::vector<char> ClientNetworkContentSocketHandler::http_response

protected

The HTTP response to the requests we've been doing.

Definition at line 74 of file network_content.h.

Referenced by OnFailure(), and OnReceiveData().

◆ http_response_index

int ClientNetworkContentSocketHandler::http_response_index

protected

Where we are, in the response, with handling it.

Definition at line 75 of file network_content.h.

Referenced by DownloadSelectedContentHTTP(), OnFailure(), and OnReceiveData().

◆ IDLE_TIMEOUT

constexpr std::chrono::seconds ClientNetworkContentSocketHandler::IDLE_TIMEOUT = std::chrono::seconds(60)

staticconstexpr

The idle timeout; when to close the connection because it's idle.

Definition at line 108 of file network_content.h.

Referenced by SendReceive().

◆ infos

ContentVector ClientNetworkContentSocketHandler::infos

protected

All content info we received.

Definition at line 72 of file network_content.h.

Referenced by Clear(), DownloadSelectedContent(), GetContent(), Receive_SERVER_INFO(), RequestContentList(), SelectAll(), SelectUpgrade(), UnselectAll(), and ~ClientNetworkContentSocketHandler().

◆ isCancelled

bool ClientNetworkContentSocketHandler::isCancelled

protected

Whether the download has been cancelled.

Definition at line 80 of file network_content.h.

Referenced by Cancel(), Connect(), DownloadSelectedContent(), IsCancelled(), and OnFailure().

◆ isConnecting

bool ClientNetworkContentSocketHandler::isConnecting

protected

Whether we're connecting.

Definition at line 79 of file network_content.h.

Referenced by Connect(), NetworkContentConnecter::OnConnect(), NetworkContentConnecter::OnFailure(), and SendReceive().

◆ lastActivity

std::chrono::steady_clock::time_point ClientNetworkContentSocketHandler::lastActivity

protected

The last time there was network activity.

Definition at line 81 of file network_content.h.

Referenced by ClientNetworkContentSocketHandler(), NetworkContentConnecter::OnConnect(), and SendReceive().

◆ requested

ContentIDList ClientNetworkContentSocketHandler::requested

protected

ContentIDs we already requested (so we don't do it again)

Definition at line 71 of file network_content.h.

Referenced by Clear(), and DownloadContentInfo().

◆ reverse_dependency_map

std::unordered_multimap<ContentID, ContentID> ClientNetworkContentSocketHandler::reverse_dependency_map

protected

Content reverse dependency map.

Definition at line 73 of file network_content.h.

Referenced by Clear(), Receive_SERVER_INFO(), and ReverseLookupDependency().

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

src/network/network_content.h
src/network/network_content.cpp

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ContentIDList

Constructor & Destructor Documentation

◆ ClientNetworkContentSocketHandler()

◆ ~ClientNetworkContentSocketHandler()

Member Function Documentation

◆ AddCallback()

◆ AfterDownload()

◆ BeforeDownload()

◆ Begin()

◆ Cancel()

◆ CheckDependencyState()

◆ Clear()

◆ CloseConnection()

◆ Connect()

◆ DownloadContentInfo()

◆ DownloadSelectedContent()

◆ DownloadSelectedContentFallback()

◆ DownloadSelectedContentHTTP()

◆ End()

◆ Get()

◆ GetContent()

◆ IsCancelled()

◆ Length()

◆ OnConnect()

◆ OnDisconnect()

◆ OnDownloadComplete()

◆ OnDownloadProgress()

◆ OnFailure()

◆ OnReceiveContentInfo()

◆ OnReceiveData()

◆ Receive_SERVER_CONTENT()

◆ Receive_SERVER_INFO()

◆ RemoveCallback()

◆ RequestContentList() [1/3]

◆ RequestContentList() [2/3]

◆ RequestContentList() [3/3]

◆ ReverseLookupDependency()

◆ ReverseLookupTreeDependency()

◆ Select()

◆ SelectAll()

◆ SelectUpgrade()

◆ SendReceive()

◆ ToggleSelectedState()

◆ Unselect()

◆ UnselectAll()

Friends And Related Symbol Documentation

◆ NetworkContentConnecter

Field Documentation

◆ callbacks

◆ curFile

◆ curInfo

◆ http_response

◆ http_response_index

◆ IDLE_TIMEOUT

◆ infos

◆ isCancelled

◆ isConnecting

◆ lastActivity

◆ requested

◆ reverse_dependency_map