Downloader.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2025 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */
 
#ifndef SQUID_SRC_DOWNLOADER_H
#define SQUID_SRC_DOWNLOADER_H
 
#include "base/AsyncCallbacks.h"
#include "base/AsyncJob.h"
#include "defines.h"
#include "http/forward.h"
#include "http/StatusCode.h"
#include "sbuf/SBuf.h"
 
class ClientHttpRequest;
class StoreIOBuffer;
class clientStreamNode;
class DownloaderContext;
typedef RefCount<DownloaderContext> DownloaderContextPointer;
class MasterXaction;
using MasterXactionPointer = RefCount<MasterXaction>;
 
class DownloaderAnswer {
public:
    // The content of a successfully received HTTP 200 OK reply to our GET request.
    // Unused unless outcome is Http::scOkay.
    SBuf resource;
 
    Http::StatusCode outcome = Http::scNone;
};
 
std::ostream &operator <<(std::ostream &, const DownloaderAnswer &);
 
class Downloader: virtual public AsyncJob
{
    CBDATA_CHILD(Downloader);
public:
    using Answer = DownloaderAnswer;
 
    Downloader(const SBuf &url, const AsyncCallback<Answer> &, const MasterXactionPointer &, unsigned int level = 0);
    ~Downloader() override;
    void swanSong() override;
 
    void downloadFinished();
 
    unsigned int nestedLevel() const {return level_;}
 
    void handleReply(clientStreamNode *, ClientHttpRequest *, HttpReply *, StoreIOBuffer);
 
protected:
 
    /* AsyncJob API */
    bool doneAll() const override;
    void start() override;
 
private:
 
    bool buildRequest();
    void callBack(Http::StatusCode const status);
 
    static const size_t MaxObjectSize = 1*1024*1024;
 
    SBuf url_; 
 
    AsyncCallback<Answer> callback_;
 
    SBuf object_; 
    const unsigned int level_; 
    MasterXactionPointer masterXaction_; 
 
    DownloaderContextPointer context_;
};
 
#endif /* SQUID_SRC_DOWNLOADER_H */