request.h

Go to the documentation of this file.

#ifndef ZYPP_NG_MEDIA_CURL_REQUEST_H_INCLUDED
#define ZYPP_NG_MEDIA_CURL_REQUEST_H_INCLUDED

#include <zypp/zyppng/media/network/networkrequesterror.h>
#include <zypp/zyppng/media/network/TransferSettings>
#include <zypp/zyppng/base/Base>
#include <zypp/zyppng/core/Url>
#include <zypp/zyppng/base/zyppglobal.h>
#include <zypp/zyppng/base/signals.h>
#include <zypp/base/Flags.h>
#include <vector>

namespace zypp {
  class Digest;

  namespace media {
    class AuthData;
  }
}

namespace zyppng {

  using AuthData = zypp::media::AuthData;

  class NetworkRequestDispatcher;
  class NetworkRequestPrivate;

  class LIBZYPP_NG_EXPORT NetworkRequest : public Base
  {
  public:

    using Ptr = std::shared_ptr<NetworkRequest>;
    using WeakPtr = std::weak_ptr<NetworkRequest>;

    enum State {
      Pending,    //< waiting to be dispatched
      Running,    //< currently running
      Finished,   //< finished successfully
      Error,      //< Error, use error function to figure out the issue
    };

    enum Priority {
      Normal, //< Requests with normal priority will be enqueued at the end
      High    //< Request with high priority will be moved to the front of the queue
    };

    enum FileMode {
      WriteExclusive, //< the request will create its own file, overwriting anything that already exists
      WriteShared     //< the request will create or open the file in shared mode and only write between \a start and \a len
    };

    enum OptionBits {
      HeadRequest = 0x01 //< only request the header part of the file
    };
    ZYPP_DECLARE_FLAGS(Options, OptionBits);

    NetworkRequest( Url url, zypp::Pathname targetFile, off_t start = -1, off_t len = 0, FileMode fMode = WriteExclusive );
    virtual ~NetworkRequest();

    void setPriority ( Priority prio );

    Priority priority ( ) const;

    void setOptions ( Options opt );

    Options options () const;

    void setRequestRange ( off_t start = -1, off_t len = 0 );

    const std::string &lastRedirectInfo() const;

    void *nativeHandle () const;

    std::vector<char> peekData ( off_t offset, size_t count ) const;

    Url url () const;

    void setUrl ( const Url & url );

    const zypp::Pathname & targetFilePath () const;

    std::string contentType () const;

    off_t downloadOffset () const;

    off_t reportedByteCount   () const;

    off_t expectedByteCount   () const;

    off_t downloadedByteCount () const;

    void setDigest ( std::shared_ptr<zypp::Digest> dig );

    std::shared_ptr<zypp::Digest> digest () const;

    void setExpectedChecksum (std::vector<unsigned char> checksum );


    TransferSettings &transferSettings ();

    State state () const;

    const NetworkRequestError &error () const;

    std::string extendedErrorString() const;

    bool hasError () const;

    bool addRequestHeader(const std::string &header );

    SignalProxy<void ( NetworkRequest &req )> sigStarted  ();

    SignalProxy<void ( NetworkRequest &req, off_t dltotal, off_t dlnow, off_t ultotal, off_t ulnow )> sigProgress ();

    SignalProxy<void ( NetworkRequest &req, const NetworkRequestError &err)> sigFinished ( );

  private:
    friend class NetworkRequestDispatcher;
    friend class NetworkRequestDispatcherPrivate;
    ZYPP_DECLARE_PRIVATE( NetworkRequest )
  };

}
ZYPP_DECLARE_OPERATORS_FOR_FLAGS(zyppng::NetworkRequest::Options);

#endif