zypp/RepoStatus.h

   1 /*---------------------------------------------------------------------\
   2 |                          ____ _   __ __ ___                          |
   3 |                         |__  / \ / / . \ . \                         |
   4 |                           / / \ V /|  _/  _/                         |
   5 |                          / /__ | | | | | |                           |
   6 |                         /_____||_| |_| |_|                           |
   7 |                                                                      |
   8 \---------------------------------------------------------------------*/
   9 /** \file       zypp/RepoStatus.h
  10  *
  11 */
  12 #ifndef ZYPP2_REPOSTATUS_H
  13 #define ZYPP2_REPOSTATUS_H
  14
  15 #include <iosfwd>
  16 #include "zypp/base/PtrTypes.h"
  17 #include "zypp/CheckSum.h"
  18 #include "zypp/Date.h"
  19
  20 ///////////////////////////////////////////////////////////////////
  21 namespace zypp
  22 { /////////////////////////////////////////////////////////////////
  23
  24   ///////////////////////////////////////////////////////////////////
  25   //
  26   //    CLASS NAME : RepoStatus
  27   //
  28   /**
  29    * \short Local facts about a repository
  30    * This class represents the status of a
  31    * repository on the system.
  32    *
  33    * Anything that is not provided on the metadata
  34    * files, like the timestamp of the downloaded
  35    * metadata, and its checksum.
  36    */
  37   class RepoStatus
  38   {
  39     friend std::ostream & operator<<( std::ostream & str, const RepoStatus & obj );
  40
  41   public:
  42
  43     /**
  44      * Checksum of the repository.
  45      * Usually the checksum of the index, but any
  46      * checksum that changes when the repository changes
  47      * in any way is sufficient.
  48      */
  49     std::string checksum() const;
  50
  51     /**
  52      * timestamp of the repository. If the repository
  53      * changes, it has to be updated as well with the
  54      * new timestamp.
  55      */
  56     Date timestamp() const;
  57
  58     /**
  59      * set the repository checksum \see checksum
  60      * \param checksum
  61      */
  62     RepoStatus & setChecksum( const std::string &checksum );
  63
  64     /**
  65      * set the repository timestamp \see timestamp
  66      * \param timestamp
  67      */
  68     RepoStatus & setTimestamp( const Date &timestamp );
  69
  70     /** Implementation  */
  71     class Impl;
  72
  73   public:
  74     /** Default ctor */
  75     RepoStatus();
  76
  77     /**
  78      * \short Status from a single file
  79      * As most repository state is represented
  80      * by the status of the index file, you can
  81      * construct the status from a file.
  82      */
  83     RepoStatus( const Pathname &file );
  84
  85     /** Dtor */
  86     ~RepoStatus();
  87
  88   public:
  89
  90   private:
  91     /** Pointer to implementation */
  92     RWCOW_pointer<Impl> _pimpl;
  93   };
  94   ///////////////////////////////////////////////////////////////////
  95
  96   /** \relates RepoStatus Stream output */
  97   std::ostream & operator<<( std::ostream & str, const RepoStatus & obj );
  98
  99   /////////////////////////////////////////////////////////////////
 100 } // namespace zypp
 101 ///////////////////////////////////////////////////////////////////
 102 #endif // ZYPP2_REPOSTATUS_H