nix-super/src/libstore/filetransfer.hh

151 lines
4 KiB
C++
Raw Normal View History

2015-04-09 13:12:50 +03:00
#pragma once
///@file
2015-04-09 13:12:50 +03:00
#include "types.hh"
#include "hash.hh"
2019-11-06 18:30:48 +02:00
#include "config.hh"
2015-04-09 13:12:50 +03:00
#include <string>
#include <future>
2015-04-09 13:12:50 +03:00
namespace nix {
2020-04-07 00:43:43 +03:00
struct FileTransferSettings : Config
{
Setting<bool> enableHttp2{this, true, "http2",
"Whether to enable HTTP/2 support."};
Setting<std::string> userAgentSuffix{this, "", "user-agent-suffix",
"String appended to the user agent in HTTP requests."};
Setting<size_t> httpConnections{
this, 25, "http-connections",
R"(
The maximum number of parallel TCP connections used to fetch
files from binary caches and by other downloads. It defaults
to 25. 0 means no limit.
)",
{"binary-caches-parallel-connections"}};
Setting<unsigned long> connectTimeout{
this, 0, "connect-timeout",
R"(
The timeout (in seconds) for establishing connections in the
binary cache substituter. It corresponds to `curl`s
`--connect-timeout` option. A value of 0 means no limit.
)"};
Setting<unsigned long> stalledDownloadTimeout{
this, 300, "stalled-download-timeout",
R"(
The timeout (in seconds) for receiving data from servers
during download. Nix cancels idle downloads after this
timeout's duration.
)"};
Setting<unsigned int> tries{this, 5, "download-attempts",
"How often Nix will attempt to download a file before giving up."};
};
2020-04-07 00:43:43 +03:00
extern FileTransferSettings fileTransferSettings;
2020-04-07 00:43:43 +03:00
struct FileTransferRequest
{
std::string uri;
Headers headers;
std::string expectedETag;
bool verifyTLS = true;
bool head = false;
2020-04-07 00:43:43 +03:00
size_t tries = fileTransferSettings.tries;
unsigned int baseRetryTimeMs = 250;
ActivityId parentAct;
bool decompress = true;
std::optional<std::string> data;
std::string mimeType;
2020-12-02 15:00:43 +02:00
std::function<void(std::string_view data)> dataCallback;
FileTransferRequest(std::string_view uri)
: uri(uri), parentAct(getCurActivity()) { }
2018-06-05 15:37:26 +03:00
std::string verb()
{
return data ? "upload" : "download";
}
};
2020-04-07 00:43:43 +03:00
struct FileTransferResult
2015-04-09 13:12:50 +03:00
{
bool cached = false;
std::string etag;
std::string effectiveUri;
std::string data;
uint64_t bodySize = 0;
/* An "immutable" URL for this resource (i.e. one whose contents
will never change), as returned by the `Link: <url>;
rel="immutable"` header. */
std::optional<std::string> immutableUrl;
2015-04-09 13:12:50 +03:00
};
class Store;
2020-04-07 00:43:43 +03:00
struct FileTransfer
{
2020-04-07 00:43:43 +03:00
virtual ~FileTransfer() { }
/**
* Enqueue a data transfer request, returning a future to the result of
* the download. The future may throw a FileTransferError
* exception.
*/
2020-04-07 00:43:43 +03:00
virtual void enqueueFileTransfer(const FileTransferRequest & request,
Callback<FileTransferResult> callback) = 0;
2020-04-07 00:43:43 +03:00
std::future<FileTransferResult> enqueueFileTransfer(const FileTransferRequest & request);
/**
* Synchronously download a file.
*/
2020-04-07 00:43:43 +03:00
FileTransferResult download(const FileTransferRequest & request);
/**
* Synchronously upload a file.
*/
2020-04-07 00:43:43 +03:00
FileTransferResult upload(const FileTransferRequest & request);
/**
* Download a file, writing its data to a sink. The sink will be
* invoked on the thread of the caller.
*/
2020-04-07 00:43:43 +03:00
void download(FileTransferRequest && request, Sink & sink);
2016-08-11 18:34:43 +03:00
enum Error { NotFound, Forbidden, Misc, Transient, Interrupted };
};
2015-04-09 13:12:50 +03:00
/**
* @return a shared FileTransfer object.
*
* Using this object is preferred because it enables connection reuse
* and HTTP/2 multiplexing.
*/
2020-04-07 00:43:43 +03:00
ref<FileTransfer> getFileTransfer();
/**
* @return a new FileTransfer object
*
* Prefer getFileTransfer() to this; see its docs for why.
*/
2020-04-07 00:43:43 +03:00
ref<FileTransfer> makeFileTransfer();
2020-04-07 00:43:43 +03:00
class FileTransferError : public Error
{
public:
2020-04-07 00:43:43 +03:00
FileTransfer::Error error;
/// intentionally optional
std::optional<std::string> response;
2020-05-12 00:52:15 +03:00
template<typename... Args>
FileTransferError(FileTransfer::Error error, std::optional<std::string> response, const Args & ... args);
};
2015-04-09 13:12:50 +03:00
}