provideitem.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#ifndef ZYPP_MEDIA_PROVIDEITEM_H_INCLUDED
#define ZYPP_MEDIA_PROVIDEITEM_H_INCLUDED
 
#include <zypp-core/zyppng/base/zyppglobal.h>
#include <zypp-core/zyppng/base/Base>
#include <zypp-media/ng/ProvideFwd>
#include <zypp-core/ByteCount.h>
 
namespace zyppng
{
  class ProvidePrivate;
  class ProvideItemPrivate;

  class ProvideItem : public Base
  {
    ZYPP_DECLARE_PRIVATE(ProvideItem)
    friend class Provide;
    friend class ProvidePrivate;
    friend class ProvideQueue;
  public:
    enum State {
      Uninitialized, //< Item was added to the queue but not yet initialized
      Pending,      //< The Item is waiting to be queued and does nothing
      Downloading,  //< The Item is fetching data
      Processing,   //< The Item has fetched all data but is still doing other things
      Cancelling,   //< The Item was cancelled and waits
      Finalizing,   //< The Item has finished all work and is currently cleaning up
      Finished      //< The Item is done and can be dequeued
    };
 
    struct ItemStats {
      std::chrono::steady_clock::time_point _pulseTime;
      uint _runningRequests;
      zypp::ByteCount _bytesProvided;
      zypp::ByteCount _bytesExpected;
    };
 
    ProvideItem( ProvidePrivate &parent );
    ~ProvideItem ();

    virtual void initialize ()  = 0;

    virtual void released ();
 
    State state () const;

    SignalProxy<void( ProvideItem &item, State oldState, State newState )> sigStateChanged();
 
    ProvidePrivate &provider();

    virtual bool canRedirectTo ( ProvideRequestRef startedReq, const zypp::Url &url );

    const std::optional<ItemStats> &currentStats() const;

    const std::optional<ItemStats> &previousStats() const;

    virtual std::chrono::steady_clock::time_point startTime() const;

    virtual std::chrono::steady_clock::time_point finishedTime() const;

    void pulse ();

    virtual zypp::ByteCount bytesExpected () const;
 
  protected:
    virtual ItemStats makeStats ();

    virtual void informalMessage ( ProvideQueue &, ProvideRequestRef req, const ProvideMessage &msg  );

    virtual void cacheMiss ( ProvideRequestRef req );

    virtual void finishReq ( ProvideQueue &queue, ProvideRequestRef finishedReq, const ProvideMessage &msg );

    virtual void finishReq ( ProvideQueue *queue, ProvideRequestRef finishedReq, const std::exception_ptr excpt );

    virtual expected<zypp::media::AuthData> authenticationRequired ( ProvideQueue &queue, ProvideRequestRef req, const zypp::Url &effectiveUrl, int64_t lastTimestamp, const std::map<std::string, std::string> &extraFields );

    bool safeRedirectTo ( ProvideRequestRef startedReq, const zypp::Url &url );

    void redirectTo ( ProvideRequestRef startedReq, const zypp::Url &url );

    virtual bool enqueueRequest( ProvideRequestRef request );

    virtual void cancelWithError ( std::exception_ptr error ) = 0;

    bool dequeue ();

    void updateState( const State newState );
 
    void setFinished ();
 
  protected:
    ProvideRequestRef _runningReq;
  };
}
#endif // ZYPP_MEDIA_PROVIDEITEM_H_INCLUDED