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/zyppng/base/zyppglobal.h>
#include <zypp/zyppng/base/Base>
#include <zypp/zyppng/base/signals.h>
#include <zypp/zyppng/core/Url>
#include <zypp/zyppng/media/network/networkrequesterror.h>
#include <zypp/zyppng/media/network/AuthData>

#include <zypp/ByteCount.h>

namespace zypp {
  namespace media {
    class TransferSettings;
  }
}

namespace zyppng {

  class NetworkRequestDispatcher;
  class DownloaderPrivate;
  class Download;

  using TransferSettings = zypp::media::TransferSettings;

  class LIBZYPP_NG_EXPORT Downloader : public Base
  {
    ZYPP_DECLARE_PRIVATE( Downloader )
  public:

    using Ptr = std::shared_ptr<Downloader>;
    using WeakPtr = std::shared_ptr<Downloader>;

    Downloader( );

    std::shared_ptr<Download> downloadFile ( Url file, zypp::filesystem::Pathname targetPath, zypp::ByteCount expectedFileSize = zypp::ByteCount() );

    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 = std::shared_ptr<Download>;
    using WeakPtr = std::shared_ptr<Download>;

    enum State {
      InitialState,  //< This is the initial state, its only set before a download starts
      Initializing = 10,  //< This state is kept during the first 265Bytes or until the data looks like a Metalink download
      Running      = 20,  //< This state is set once there have been more than 256 bytes downloaded and it does not look like a metalink download
      RunningMulti = 30,  //< Signals that the file is downloaded in chunks from different mirrors
      Success = 200, //< Shows that the Download was successful
      Failed         //< Shows that the Download failed
    };


    Download ( DownloadPrivate &&prv );

    Url url () const;

    zypp::Pathname targetPath () const;

    State state () const;

    NetworkRequestError lastRequestError () const;

    std::string errorString () const;

    TransferSettings &settings ();

    void start ();

    void setMultiPartHandlingEnabled ( bool enable = true );

    void setCheckExistsOnly ( bool set = true );

    void setDeltaFile ( const zypp::Pathname &file );

    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 ( );
  };
}

#endif