src/main/hashchecker.h

   1 /***************************************************************************
   2  *                                                                         *
   3  *   Copyright (C) 2006 David Brodsky                                      *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or         *
   6  *   modify it under the terms of the GNU General Public License as        *
   7  *   published by the Free Software Foundation and appearing               *
   8  *   in the file LICENSE.GPL included in the packaging of this file.       *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      *
  13  *   General Public License for more details.                              *
  14  *                                                                         *
  15  ***************************************************************************/
  16
  17 #ifndef _main_hashchecker_h
  18 #define _main_hashchecker_h
  19
  20 #include <list>
  21
  22 #include <tairon/core/signals.h>
  23
  24 namespace Tairent
  25 {
  26
  27 namespace Main
  28 {
  29
  30 struct PieceStruct;
  31
  32 class Storage;
  33
  34 /** \brief HashChecker is used to check a piece against its hash.
  35  */
  36 class HashChecker
  37 {
  38         public:
  39                 /** Constructs a HashChecker object.
  40                  *
  41                  * \param i Number of the piece to check.
  42                  * \param s Storage with the piece.
  43                  */
  44                 HashChecker(uint32_t i, Storage *s);
  45
  46                 /** Destroys the object.
  47                  */
  48                 ~HashChecker();
  49
  50                 /** Checks the piece's hash. This job is done in a different thread, so
  51                  * it shouldn't slow down main processing. When the job is done a
  52                  * specific signal is emitted. This method just creates a functor to
  53                  * call checkPiece() in a different thread.
  54                  *
  55                  * \sa hashCorrectSignal
  56                  * \sa hashIncorrectSignal
  57                  */
  58                 void check();
  59
  60                 /** Returns index of the piece that is checked by this object.
  61                  */
  62                 uint32_t getIndex() {
  63                         return index;
  64                 };
  65
  66         public:
  67                 /** This signal is emitted when the piece has the correct hash.
  68                  */
  69                 Tairon::Core::DSignal2<uint32_t, HashChecker *> hashCorrectSignal;
  70
  71                 /** This signal is emitted when the piece has an incorrect hash.
  72                  */
  73                 Tairon::Core::DSignal2<uint32_t, HashChecker *> hashIncorrectSignal;
  74
  75         private:
  76                 /** Checks the piece.
  77                  */
  78                 void checkPiece();
  79
  80         private:
  81                 /** Disabler for functor that calls checkPiece() method.
  82                  */
  83                 Tairon::Core::FunctorDisabler *disabler;
  84
  85                 /** Index of the piece.
  86                  */
  87                 uint32_t index;
  88
  89                 /** Informations about the piece.
  90                  */
  91                 PieceStruct *piece;
  92
  93                 /** Hash of the piece from the torrent's metainfo.
  94                  */
  95                 String pieceHash;
  96 };
  97
  98 }; // namespace Main
  99
 100 }; // namespace Tairent
 101
 102 #endif
 103
 104 // vim: ai sw=4 ts=4 noet fdm=marker