Files @ r25958:603d75b53498
Branch filter:

Location: cpp/openttd-patchpack/source/src/network/network_content.h - annotation

Patric Stout
Doc: update multiplayer documentation with latest changes (#9552)

Although several places were fixed during the PR making the change,
not all made it in this document.

While at it, removed all kinds of Markdown warnings by an excessive
usage of spacebar in this document.
r12768:980ae0491352
r12768:980ae0491352
r12768:980ae0491352
r12768:980ae0491352
r12768:980ae0491352
r12768:980ae0491352
r12768:980ae0491352
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r14427:e0f0ac35263c
r25946:208a790a4923
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r23538:8df50944b27a
r17641:a80e43fd2f5e
r23538:8df50944b27a
r10841:585c775bc8b1
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r17641:a80e43fd2f5e
r10841:585c775bc8b1
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10841:585c775bc8b1
r10841:585c775bc8b1
r10841:585c775bc8b1
r10841:585c775bc8b1
r10841:585c775bc8b1
r10841:585c775bc8b1
r10841:585c775bc8b1
r10841:585c775bc8b1
r10841:585c775bc8b1
r10841:585c775bc8b1
r10841:585c775bc8b1
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10841:585c775bc8b1
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r17444:de3de14c6d35
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r14427:e0f0ac35263c
r10793:5ba2151e71e9
r23538:8df50944b27a
r23539:bce8329ee42d
r23539:bce8329ee42d
r23539:bce8329ee42d
r25946:208a790a4923
r23539:bce8329ee42d
r23539:bce8329ee42d
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10841:585c775bc8b1
r24952:3017eb59bf1a
r10793:5ba2151e71e9
r10841:585c775bc8b1
r10793:5ba2151e71e9
r23506:bba4d0c6d70d
r23506:bba4d0c6d70d
r10793:5ba2151e71e9
r25946:208a790a4923
r10841:585c775bc8b1
r10841:585c775bc8b1
r23506:bba4d0c6d70d
r23506:bba4d0c6d70d
r23506:bba4d0c6d70d
r23506:bba4d0c6d70d
r23506:bba4d0c6d70d
r14425:bcca07eb8aff
r23506:bba4d0c6d70d
r23506:bba4d0c6d70d
r14427:e0f0ac35263c
r14425:bcca07eb8aff
r14425:bcca07eb8aff
r14427:e0f0ac35263c
r14427:e0f0ac35263c
r14427:e0f0ac35263c
r10841:585c775bc8b1
r10841:585c775bc8b1
r24952:3017eb59bf1a
r10841:585c775bc8b1
r10841:585c775bc8b1
r10793:5ba2151e71e9
r10841:585c775bc8b1
r10841:585c775bc8b1
r10841:585c775bc8b1
r25458:3aaccd46b7fa
r10841:585c775bc8b1
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r14427:e0f0ac35263c
r10841:585c775bc8b1
r10841:585c775bc8b1
r10841:585c775bc8b1
r10841:585c775bc8b1
r10843:cc632b9b7c4f
r10841:585c775bc8b1
r10841:585c775bc8b1
r10841:585c775bc8b1
r10841:585c775bc8b1
r10841:585c775bc8b1
r10841:585c775bc8b1
r10841:585c775bc8b1
r10841:585c775bc8b1
r23553:9f01781fc43d
r10841:585c775bc8b1
r23536:ce42deb0b32d
r10841:585c775bc8b1
r23530:3c94d05f840c
r10841:585c775bc8b1
r23536:ce42deb0b32d
r17138:5078c9240593
r10886:02a2d01be830
r10841:585c775bc8b1
r10841:585c775bc8b1
r23535:9604c18808f0
r10841:585c775bc8b1
r23523:6c7a73ae36c5
r10793:5ba2151e71e9
r10793:5ba2151e71e9
r10841:585c775bc8b1
r10793:5ba2151e71e9
r23607:36c15679007d
r10793:5ba2151e71e9
r18608:c74fda8acdb0
r18608:c74fda8acdb0
r10793:5ba2151e71e9
/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */

/** @file network_content.h Part of the network protocol handling content distribution. */

#ifndef NETWORK_CONTENT_H
#define NETWORK_CONTENT_H

#include "core/tcp_content.h"
#include "core/tcp_http.h"
#include <unordered_map>

/** Vector with content info */
typedef std::vector<ContentInfo *> ContentVector;
/** Vector with constant content info */
typedef std::vector<const ContentInfo *> ConstContentVector;

/** Iterator for the content vector */
typedef ContentInfo **ContentIterator;
/** Iterator for the constant content vector */
typedef const ContentInfo * const * ConstContentIterator;

/** Callbacks for notifying others about incoming data */
struct ContentCallback {
	/**
	 * Callback for when the connection has finished
	 * @param success whether the connection was made or that we failed to make it
	 */
	virtual void OnConnect(bool success) {}

	/**
	 * Callback for when the connection got disconnected.
	 */
	virtual void OnDisconnect() {}

	/**
	 * We received a content info.
	 * @param ci the content info
	 */
	virtual void OnReceiveContentInfo(const ContentInfo *ci) {}

	/**
	 * We have progress in the download of a file
	 * @param ci the content info of the file
	 * @param bytes the number of bytes downloaded since the previous call
	 */
	virtual void OnDownloadProgress(const ContentInfo *ci, int bytes) {}

	/**
	 * We have finished downloading a file
	 * @param cid the ContentID of the downloaded file
	 */
	virtual void OnDownloadComplete(ContentID cid) {}

	/** Silentium */
	virtual ~ContentCallback() {}
};

/**
 * Socket handler for the content server connection
 */
class ClientNetworkContentSocketHandler : public NetworkContentSocketHandler, ContentCallback, HTTPCallback {
protected:
	typedef std::vector<ContentID> ContentIDList; ///< List of content IDs to (possibly) select.
	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

	FILE *curFile;        ///< Currently downloaded file
	ContentInfo *curInfo; ///< Information about the currently downloaded file
	bool isConnecting;    ///< Whether we're connecting
	std::chrono::steady_clock::time_point lastActivity;  ///< The last time there was network activity

	friend class NetworkContentConnecter;

	bool Receive_SERVER_INFO(Packet *p) override;
	bool Receive_SERVER_CONTENT(Packet *p) override;

	ContentInfo *GetContent(ContentID cid) const;
	void DownloadContentInfo(ContentID cid);

	void OnConnect(bool success) override;
	void OnDisconnect() override;
	void OnReceiveContentInfo(const ContentInfo *ci) override;
	void OnDownloadProgress(const ContentInfo *ci, int bytes) override;
	void OnDownloadComplete(ContentID cid) override;

	void OnFailure() override;
	void OnReceiveData(const char *data, size_t length) override;

	bool BeforeDownload();
	void AfterDownload();

	void DownloadSelectedContentHTTP(const ContentIDList &content);
	void DownloadSelectedContentFallback(const ContentIDList &content);
public:
	/** The idle timeout; when to close the connection because it's idle. */
	static constexpr std::chrono::seconds IDLE_TIMEOUT = std::chrono::seconds(60);

	ClientNetworkContentSocketHandler();
	~ClientNetworkContentSocketHandler();

	void Connect();
	void SendReceive();
	NetworkRecvStatus CloseConnection(bool error = true) override;

	void RequestContentList(ContentType type);
	void RequestContentList(uint count, const ContentID *content_ids);
	void RequestContentList(ContentVector *cv, bool send_md5sum = true);

	void DownloadSelectedContent(uint &files, uint &bytes, bool fallback = false);

	void Select(ContentID cid);
	void Unselect(ContentID cid);
	void SelectAll();
	void SelectUpgrade();
	void UnselectAll();
	void ToggleSelectedState(const ContentInfo *ci);

	void ReverseLookupDependency(ConstContentVector &parents, const ContentInfo *child) const;
	void ReverseLookupTreeDependency(ConstContentVector &tree, const ContentInfo *child) const;
	void CheckDependencyState(ContentInfo *ci);

	/** Get the number of content items we know locally. */
	uint Length() const { return (uint)this->infos.size(); }
	/** Get the begin of the content inf iterator. */
	ConstContentIterator Begin() const { return this->infos.data(); }
	/** Get the nth position of the content inf iterator. */
	ConstContentIterator Get(uint32 index) const { return this->infos.data() + index; }
	/** Get the end of the content inf iterator. */
	ConstContentIterator End() const { return this->Begin() + this->Length(); }

	void Clear();

	/** Add a callback to this class */
	void AddCallback(ContentCallback *cb) { include(this->callbacks, cb); }
	/** Remove a callback */
	void RemoveCallback(ContentCallback *cb) { this->callbacks.erase(std::find(this->callbacks.begin(), this->callbacks.end(), cb)); }
};

extern ClientNetworkContentSocketHandler _network_content_client;

void ShowNetworkContentListWindow(ContentVector *cv = nullptr, ContentType type1 = CONTENT_TYPE_END, ContentType type2 = CONTENT_TYPE_END);

void ShowMissingContentWindow(const struct GRFConfig *list);

#endif /* NETWORK_CONTENT_H */