downloadspec.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
----------------------------------------------------------------------/
*
* This file contains private API, this might break at any time between releases.
* You have been warned!
*
*/
#ifndef ZYPPNG_MEDIA_NETWORK_DOWNLOADSPEC_H
#define ZYPPNG_MEDIA_NETWORK_DOWNLOADSPEC_H
 
#include <zypp-core/zyppng/base/zyppglobal.h>
#include <zypp-core/zyppng/core/Url>
#include <zypp-core/Pathname.h>
#include <zypp-core/base/PtrTypes.h>
#include <zypp-core/ByteCount.h>
#include <zypp-core/CheckSum.h>
#include <zypp-curl/TransferSettings>
 
#include <optional>
 
namespace zyppng {
 
 
  class DownloadSpecPrivate;
  using TransferSettings = zypp::media::TransferSettings;
 
  class DownloadSpec
  {
    ZYPP_DECLARE_PRIVATE( DownloadSpec )
 
  public:
 
    DownloadSpec( Url file, zypp::filesystem::Pathname targetPath, zypp::ByteCount expectedFileSize = zypp::ByteCount() );
 
    DownloadSpec( const DownloadSpec &other );
    DownloadSpec &operator= ( const DownloadSpec &other );
 
    const Url &url () const;
    DownloadSpec &setUrl ( const Url &url );
 
    const zypp::Pathname &targetPath() const;
    DownloadSpec &setTargetPath ( const zypp::Pathname &path );
 
    DownloadSpec &setMetalinkEnabled ( bool enable = true );
    bool metalinkEnabled (  ) const;
 
    DownloadSpec &setCheckExistsOnly ( bool set = true );
    bool checkExistsOnly    ( ) const;
 
    DownloadSpec &setDeltaFile ( const zypp::Pathname &file );
    zypp::filesystem::Pathname deltaFile() const;
 
    DownloadSpec &setPreferredChunkSize ( const zypp::ByteCount &bc );
    zypp::ByteCount preferredChunkSize() const;
 
    const TransferSettings &settings () const;
    DownloadSpec &setTransferSettings( TransferSettings &&set );
    DownloadSpec &setTransferSettings( const TransferSettings &set );
 
    DownloadSpec &setExpectedFileSize ( const zypp::ByteCount &bc );
    zypp::ByteCount expectedFileSize() const;
 
    DownloadSpec &setHeaderSize ( const zypp::ByteCount &bc );
    zypp::ByteCount headerSize() const;
 
    const std::optional<zypp::CheckSum> &headerChecksum () const;
    DownloadSpec &setHeaderChecksum ( const zypp::CheckSum &sum );
 
  private:
    zypp::RWCOW_pointer<DownloadSpecPrivate> d_ptr;
  };
 
}
 
#endif // ZYPPNG_MEDIA_NETWORK_DOWNLOADSPEC_H