downloader.h

Go to the documentation of this file.

#ifndef ZYPP_NG_MEDIA_CURL_DOWNLOADER_H_INCLUDED
#define ZYPP_NG_MEDIA_CURL_DOWNLOADER_H_INCLUDED
 
#include <zypp-core/zyppng/base/zyppglobal.h>
#include <zypp-core/zyppng/base/Base>
#include <zypp-core/zyppng/base/signals.h>
#include <zypp-core/zyppng/core/Url>
#include <zypp-curl/ng/network/networkrequesterror.h>
#include <zypp-curl/ng/network/AuthData>
 
#include <zypp-core/ByteCount.h>
 
namespace zypp::media {
  class TransferSettings;
}
 
namespace zyppng {
 
  class NetworkRequestDispatcher;
  class DownloaderPrivate;
  class Download;
  class DownloadSpec;
  class MirrorControl;
 
  using TransferSettings = zypp::media::TransferSettings;
 
  ZYPP_FWD_DECL_TYPE_WITH_REFS( Downloader );
  ZYPP_FWD_DECL_TYPE_WITH_REFS( Download );
 
 
  class LIBZYPP_NG_EXPORT Downloader : public Base
  {
    ZYPP_DECLARE_PRIVATE( Downloader )
  public:
 
    using Ptr = DownloaderRef;
    using WeakPtr = DownloaderWeakRef;
 
    Downloader();
    Downloader( std::shared_ptr<MirrorControl> mc );
    virtual ~Downloader();
 
    std::shared_ptr<Download> downloadFile ( const DownloadSpec &spec );
 
    std::shared_ptr<NetworkRequestDispatcher> requestDispatcher () const;
 
    SignalProxy<void ( Downloader &parent, Download& download )> sigStarted  ( );
 
    SignalProxy<void ( Downloader &parent, Download& download )> sigFinished ( );
 
    SignalProxy<void ( Downloader &parent )> queueEmpty ( );
  };
 
  class DownloadPrivate;
 
  class LIBZYPP_NG_EXPORT Download : public Base
  {
    ZYPP_DECLARE_PRIVATE( Download )
 
  public:
 
    using Ptr = DownloadRef;
    using WeakPtr = DownloadWeakRef;
 
    enum State {
      InitialState,   //< This is the initial state. It is only set before a download starts.
      DetectMetaLink, //< Metalink downloads are enabled, trying to detect if we get a metalink or not
      DlMetaLinkInfo, //< Downloading the metalink description file
      PrepareMulti,   //< This state is set for async preparations of the multi download, like mirror rating
      DlMetalink,     //< Metalink download is running
      DlZChunkHead,   //< Zchunk header download is running
      DlZChunk,       //< Zchunk download is running
      DlSimple,       //< Simple download running, no optimizations
      Finished,       //< Download has finished
    };
 
    virtual ~Download();
 
    State state () const;
 
    NetworkRequestError lastRequestError () const;
 
    bool hasError () const;
 
    std::string errorString () const;
 
    void start ();
 
    void prioritize();
 
    void cancel ();
 
    void setStopOnMetalink ( const bool set = true );
 
    bool stoppedOnMetalink () const;
 
    DownloadSpec &spec ();
    const DownloadSpec &spec () const;
 
    uint64_t lastAuthTimestamp () const;
 
    NetworkRequestDispatcher &dispatcher () const;
 
    SignalProxy<void ( Download &req )> sigStarted  ();
 
    SignalProxy<void ( Download &req, State state )> sigStateChanged  ();
 
    SignalProxy<void ( Download &req, off_t dlnow  )> sigAlive ();
 
    SignalProxy<void ( Download &req, off_t dltotal, off_t dlnow )> sigProgress ();
 
    SignalProxy<void ( Download &req )> sigFinished ( );
 
    SignalProxy<void ( Download &req, NetworkAuthData &auth, const std::string &availAuth )> sigAuthRequired ( );
 
  private:
    friend class zyppng::Downloader;
    Download ( Downloader &parent, std::shared_ptr<NetworkRequestDispatcher> requestDispatcher, std::shared_ptr<MirrorControl> mirrors, DownloadSpec &&spec );
  };
}
 
#endif