1 /* <!-- copyright */
2 /*
3  * aria2 - The high speed download utility
4  *
5  * Copyright (C) 2006 Tatsuhiro Tsujikawa
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  *
21  * In addition, as a special exception, the copyright holders give
22  * permission to link the code of portions of this program with the
23  * OpenSSL library under certain conditions as described in each
24  * individual source file, and distribute linked combinations
25  * including the two.
26  * You must obey the GNU General Public License in all respects
27  * for all of the code used other than OpenSSL.  If you modify
28  * file(s) with this exception, you may extend this exception to your
29  * version of the file(s), but you are not obligated to do so.  If you
30  * do not wish to do so, delete this exception statement from your
31  * version.  If you delete this exception statement from all source
32  * files in the program, then also delete it here.
33  */
34 /* copyright --> */
35 #ifndef D_SEGMENT_H
36 #define D_SEGMENT_H
37 
38 #include "common.h"
39 
40 #include <stdint.h>
41 #include <string>
42 #include <memory>
43 
44 namespace aria2 {
45 
46 class Piece;
47 class WrDiskCache;
48 
49 class Segment {
50 public:
51   virtual ~Segment() = default;
52 
53   virtual bool complete() const = 0;
54 
55   virtual size_t getIndex() const = 0;
56 
57   virtual int64_t getPosition() const = 0;
58 
59   virtual int64_t getPositionToWrite() const = 0;
60 
61   virtual int64_t getLength() const = 0;
62 
63   virtual int64_t getSegmentLength() const = 0;
64 
65   virtual int64_t getWrittenLength() const = 0;
66 
67   virtual void updateWrittenLength(int64_t bytes) = 0;
68 
69   // `begin' is a offset inside this segment.
70   virtual bool updateHash(int64_t begin, const unsigned char* data,
71                           size_t dataLength) = 0;
72 
73   virtual bool isHashCalculated() const = 0;
74 
75   virtual std::string getDigest() = 0;
76 
77   virtual void clear(WrDiskCache* diskCache) = 0;
78 
79   virtual std::shared_ptr<Piece> getPiece() const = 0;
80 
81   bool operator==(const Segment& segment) const
82   {
83     return getIndex() == segment.getIndex();
84   }
85 };
86 
87 } // namespace aria2
88 
89 #endif // D_SEGMENT_H
90