Downloader.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2022 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_DOWNLOADER_H
#define SQUID_DOWNLOADER_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 Downloader: virtual public AsyncJob
{
    CBDATA_CLASS(Downloader);
public:
 
    class CbDialer: public CallDialer {
    public:
        CbDialer(): status(Http::scNone) {}
        virtual ~CbDialer() {}
 
        /* CallDialer API */
        virtual bool canDial(AsyncCall &call) = 0;
        virtual void dial(AsyncCall &call) = 0;
        virtual void print(std::ostream &os) const;
 
        SBuf object;
        Http::StatusCode status;
    };
 
    Downloader(const SBuf &url, const AsyncCall::Pointer &aCallback, const MasterXactionPointer &, unsigned int level = 0);
    virtual ~Downloader();
    virtual void swanSong();
 
    void downloadFinished();
 
    unsigned int nestedLevel() const {return level_;}
 
    void handleReply(clientStreamNode *, ClientHttpRequest *, HttpReply *, StoreIOBuffer);
 
protected:
 
    /* AsyncJob API */
    virtual bool doneAll() const;
    virtual void start();
 
private:
 
    bool buildRequest();
    void callBack(Http::StatusCode const status);
 
    static const size_t MaxObjectSize = 1*1024*1024;
 
    SBuf url_; 
    AsyncCall::Pointer callback_; 
    SBuf object_; 
    const unsigned int level_; 
    MasterXactionPointer masterXaction_; 
 
    DownloaderContextPointer context_;
};
 
#endif